Skip to content

base

log_panel.backends.base

LogsBackend

Bases: ABC

get_logger_cards(now_utc, range_config, app_timezone) abstractmethod

Return per-logger aggregation rows for the cards view.

Each row must contain: { 'logger_name': str, 'total': int, 'total_errors': int, 'total_warnings': int, 'recent_errors': int, # last hour 'recent_warnings': int, # last hour 'last_seen': datetime, 'timeline': [{'label': str, 'status': 'ok'|'warning'|'error'|'empty', 'timestamp_from': str, 'timestamp_to': str}, ...], }

Source code in log_panel/backends/base.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
@abstractmethod
def get_logger_cards(
    self, now_utc: datetime, range_config: RangeConfig, app_timezone: tzinfo
) -> list[dict]:
    """
    Return per-logger aggregation rows for the cards view.

    Each row must contain:
    {
        'logger_name': str,
        'total': int,
        'total_errors': int,
        'total_warnings': int,
        'recent_errors': int,    # last hour
        'recent_warnings': int,  # last hour
        'last_seen': datetime,
        'timeline': [{'label': str, 'status': 'ok'|'warning'|'error'|'empty',
                      'timestamp_from': str, 'timestamp_to': str}, ...],
    }
    """

query_logs(logger_names, levels, search, offset, limit, app_timezone, timestamp_from=None, timestamp_to=None) abstractmethod

Return log entries with flexible multi-value filters.

Intended for use with :class:log_panel.managers.LogReader in non-admin views. Unlike get_log_table, this method accepts lists for both logger names and levels so that role-based visibility filters can restrict results across multiple loggers or a minimum severity.

Each entry must contain at least: { 'timestamp': datetime (tz-aware, app timezone), 'level': str, 'logger_name': str, 'module': str, 'message': str }

Source code in log_panel/backends/base.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@abstractmethod
def query_logs(
    self,
    logger_names: list[str] | None,
    levels: list[str] | None,
    search: str,
    offset: int,
    limit: int | None,
    app_timezone: tzinfo,
    timestamp_from: datetime | None = None,
    timestamp_to: datetime | None = None,
) -> list[dict]:
    """
    Return log entries with flexible multi-value filters.

    Intended for use with :class:`log_panel.managers.LogReader` in
    non-admin views.  Unlike ``get_log_table``, this method accepts lists
    for both logger names and levels so that role-based visibility filters
    can restrict results across multiple loggers or a minimum severity.

    Each entry must contain at least:
    { 'timestamp': datetime (tz-aware, app timezone), 'level': str,
      'logger_name': str, 'module': str, 'message': str }
    """

count_logs(logger_names, levels, search, timestamp_from=None, timestamp_to=None) abstractmethod

Return the total number of log entries matching the given filters.

Source code in log_panel/backends/base.py 
54
55
56
57
58
59
60
61
62
63
@abstractmethod
def count_logs(
    self,
    logger_names: list[str] | None,
    levels: list[str] | None,
    search: str,
    timestamp_from: datetime | None = None,
    timestamp_to: datetime | None = None,
) -> int:
    """Return the total number of log entries matching the given filters."""

get_modules(logger_name) abstractmethod

Return a sorted list of distinct module names for the given logger.

Source code in log_panel/backends/base.py 
65
66
67
@abstractmethod
def get_modules(self, logger_name: str) -> list[str]:
    """Return a sorted list of distinct module names for the given logger."""

get_log_table(logger_name, level, search, page, page_size, app_timezone, timestamp_from=None, timestamp_to=None, module='') abstractmethod

Return (log_entries, total_count) for the table view.

Each entry must contain at least: { 'timestamp': datetime (tz-aware, app timezone), 'level': str, 'module': str, 'message': str }

Source code in log_panel/backends/base.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
@abstractmethod
def get_log_table(
    self,
    logger_name: str,
    level: "LogLevel | str",
    search: str,
    page: int,
    page_size: int,
    app_timezone: tzinfo,
    timestamp_from: datetime | None = None,
    timestamp_to: datetime | None = None,
    module: str = "",
) -> tuple[list[dict], int]:
    """
    Return (log_entries, total_count) for the table view.

    Each entry must contain at least:
    { 'timestamp': datetime (tz-aware, app timezone), 'level': str,
      'module': str, 'message': str }
    """

get_local_now_and_slot_delta(now_utc, app_timezone, configured_unit) staticmethod

Return the current local slot boundary and its delta.

Source code in log_panel/backends/base.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
@staticmethod
def get_local_now_and_slot_delta(
    now_utc: datetime,
    app_timezone: tzinfo,
    configured_unit: RangeUnit,
) -> tuple[datetime, timedelta]:
    """Return the current local slot boundary and its delta."""
    now_local: datetime = now_utc.astimezone(app_timezone)

    if configured_unit is RangeUnit.HOUR:
        now_bucket_local: datetime = now_local.replace(
            minute=0, second=0, microsecond=0
        )
        slot_delta: timedelta = timedelta(hours=1)
    elif configured_unit is RangeUnit.DAY:
        now_bucket_local: datetime = now_local.replace(
            hour=0, minute=0, second=0, microsecond=0
        )
        slot_delta: timedelta = timedelta(days=1)
    else:  # pragma: no cover
        raise ValueError(f"Unsupported range unit: {configured_unit!r}")

    return now_bucket_local, slot_delta