Feature/improve logger (#9)

* add logger utils to reformat default logger with ECS logger;

* add ecs-logging and update libs;

* replace all default loguru with ecs logger;

* disable uvicorn default logger;

* allow controlling alembic and sqlalchemy logs through env;

Author: EdwardPham1615

alembic.ini

@@ -89,17 +89,17 @@ keys = console
 keys = generic
 
 [logger_root]
-level = WARN
+level = ERROR
 handlers = console
 qualname =
 
 [logger_sqlalchemy]
-level = WARN
+level = ERROR
 handlers =
 qualname = sqlalchemy.engine
 
 [logger_alembic]
-level = INFO
+level = ERROR
 handlers =
 qualname = alembic
 

config.py

@@ -1,9 +1,48 @@
 from typing import Optional
 
 from dynaconf import Dynaconf
-from loguru import logger
 from pydantic import BaseModel, Field
 
+
+# We'll use a deferred logger to avoid circular imports
+# This will be replaced with the actual logger once it's available
+class DeferredLogger:
+    def __init__(self):
+        self.messages = []
+        self.real_logger = None
+
+    def _log(self, level, message, *args, **kwargs):
+        if self.real_logger:
+            getattr(self.real_logger, level)(message, *args, **kwargs)
+        else:
+            self.messages.append((level, message, args, kwargs))
+
+    def info(self, message, *args, **kwargs):
+        self._log("info", message, *args, **kwargs)
+
+    def warning(self, message, *args, **kwargs):
+        self._log("warning", message, *args, **kwargs)
+
+    def error(self, message, *args, **kwargs):
+        self._log("error", message, *args, **kwargs)
+
+    def exception(self, message, *args, **kwargs):
+        self._log("exception", message, *args, **kwargs)
+
+    def debug(self, message, *args, **kwargs):
+        self._log("debug", message, *args, **kwargs)
+
+    def set_real_logger(self, _logger):
+        self.real_logger = _logger
+        # Replay any deferred messages
+        for level, message, args, kwargs in self.messages:
+            getattr(self.real_logger, level)(message, *args, **kwargs)
+        self.messages = []
+
+
+# Create a deferred logger
+logger = DeferredLogger()
+
 # Load settings
 settings = Dynaconf(
     envvar_prefix="APP",
@@ -35,6 +74,7 @@ class AuthenticationServiceConfig(BaseModel):
 class RelationalDBConfig(BaseModel):
     vendor: Optional[str] = Field("postgres", alias="VENDOR")
     url: str = Field(..., alias="URL")
+    enable_log: bool = Field(..., alias="ENABLE_LOG")
     enable_auto_migrate: bool = Field(..., alias="ENABLE_AUTO_MIGRATE")
 
 
@@ -67,6 +107,7 @@ class AppConfig(BaseModel):
         RELATIONAL_DB=RelationalDBConfig(
             VENDOR=settings.RELATIONAL_DB.VENDOR,
             URL=settings.RELATIONAL_DB.URL,
+            ENABLE_LOG=settings.RELATIONAL_DB.ENABLE_LOG,
             ENABLE_AUTO_MIGRATE=settings.RELATIONAL_DB.ENABLE_AUTO_MIGRATE,
         ),
         AUTHENTICATION_SERVICE=AuthenticationServiceConfig(

config/settings.toml

@@ -3,6 +3,6 @@ MAIN_HTTP_PORT = 8082
 HEALTH_CHECK_HTTP_PORT = 5000
 LOG_LEVEL = "INFO"
 UVICORN_WORKERS = 1
-RELATIONAL_DB = '@json { "VENDOR": "postgres", "URL": "postgresql+asyncpg://cleanarc:cleanarc!123@localhost:5432/cleanarc", "ENABLE_AUTO_MIGRATE": true}'
+RELATIONAL_DB = '@json { "VENDOR": "postgres", "URL": "postgresql+asyncpg://cleanarc:cleanarc!123@localhost:5432/cleanarc", "ENABLE_LOG": false, "ENABLE_AUTO_MIGRATE": true}'
 AUTHENTICATION_SERVICE = '@json { "VENDOR": "keycloak", "URL": "http://localhost:8081", "ADMIN_USERNAME": "", "ADMIN_PASSWORD": "", "REALM": "clean-arc", "CLIENT_ID": "python-clean-arc-be", "CLIENT_SECRET": "", "WEBHOOK_SECRET": ""}'
 REBAC_AUTHORIZATION_SERVICE = '@json { "VENDOR": "openfga", "URL": "http://localhost:8080", "TOKEN": "", "STORE_ID": "", "AUTHORIZATION_MODEL_ID": "", "TIMEOUT_IN_MILLIS": 3000 }'

internal/app/middlewares.py

@@ -4,7 +4,6 @@
 from fastapi.responses import ORJSONResponse
 from jwcrypto.jws import InvalidJWSObject
 from jwcrypto.jwt import JWTExpired
-from loguru import logger
 from starlette import status
 from starlette.middleware.base import BaseHTTPMiddleware
 
@@ -17,6 +16,9 @@
 from internal.domains.entities import JWTPayload
 from internal.domains.services.abstraction import AbstractAuthenticationSVC
 from internal.patterns import Container
+from utils.logger_utils import get_shared_logger
+
+logger = get_shared_logger()
 
 
 class JWTAuthMiddleware(BaseHTTPMiddleware):

internal/app/servers.py

@@ -1,13 +1,15 @@
 from fastapi import FastAPI, HTTPException
 from fastapi.encoders import jsonable_encoder
 from fastapi.responses import ORJSONResponse
-from loguru import logger
 from starlette.middleware.cors import CORSMiddleware
 from starlette.requests import Request
 
 from internal.app import JWTAuthMiddleware
 from internal.controllers.http.v1.routes import api_router as api_router_v1
 from internal.controllers.responses import DataResponse, MessageResponse
+from utils.logger_utils import get_shared_logger
+
+logger = get_shared_logger()
 
 app_status = {"alive": True, "status_code": 200, "message": "I'm fine"}
 

internal/controllers/http/v1/endpoints/authentication.py

@@ -4,7 +4,6 @@
 from fastapi import APIRouter, Depends, Request
 from fastapi.encoders import jsonable_encoder
 from fastapi.responses import ORJSONResponse
-from loguru import logger
 
 from internal.controllers.responses import DataResponse
 from internal.controllers.responses.error_code import (
@@ -16,6 +15,9 @@
 from internal.domains.errors import UnauthorizedWebhookException
 from internal.domains.services import AuthenticationSVC
 from internal.patterns import Container
+from utils.logger_utils import get_shared_logger
+
+logger = get_shared_logger()
 
 router = APIRouter()
 

internal/controllers/http/v1/endpoints/comment.py

@@ -4,7 +4,6 @@
 from fastapi import APIRouter, Depends, Request
 from fastapi.encoders import jsonable_encoder
 from fastapi.responses import ORJSONResponse
-from loguru import logger
 from pydantic import UUID4, Field, ValidationError
 
 from internal.controllers.http.payloads import (
@@ -41,6 +40,9 @@
 )
 from internal.domains.services import CommentSVC
 from internal.patterns import Container
+from utils.logger_utils import get_shared_logger
+
+logger = get_shared_logger()
 
 router = APIRouter()
 

internal/controllers/http/v1/endpoints/post.py

@@ -4,7 +4,6 @@
 from fastapi import APIRouter, Depends, Request
 from fastapi.encoders import jsonable_encoder
 from fastapi.responses import ORJSONResponse
-from loguru import logger
 from pydantic import UUID4, Field, ValidationError
 
 from internal.controllers.http.payloads import CreatePostRequestV1, UpdatePostRequestV1
@@ -35,6 +34,9 @@
 )
 from internal.domains.services import PostSVC
 from internal.patterns import Container
+from utils.logger_utils import get_shared_logger
+
+logger = get_shared_logger()
 
 router = APIRouter()
 

internal/domains/services/authentication.py

@@ -1,7 +1,6 @@
 from typing import Optional, Tuple
 
 from fastapi import Request
-from loguru import logger
 
 from internal.domains.constants import WebhookEventOperation, WebhookEventResource
 from internal.domains.entities import CreateUserPayload, WebhookEventEntity
@@ -21,8 +20,11 @@
 from internal.infrastructures.relational_db.patterns import (
     AbstractUnitOfWork as RelationalDBUnitOfWork,
 )
+from utils.logger_utils import get_shared_logger
 from utils.time_utils import DATETIME_DEFAULT_FORMAT, from_dt_to_str
 
+logger = get_shared_logger()
+
 
 class AuthenticationSVC(AbstractAuthenticationSVC):
     def __init__(

internal/domains/services/comment.py

@@ -1,7 +1,5 @@
 from typing import List, Optional, Tuple
 
-from loguru import logger
-
 from internal.domains.constants import V1ReBACObjectType, V1ReBACRelation
 from internal.domains.entities import (
     CommentEntity,
@@ -30,6 +28,9 @@
 from internal.infrastructures.relational_db.patterns import (
     AbstractUnitOfWork as RelationalDBUnitOfWork,
 )
+from utils.logger_utils import get_shared_logger
+
+logger = get_shared_logger()
 
 
 class CommentSVC(AbstractCommentSVC):