json logs: use python-json-logger

Author: boddumanohar

pyproject.toml

@@ -28,6 +28,7 @@ dependencies = [
     'cloudflare',
     'alembic',
     'httpx',
+    'python-json-logger>=4.0',
 ]
 
 [tool.setuptools]

src/api/__init__.py

@@ -28,17 +28,30 @@
 
 
 def _logging_config() -> dict[str, Any]:
-    log_format = "%(asctime)s - %(levelname)s - %(name)s - %(message)s"
     date_format = "%Y-%m-%dT%H:%M:%S%z"
-    log_level = get_settings().log_level
+    settings = get_settings()
+    log_level = settings.log_level
+    if settings.log_json:
+        formatter: dict[str, Any] = {
+            "()": "pythonjsonlogger.json.JsonFormatter",
+            "fmt": "%(asctime)s %(levelname)s %(name)s %(message)s",
+            "rename_fields": {
+                "asctime": "timestamp",
+                "levelname": "level",
+                "name": "logger",
+            },
+            "datefmt": date_format,
+        }
+    else:
+        formatter = {
+            "format": "%(asctime)s - %(levelname)s - %(name)s - %(message)s",
+            "datefmt": date_format,
+        }
     return {
         "version": 1,
         "disable_existing_loggers": False,
         "formatters": {
-            "default": {
-                "format": log_format,
-                "datefmt": date_format,
-            },
+            "default": formatter,
         },
         "handlers": {
             "default": {

src/api/settings.py

@@ -22,6 +22,7 @@ class Settings(BaseSettings):
     keycloak_admin_name: str
     keycloak_admin_secret: str
     log_level: Literal["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"] = "INFO"
+    log_json: bool = True
     resource_monitor_interval: Annotated[timedelta, BeforeValidator(permissive_numeric_timedelta)] = timedelta(
         seconds=60
     )