Merge pull request #1 from mozilla/add-mozlog-on-startup

Adding log.py to capture logging setup and configuration.

Author: leplatrem

src/app/api.py

@@ -1,6 +1,4 @@
 import logging
-import logging.config
-import sys
 import time
 from datetime import datetime
 
@@ -9,34 +7,12 @@
 from fastapi.responses import RedirectResponse
 
 from src.app.environment import get_settings
+from src.app.log import configure_logging
 from src.app.monitor import api_router as monitor_router
 from src.jbi.router import api_router as jbi_router
 
 settings = get_settings()
 
-logging_config = {
-    "version": 1,
-    "formatters": {
-        "json": {
-            "()": "dockerflow.logging.JsonLogFormatter",
-            "logger_name": "jbi",
-        },
-    },
-    "handlers": {
-        "console": {
-            "level": settings.log_level.upper(),
-            "class": "logging.StreamHandler",
-            "formatter": "json",
-            "stream": sys.stdout,
-        }
-    },
-    "loggers": {
-        "request.summary": {"handlers": ["console"], "level": "INFO"},
-    },
-}
-
-logging.config.dictConfig(logging_config)
-
 app = FastAPI(
     title="Jira Bugzilla Integration (JBI)",
     description="JBI v2 Platform",
@@ -46,8 +22,6 @@
 app.include_router(monitor_router)
 app.include_router(jbi_router)
 
-summary_logger = logging.getLogger("request.summary")
-
 
 @app.get("/", include_in_schema=False)
 def root(request: Request):
@@ -61,6 +35,7 @@ def root(request: Request):
 
 @app.middleware("http")
 async def request_summary(request: Request, call_next):
+    summary_logger = logging.getLogger("request.summary")
     previous_time = time.time()
 
     infos = {
@@ -84,7 +59,12 @@ async def request_summary(request: Request, call_next):
     return response
 
 
+@app.on_event("startup")
+def startup_event():
+    configure_logging()
+
+
 if __name__ == "__main__":
     uvicorn.run(
-        "app:app", host="0.0.0.0", port=settings.port, reload=settings.app_reload
+        "app:app", host=settings.host, port=settings.port, reload=settings.app_reload
     )

src/app/log.py

@@ -0,0 +1,32 @@
+import logging
+import logging.config
+import sys
+
+from src.app.environment import get_settings
+
+settings = get_settings()
+
+
+def configure_logging():
+    logging_config = {
+        "version": 1,
+        "formatters": {
+            "mozlog_json": {
+                "()": "dockerflow.logging.JsonLogFormatter",
+                "logger_name": "jbi",
+            },
+        },
+        "handlers": {
+            "console": {
+                "level": settings.log_level.upper(),
+                "class": "logging.StreamHandler",
+                "formatter": "mozlog_json",
+                "stream": sys.stdout,
+            }
+        },
+        "loggers": {
+            "request.summary": {"handlers": ["console"], "level": "INFO"},
+        },
+    }
+
+    logging.config.dictConfig(logging_config)

tests/unit/app/test_api.py

@@ -1,3 +1,8 @@
+from fastapi.testclient import TestClient
+
+from src.app.api import app
+
+
 def test_read_root(anon_client):
     """The site root redirects to the Swagger docs"""
     resp = anon_client.get("/")
@@ -8,12 +13,14 @@ def test_read_root(anon_client):
     assert prev_resp.headers["location"] == "./docs"
 
 
-def test_request_summary_is_logged(anon_client, caplog):
-    anon_client.get("/__lbheartbeat__")
+def test_request_summary_is_logged(caplog):
+    with TestClient(app) as anon_client:
+        # https://fastapi.tiangolo.com/advanced/testing-events/
+        anon_client.get("/__lbheartbeat__")
 
-    summary = caplog.records[-1]
+        summary = caplog.records[-1]
 
-    assert summary.name == "request.summary"
-    assert summary.method == "GET"
-    assert summary.path == "/__lbheartbeat__"
-    assert summary.querystring == {}
+        assert summary.name == "request.summary"
+        assert summary.method == "GET"
+        assert summary.path == "/__lbheartbeat__"
+        assert summary.querystring == {}