Coverage for src/robot_dispatch/logging_setup.py: 100%
58 statements
« prev ^ index » next coverage.py v7.17.2, created at 2026-11-07 17:18 +0000
« prev ^ index » next coverage.py v7.17.2, created at 2026-11-07 17:18 +0000
1from __future__ import annotations
3import json
4import logging
5import sys
6from datetime import UTC, datetime
7from typing import Any, cast
10class StructuredLogger(logging.Logger):
11 """Logger that accepts arbitrary keyword fields.
13 `logger.info("task dispatched", task_id=...)` is valid here: the fields end up
14 in `record.fields` and are rendered by the formatters below. Standard
15 `logging` rejects unknown keyword arguments, hence the typed wrappers.
16 """
18 def _emit(
19 self,
20 level: int,
21 msg: object,
22 args: tuple[Any, ...],
23 fields: dict[str, Any],
24 *,
25 exc_info: Any = None,
26 ) -> None:
27 extra = {"fields": fields} if fields else None
28 self._log(level, msg, args, exc_info=exc_info, extra=extra)
30 def debug(self, msg: object, *args: Any, **fields: Any) -> None: # type: ignore[override]
31 self._emit(logging.DEBUG, msg, args, fields)
33 def info(self, msg: object, *args: Any, exc_info: Any = None, **fields: Any) -> None: # type: ignore[override]
34 self._emit(logging.INFO, msg, args, fields, exc_info=exc_info)
36 def warning(self, msg: object, *args: Any, exc_info: Any = None, **fields: Any) -> None: # type: ignore[override]
37 self._emit(logging.WARNING, msg, args, fields, exc_info=exc_info)
39 def error(self, msg: object, *args: Any, exc_info: Any = None, **fields: Any) -> None: # type: ignore[override]
40 self._emit(logging.ERROR, msg, args, fields, exc_info=exc_info)
42 def critical(self, msg: object, *args: Any, exc_info: Any = None, **fields: Any) -> None: # type: ignore[override]
43 self._emit(logging.CRITICAL, msg, args, fields, exc_info=exc_info)
45 def exception(self, msg: object, *args: Any, exc_info: Any = True, **fields: Any) -> None: # type: ignore[override]
46 self._emit(logging.ERROR, msg, args, fields, exc_info=exc_info)
49logging.setLoggerClass(StructuredLogger)
51_BASE_RECORD_KEYS = set(logging.LogRecord("", 0, "", 0, "", (), None).__dict__) | {
52 "asctime",
53 "message",
54 "taskName",
55 "fields",
56}
59def _fields(record: logging.LogRecord) -> dict[str, Any]:
60 fields: dict[str, Any] = dict(getattr(record, "fields", {}) or {})
61 for key, value in record.__dict__.items():
62 if key not in _BASE_RECORD_KEYS and not key.startswith("_"):
63 fields[key] = value
64 return fields
67class JsonFormatter(logging.Formatter):
68 def format(self, record: logging.LogRecord) -> str:
69 payload: dict[str, Any] = {
70 "ts": datetime.fromtimestamp(record.created, tz=UTC).isoformat(),
71 "level": record.levelname,
72 "logger": record.name,
73 "msg": record.getMessage(),
74 }
75 payload.update(_fields(record))
76 if record.exc_info:
77 payload["exc"] = self.formatException(record.exc_info)
78 return json.dumps(payload, ensure_ascii=False, default=str)
81class TextFormatter(logging.Formatter):
82 def format(self, record: logging.LogRecord) -> str:
83 fields = _fields(record)
84 timestamp = self.formatTime(record, "%H:%M:%S")
85 base = f"{timestamp} {record.levelname:<7} {record.name}: {record.getMessage()}"
86 if fields:
87 base += " " + " ".join(f"{key}={value}" for key, value in fields.items())
88 if record.exc_info:
89 base += "\n" + self.formatException(record.exc_info)
90 return base
93def configure_logging(level: str = "INFO", json_output: bool = True) -> None:
94 handler = logging.StreamHandler(sys.stdout)
95 handler.setFormatter(JsonFormatter() if json_output else TextFormatter())
97 root = logging.getLogger()
98 root.handlers.clear()
99 root.addHandler(handler)
100 root.setLevel(level.upper())
102 for noisy in ("aiormq", "aio_pika", "asyncio", "uvicorn.access"):
103 logging.getLogger(noisy).setLevel(max(logging.WARNING, root.level))
106def get_logger(name: str) -> StructuredLogger:
107 return cast(StructuredLogger, logging.getLogger(f"robot_dispatch.{name}"))