Merge pull request #119 from uktrade/feat/asim-logging

feat/asim logging
uktrade · Dec 3, 2024 · ef57f95 · ef57f95
2 parents 4d69d8c + 04704ed
commit ef57f95
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 7 deletions.
diff --git a/.env.example b/.env.example
@@ -59,6 +59,8 @@ DJANGO_SETTINGS_MODULE=redbox_app.settings
 DEBUG=True
 DJANGO_SECRET_KEY=1n53cur3K3y
 DJANGO_LOG_LEVEL=DEBUG
+# If you want to disable asim_log formatting comment out below line 
+DJANGO_LOG_FORMAT=asim_formatter
 ENVIRONMENT=LOCAL
 POSTGRES_USER=redbox-core
 POSTGRES_DB=redbox-core

diff --git a/django_app/poetry.lock b/django_app/poetry.lock
diff --git a/django_app/pyproject.toml b/django_app/pyproject.toml
@@ -48,6 +48,7 @@ scikit-learn = "^1.5.2"
 django-staff-sso-client = "^4.3.0"
 dj-database-url = "^2.3.0"
 dbt-copilot-python = "^0.2.2"
+django-log-formatter-asim = "^0.0.6"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.3.2"

diff --git a/django_app/redbox_app/settings.py b/django_app/redbox_app/settings.py
@@ -10,6 +10,7 @@
 import sentry_sdk
 from dbt_copilot_python.database import database_from_env
 from django.urls import reverse_lazy
+from django_log_formatter_asim import ASIMFormatter
 from dotenv import load_dotenv
 from import_export.formats.base_formats import CSV
 from sentry_sdk.integrations.django import DjangoIntegration
@@ -279,7 +280,7 @@
     ALLOWED_HOSTS = ENVIRONMENT.hosts
 else:
     LOCALHOST = socket.gethostbyname(socket.gethostname())
-    ALLOWED_HOSTS = ['*']
+    ALLOWED_HOSTS = ["*"]
 
 if not ENVIRONMENT.is_local:
 
@@ -306,7 +307,7 @@ def filter_transactions(event):
         )
 SENTRY_REPORT_TO_ENDPOINT = URL(env.str("SENTRY_REPORT_TO_ENDPOINT", "")) or None
 
-database_credentials = os.getenv('DATABASE_CREDENTIALS')
+database_credentials = os.getenv("DATABASE_CREDENTIALS")
 if database_credentials:
     DATABASES = database_from_env("DATABASE_CREDENTIALS")
     DATABASES["default"]["ENGINE"] = "django.db.backends.postgresql"
@@ -324,16 +325,22 @@ def filter_transactions(event):
     }
 
 LOG_LEVEL = env.str("DJANGO_LOG_LEVEL", "WARNING")
+LOG_FORMAT = env.str("DJANGO_LOG_FORMAT", "verbose")
 LOGGING = {
     "version": 1,
     "disable_existing_loggers": False,
-    "formatters": {"verbose": {"format": "%(asctime)s %(levelname)s %(module)s: %(message)s"}},
+    "formatters": {
+        "verbose": {"format": "%(asctime)s %(levelname)s %(module)s: %(message)s"},
+        "asim_formatter": {
+            "()": ASIMFormatter,
+        },
+    },
     "handlers": {
         "console": {
             "level": LOG_LEVEL,
             "class": "logging.StreamHandler",
-            "formatter": "verbose",
-        },
+            "formatter": LOG_FORMAT,
+        }
     },
     "root": {"handlers": ["console"], "level": LOG_LEVEL},
     "loggers": {