feat: change log format to json

- Add django-logger-extra
- Configure in Django
- Configure in uWSGI
- Use common uWSGI components

Refs: NS-181

Author: danipran

.prod/uwsgi.ini

@@ -1,5 +1,6 @@
 [uwsgi]
 strict = true
+include = uwsgi-base.ini
 
 http-socket = :8000
 chdir = /app

Dockerfile

@@ -2,6 +2,9 @@
 FROM registry.access.redhat.com/ubi9/python-312 AS appbase
 # ==============================
 
+# Branch or tag used to pull python-uwsgi-common.
+ARG UWSGI_COMMON_REF=main
+
 USER root
 WORKDIR /app
 
@@ -23,6 +26,15 @@ RUN dnf update -y && dnf install -y nc \
     && mkdir /entrypoint \
     && dnf clean all
 
+# Build and copy specific python-uwsgi-common files.
+ADD https://github.com/City-of-Helsinki/python-uwsgi-common/archive/${UWSGI_COMMON_REF}.tar.gz /usr/src/
+RUN mkdir -p /usr/src/python-uwsgi-common && \
+    tar --strip-components=1 -xzf /usr/src/${UWSGI_COMMON_REF}.tar.gz -C /usr/src/python-uwsgi-common && \
+    cp /usr/src/python-uwsgi-common/uwsgi-base.ini /app && \
+    uwsgi --build-plugin /usr/src/python-uwsgi-common && \
+    rm -rf /usr/src/${UWSGI_COMMON_REF}.tar.gz && \
+    rm -rf /usr/src/python-uwsgi-common
+
 COPY --chown=default:root docker-entrypoint.sh /entrypoint/docker-entrypoint.sh
 CMD ["/usr/bin/bash", "/entrypoint/docker-entrypoint.sh"]
 

notification_service/settings.py

@@ -151,12 +151,14 @@ def sentry_traces_sampler(sampling_context: SamplingContext) -> float:
     "common",
     "custom_health_checks",
     "audit_log",
+    "logger_extra",
 ]
 
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
     "corsheaders.middleware.CorsMiddleware",
+    "logger_extra.middleware.XRequestIdMiddleware",
     "csp.middleware.CSPMiddleware",
     "django.middleware.locale.LocaleMiddleware",
     "django.middleware.common.CommonMiddleware",
@@ -256,8 +258,29 @@ def sentry_traces_sampler(sampling_context: SamplingContext) -> float:
 LOGGING = {
     "version": 1,
     "disable_existing_loggers": False,
-    "handlers": {"console": {"class": "logging.StreamHandler"}},
-    "loggers": {"django": {"handlers": ["console"], "level": "ERROR"}},
+    "filters": {
+        "context": {
+            "()": "logger_extra.filter.LoggerContextFilter",
+        }
+    },
+    "formatters": {
+        "json": {
+            "()": "logger_extra.formatter.JSONFormatter",
+        }
+    },
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "json",
+            "filters": ["context"],
+        },
+    },
+    "loggers": {
+        "django": {
+            "handlers": ["console"],
+            "level": "ERROR",
+        },
+    },
 }
 
 # local_settings.py can be used to override environment-specific settings

requirements.in

@@ -1,10 +1,11 @@
-django~=5.2
+Django~=5.2
+django-axes
 django-cors-headers
 django-csp
 django-environ
 django-helusers
 django-health-check
-django-axes
+django-logger-extra
 djangorestframework
 factory-boy
 psycopg[c]

requirements.txt

@@ -298,6 +298,7 @@ django==5.2.8 \
     #   django-csp
     #   django-health-check
     #   django-helusers
+    #   django-logger-extra
     #   djangorestframework
     #   sentry-sdk
     #   social-auth-app-django
@@ -325,6 +326,10 @@ django-helusers==0.14.0 \
     --hash=sha256:424f97e7aa6792ae255de56344f765795444849ea82e9d4e01666494c28e960c \
     --hash=sha256:79b922d51278a9e9793a00279782e5455b72e9e9d0f261dd17be2f0dbcbaa1f9
     # via -r requirements.in
+django-logger-extra==1.1.0 \
+    --hash=sha256:bc9450ead1e87aad1866210657d1a9f8efe9e21bfea9b53618d9fd0c829f1179 \
+    --hash=sha256:f44ab408c812474163a21b13a7acba48407ba52b128260370e8f4ccb2ecab89b
+    # via -r requirements.in
 djangorestframework==3.16.1 \
     --hash=sha256:166809528b1aced0a17dc66c24492af18049f2c9420dbd0be29422029cfc3ff7 \
     --hash=sha256:33a59f47fb9c85ede792cbf88bde71893bcda0667bc573f784649521f1102cec