Modify based on .env vars and simpligy logic

Author: rragundez

scripts/local_with_uvicorn/.env.example

@@ -20,6 +20,11 @@ CONTACT_NAME="Me"
 CONTACT_EMAIL="[email protected]"
 LICENSE_NAME="MIT"
 
+# ------------- logging settings -------------
+LOG_LEVEL="INFO"
+LOG_FORMAT_AS_JSON=false
+LOG_TO_FILE=false
+
 # ------------- database -------------
 POSTGRES_USER="postgres"
 POSTGRES_PASSWORD=1234

scripts/local_with_uvicorn/docker-compose.yml

@@ -14,6 +14,7 @@ services:
     volumes:
       - ./src/app:/code/app
       - ./src/.env:/code/.env
+      - ./logs:/code/logs
 
   worker:
     build:

src/app/core/config.py

@@ -1,9 +1,13 @@
+import logging
 import os
 from enum import Enum
+from typing import Self
 
-from pydantic import SecretStr, computed_field
+from pydantic import SecretStr, computed_field, field_validator, model_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
+logger = logging.getLogger(__name__)
+
 
 class AppSettings(BaseSettings):
     APP_NAME: str = "FastAPI app"
@@ -24,7 +28,7 @@ class LogLevelOption(str, Enum):
 class LoggingSettings(BaseSettings):
     LOG_LEVEL: LogLevelOption = LogLevelOption.INFO
     LOG_FORMAT_AS_JSON: bool = False
-    LOG_TO_FILE: bool = True
+    LOG_TO_FILE: bool = False
 
 
 class CryptSettings(BaseSettings):
@@ -147,14 +151,19 @@ class CRUDAdminSettings(BaseSettings):
 
 
 class EnvironmentOption(str, Enum):
-    LOCAL = "local"
-    STAGING = "staging"
-    PRODUCTION = "production"
+    LOCAL = "LOCAL"
+    STAGING = "STAGING"
+    PRODUCTION = "PRODUCTION"
 
 
 class EnvironmentSettings(BaseSettings):
     ENVIRONMENT: EnvironmentOption = EnvironmentOption.LOCAL
 
+    @field_validator("ENVIRONMENT", mode="before")
+    @classmethod
+    def normalize_environment(cls, v: str) -> str:
+        return v.upper()
+
 
 class CORSSettings(BaseSettings):
     CORS_ORIGINS: list[str] = ["*"]
@@ -186,5 +195,26 @@ class Settings(
         extra="ignore",
     )
 
+    @model_validator(mode="after")
+    def validate_environment_settings(self) -> Self:
+        """The validation should not modify any of the settings.
+
+        It should provide feedback to the user if any misconfiguration is detected.
+        """
+        environment = self.ENVIRONMENT.value
+        if environment == EnvironmentOption.PRODUCTION:
+            if self.LOG_LEVEL == LogLevelOption.DEBUG:
+                logger.warning(
+                    f"In a {environment} environment, it's recommended to set LOG_LEVEL to INFO, WARNING, or ERROR. "
+                    "It is currently being set to DEBUG."
+                )
+            if self.LOG_FORMAT_AS_JSON is False:
+                logger.warning(
+                    f"In a {environment} environment, it's recommended to set LOG_FORMAT_AS_JSON to true "
+                    "if you are using log aggregation tools."
+                )
+
+        return self
+
 
 settings = Settings()

src/app/core/logger.py

@@ -37,10 +37,9 @@ def log_directory() -> Path:
 
 
 def get_logging_config() -> dict[str, Any]:
-    """Get logging configuration based on environment."""
+    """Get logging configuration."""
     log_level = settings.LOG_LEVEL.value
-    # Base configuration
-    config: dict[str, Any] = {
+    config = {
         "version": 1,
         "disable_existing_loggers": False,
         "formatters": {
@@ -63,6 +62,7 @@ def get_logging_config() -> dict[str, Any]:
                 "class": "logging.StreamHandler",
                 "level": log_level,
                 "stream": "ext://sys.stdout",
+                "formatter": "colored_text",
             },
         },
         "root": {"level": log_level, "handlers": ["console"]},
@@ -100,15 +100,13 @@ def get_logging_config() -> dict[str, Any]:
         }
         config["root"]["handlers"].append("file")
         config["loggers"]["uvicorn.access"]["handlers"].append("file")
+        if settings.LOG_FORMAT_AS_JSON:
+            config["handlers"]["file"]["formatter"] = "json"
+        else:
+            config["handlers"]["file"]["formatter"] = "plain_text"
 
     if settings.LOG_FORMAT_AS_JSON:
-        # As JSON messages
         config["handlers"]["console"]["formatter"] = "json"
-        config["handlers"]["file"]["formatter"] = "json"
-    else:
-        # Colored text depending on the logging level
-        config["handlers"]["console"]["formatter"] = "colored_text"
-        config["handlers"]["file"]["formatter"] = "plain_text"
 
     return config
 
@@ -120,7 +118,7 @@ def setup_logging() -> None:
 
     # Log startup information
     logger = logging.getLogger(__name__)
-    logger.info(f"Log level set to {settings.LOG_LEVEL.value}")
+    logger.info(f"Log level set to {config['root']['level']}")
     if config["handlers"]["console"]["formatter"] == "json":
         logger.info("Logs will be written in JSON format")
     if "console" in config["root"]["handlers"]:

src/app/core/setup.py

@@ -189,7 +189,6 @@ def create_application(
     for caching, queue, and rate limiting, client-side caching, and customizing the API documentation
     based on the environment settings.
     """
-    # Setup logging first based on the environment, before any other operations
     setup_logging()
 
     if isinstance(settings, AppSettings):