Enhance logging

Author: jairoperezaquino

app/config.py

@@ -1,8 +1,9 @@
 from pydantic_settings import BaseSettings
+from typing import Literal
 
 
 class Settings(BaseSettings):
-    environment: str = "DEV"
+    environment: Literal["PROD", "DEV", "LOCAL"] = "LOCAL"
 
     @property
     def is_prod(self) -> bool:
@@ -11,6 +12,10 @@ def is_prod(self) -> bool:
     @property
     def is_dev(self) -> bool:
         return self.environment == "DEV"
+    
+    @property
+    def is_local(self) -> bool:
+        return self.environment == "LOCAL"
 
 
-settings = Settings()
+settings = Settings()

app/cloud_logging/__init__.py renamed to app/logging/__init__.py

@@ -3,7 +3,7 @@
 
 from google.cloud.logging_v2.handlers import CloudLoggingFilter
 
-from app.cloud_logging.middleware import http_request_context, cloud_trace_context
+from app.logging.google.middleware import http_request_context, cloud_trace_context
 
 
 class GoogleCloudLogFilter(CloudLoggingFilter):

app/logging/google/__init__.py

@@ -1,5 +1,5 @@
-import contextvars
 import sys
+import contextvars
 
 from fastapi.logger import logger
 from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint

app/cloud_logging/filter.py renamed to app/logging/google/filter.py

@@ -1,12 +1,13 @@
+from fastapi import FastAPI
+from fastapi.logger import logger
 import logging
-
 import google.cloud.logging
 
-from app.cloud_logging.filter import GoogleCloudLogFilter
-from fastapi.logger import logger
+from app.logging.google.filter import GoogleCloudLogFilter
+from app.logging.google.middleware import LoggingMiddleware
 
 
-def setup_logging():
+def setup_google_logging(app: FastAPI = None):
     client = google.cloud.logging.Client()
     handler = client.get_default_handler()
     handler.setLevel(logging.DEBUG)
@@ -15,3 +16,5 @@ def setup_logging():
     logger.handlers = []
     logger.addHandler(handler)
     logger.setLevel(logging.DEBUG)
+    
+    app.add_middleware(LoggingMiddleware)

app/cloud_logging/middleware.py renamed to app/logging/google/middleware.py

@@ -0,0 +1,19 @@
+from fastapi import FastAPI
+from fastapi.logger import logger
+import logging
+
+from app.config import settings
+from app.logging.google.setup import setup_google_logging
+
+def setup_local_logging():
+    logger.setLevel(logging.DEBUG)
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(logging.DEBUG)
+    formatter = logging.Formatter(
+        "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    )
+    console_handler.setFormatter(formatter)
+    logger.addHandler(console_handler)
+
+def setup_logging(app: FastAPI):
+    setup_local_logging() if settings.is_local else setup_google_logging(app)

app/cloud_logging/setup.py renamed to app/logging/google/setup.py

@@ -1,28 +1,11 @@
-import logging
+from fastapi import FastAPI
 from fastapi.logger import logger
-from app.cloud_logging.middleware import LoggingMiddleware
-from app.cloud_logging.setup import setup_logging
 
-from fastapi import FastAPI
 from app.config import settings
-
+from app.logging.setup import setup_logging
 
 app = FastAPI()
-
-if settings.is_prod:
-    setup_logging()
-    app.add_middleware(LoggingMiddleware)
-else:
-    # Setup local logging
-    logger.setLevel(logging.DEBUG)
-    console_handler = logging.StreamHandler()
-    console_handler.setLevel(logging.DEBUG)
-    formatter = logging.Formatter(
-        "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
-    )
-    console_handler.setFormatter(formatter)
-    logger.addHandler(console_handler)
-
+setup_logging(app)
 
 @app.get("/")
 async def root():