|
| 1 | +""" |
| 2 | +Centralized logging configuration for QyverixAI backend. |
| 3 | +
|
| 4 | +Supports a global default log level plus per-component overrides, all |
| 5 | +configurable via environment variables — no code changes required to |
| 6 | +change verbosity in production or while debugging a specific module. |
| 7 | +
|
| 8 | +Usage |
| 9 | +----- |
| 10 | + LOG_LEVEL=INFO # global default for everything under "app" |
| 11 | + LOG_LEVEL_AI_PROVIDER=DEBUG # verbose logs only for ai_provider.py |
| 12 | + LOG_LEVEL_SCHEDULER=WARNING # quiet down the scheduler |
| 13 | + LOG_LEVEL_CACHE=DEBUG |
| 14 | + LOG_FORMAT="%(asctime)s %(levelname)s %(name)s: %(message)s" |
| 15 | + LOG_JSON=false # set true for structured JSON logs |
| 16 | +
|
| 17 | +Call ``configure_logging()`` once at application startup (already wired |
| 18 | +into ``main.py``'s lifespan). Each module continues to use the standard |
| 19 | +``logging.getLogger(__name__)`` pattern — no per-module code changes are |
| 20 | +needed for this feature to take effect. |
| 21 | +""" |
| 22 | + |
| 23 | +from __future__ import annotations |
| 24 | + |
| 25 | +import json |
| 26 | +import logging |
| 27 | +import logging.config |
| 28 | +import os |
| 29 | +from datetime import UTC, datetime |
| 30 | + |
| 31 | +from .config import settings |
| 32 | + |
| 33 | +# Maps a short, human-friendly component name (used in the |
| 34 | +# LOG_LEVEL_<COMPONENT> env var) to the actual logger name used in the |
| 35 | +# codebase via logging.getLogger(__name__) or logging.getLogger("..."). |
| 36 | +# |
| 37 | +# Add a new entry here whenever a new component should support its own |
| 38 | +# independent log level. |
| 39 | +COMPONENT_LOGGER_MAP: dict[str, str] = { |
| 40 | + "api": "ai_assistant.api", |
| 41 | + "ai_provider": "ai_provider", |
| 42 | + "llm_analysis": "ai_assistant.api", |
| 43 | + "cache": "ai_assistant.api", |
| 44 | + "scheduler": "app.services.scheduler", |
| 45 | + "email": "app.services.email_service", |
| 46 | + "error_tracking": "ai_assistant.api", |
| 47 | + "upload": "app.routers.upload_file", |
| 48 | + "file_validator": "app.utils.file_validator", |
| 49 | + "main": "app.main", |
| 50 | +} |
| 51 | + |
| 52 | +_VALID_LEVELS = {"DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"} |
| 53 | + |
| 54 | + |
| 55 | +def _normalise_level(raw: str | None, fallback: str) -> str: |
| 56 | + """Validate a level string, falling back to ``fallback`` if invalid.""" |
| 57 | + if not raw: |
| 58 | + return fallback |
| 59 | + level = raw.strip().upper() |
| 60 | + return level if level in _VALID_LEVELS else fallback |
| 61 | + |
| 62 | + |
| 63 | +def _collect_component_overrides() -> dict[str, str]: |
| 64 | + """Read all ``LOG_LEVEL_<COMPONENT>`` environment variables. |
| 65 | +
|
| 66 | + Returns a mapping of actual logger name -> level string, ready to be |
| 67 | + merged into the logging dictConfig. |
| 68 | + """ |
| 69 | + overrides: dict[str, str] = {} |
| 70 | + for component, logger_name in COMPONENT_LOGGER_MAP.items(): |
| 71 | + env_key = f"LOG_LEVEL_{component.upper()}" |
| 72 | + raw_value = os.getenv(env_key) |
| 73 | + if raw_value is None: |
| 74 | + continue |
| 75 | + level = _normalise_level(raw_value, settings.log_level) |
| 76 | + overrides[logger_name] = level |
| 77 | + return overrides |
| 78 | + |
| 79 | + |
| 80 | +class _JsonFormatter(logging.Formatter): |
| 81 | + """Minimal structured JSON log formatter (opt-in via LOG_JSON=true).""" |
| 82 | + |
| 83 | + def format(self, record: logging.LogRecord) -> str: |
| 84 | + payload = { |
| 85 | + "timestamp": datetime.fromtimestamp(record.created, tz=UTC).isoformat(), |
| 86 | + "level": record.levelname, |
| 87 | + "logger": record.name, |
| 88 | + "message": record.getMessage(), |
| 89 | + } |
| 90 | + if record.exc_info: |
| 91 | + payload["exception"] = self.formatException(record.exc_info) |
| 92 | + return json.dumps(payload) |
| 93 | + |
| 94 | + |
| 95 | +def get_effective_levels() -> dict[str, str]: |
| 96 | + """Return the resolved log level for every known component. |
| 97 | +
|
| 98 | + Useful for the /health or /metrics endpoints, and for tests, to verify |
| 99 | + the configuration that was actually applied. |
| 100 | + """ |
| 101 | + default_level = _normalise_level(settings.log_level, "INFO") |
| 102 | + overrides = _collect_component_overrides() |
| 103 | + resolved: dict[str, str] = {} |
| 104 | + for component, logger_name in COMPONENT_LOGGER_MAP.items(): |
| 105 | + resolved[component] = overrides.get(logger_name, default_level) |
| 106 | + return resolved |
| 107 | + |
| 108 | + |
| 109 | +def configure_logging() -> None: |
| 110 | + """Apply global + per-component logging configuration. |
| 111 | +
|
| 112 | + Safe to call multiple times (e.g. in tests) — each call fully replaces |
| 113 | + the previous logging configuration via dictConfig's incremental=False |
| 114 | + default, avoiding duplicate handlers. |
| 115 | + """ |
| 116 | + default_level = _normalise_level(settings.log_level, "INFO") |
| 117 | + overrides = _collect_component_overrides() |
| 118 | + |
| 119 | + formatter_name = "json" if settings.log_json else "standard" |
| 120 | + |
| 121 | + loggers_config: dict[str, dict] = { |
| 122 | + "app": { |
| 123 | + "level": default_level, |
| 124 | + "handlers": ["console"], |
| 125 | + "propagate": False, |
| 126 | + } |
| 127 | + } |
| 128 | + # ai_assistant.api and ai_provider are historical logger names used |
| 129 | + # directly (not nested under "app"), so they need explicit entries too. |
| 130 | + for logger_name in set(COMPONENT_LOGGER_MAP.values()): |
| 131 | + if logger_name.startswith("app."): |
| 132 | + continue |
| 133 | + loggers_config[logger_name] = { |
| 134 | + "level": overrides.get(logger_name, default_level), |
| 135 | + "handlers": ["console"], |
| 136 | + "propagate": False, |
| 137 | + } |
| 138 | + |
| 139 | + # Apply per-component overrides onto the "app.*" tree. |
| 140 | + for logger_name, level in overrides.items(): |
| 141 | + if logger_name.startswith("app."): |
| 142 | + loggers_config[logger_name] = { |
| 143 | + "level": level, |
| 144 | + "handlers": ["console"], |
| 145 | + "propagate": False, |
| 146 | + } |
| 147 | + |
| 148 | + logging_dict_config = { |
| 149 | + "version": 1, |
| 150 | + "disable_existing_loggers": False, |
| 151 | + "formatters": { |
| 152 | + "standard": { |
| 153 | + "format": settings.log_format, |
| 154 | + }, |
| 155 | + "json": { |
| 156 | + "()": _JsonFormatter, |
| 157 | + }, |
| 158 | + }, |
| 159 | + "handlers": { |
| 160 | + "console": { |
| 161 | + "class": "logging.StreamHandler", |
| 162 | + "formatter": formatter_name, |
| 163 | + }, |
| 164 | + }, |
| 165 | + "root": { |
| 166 | + "level": default_level, |
| 167 | + "handlers": ["console"], |
| 168 | + }, |
| 169 | + "loggers": loggers_config, |
| 170 | + } |
| 171 | + |
| 172 | + logging.config.dictConfig(logging_dict_config) |
| 173 | + |
| 174 | + summary_logger = logging.getLogger("app.logging_config") |
| 175 | + if overrides: |
| 176 | + override_summary = ", ".join(f"{k}={v}" for k, v in overrides.items()) |
| 177 | + summary_logger.info( |
| 178 | + "Logging configured — default=%s, overrides: %s", |
| 179 | + default_level, |
| 180 | + override_summary, |
| 181 | + ) |
| 182 | + else: |
| 183 | + summary_logger.info( |
| 184 | + "Logging configured — default=%s, no overrides", default_level |
| 185 | + ) |
0 commit comments