feat: change log format to json

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

Refs: PT-1967

Author: danipran

.prod/uwsgi.ini

@@ -1,6 +1,7 @@
 [uwsgi]
 # https://uwsgi-docs.readthedocs.io/en/latest/Options.html
 strict = true  # Fail if any option is unknown
+include = uwsgi-base.ini
 
 http-socket = :8000
 http-timeout = 60

Dockerfile

@@ -1,6 +1,10 @@
 # ==============================
 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
 
@@ -21,6 +25,15 @@ RUN dnf update -y  \
     && uwsgi --build-plugin https://github.com/City-of-Helsinki/uwsgi-sentry \
     && 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=root:root --chmod=755 docker-entrypoint.sh /entrypoint/docker-entrypoint.sh
 ENTRYPOINT ["/entrypoint/docker-entrypoint.sh"]
 

palvelutarjotin/settings.py

@@ -251,12 +251,14 @@ def sentry_traces_sampler(sampling_context: SamplingContext) -> float:
     "reports",
     "notification_importers",
     "palvelutarjotin",
+    "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",
@@ -440,16 +442,49 @@ 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",
+        },
+    },
 }
 
 if DEBUG is True:
     LOGGING["loggers"] = {
-        "django": {"handlers": ["console"], "level": "WARNING"},
-        "occurrences": {"handlers": ["console"], "level": "DEBUG"},
-        "organisations": {"handlers": ["console"], "level": "DEBUG"},
-        "palvelutarjotin": {"handlers": ["console"], "level": "DEBUG"},
+        "django": {
+            "handlers": ["console"],
+            "level": "WARNING",
+        },
+        "occurrences": {
+            "handlers": ["console"],
+            "level": "DEBUG",
+        },
+        "organisations": {
+            "handlers": ["console"],
+            "level": "DEBUG",
+        },
+        "palvelutarjotin": {
+            "handlers": ["console"],
+            "level": "DEBUG",
+        },
     }
 
 CAPTCHA_ENABLED = env.bool("CAPTCHA_ENABLED")

requirements.in

@@ -12,6 +12,7 @@ django-graphql-jwt
 django-health-check
 django-helusers
 django-ilmoitin
+django-logger-extra
 django-parler
 django-utils-six
 drf-spectacular

requirements.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    pip-compile --allow-unsafe --cert=None --client-cert=None --generate-hashes --index-url=None --pip-args=None --strip-extras requirements.in
+#    pip-compile --allow-unsafe --generate-hashes --strip-extras requirements.in
 #
 asgiref==3.10.0 \
     --hash=sha256:aef8a81283a34d0ab31630c9b7dfe70c812c95eba78171367ca8745e88124734 \
@@ -292,6 +292,7 @@ django==5.2.8 \
     #   django-health-check
     #   django-helusers
     #   django-ilmoitin
+    #   django-logger-extra
     #   django-mailer
     #   django-parler
     #   djangorestframework
@@ -355,6 +356,10 @@ django-ilmoitin==0.7.1 \
     --hash=sha256:02931abd50d857ac30195e8ece533b19a0c9e5d6912d86f04044030917f5fa54 \
     --hash=sha256:8c0ced97271a1233027da6267cab67490ade4ef78026d24e6365dbf5c3f413ef
     # via -r requirements.in
+django-logger-extra==1.1.0 \
+    --hash=sha256:bc9450ead1e87aad1866210657d1a9f8efe9e21bfea9b53618d9fd0c829f1179 \
+    --hash=sha256:f44ab408c812474163a21b13a7acba48407ba52b128260370e8f4ccb2ecab89b
+    # via -r requirements.in
 django-mailer==2.3.2 \
     --hash=sha256:6ea0cbec09f57eb91376780a5f20ab7a834b942435a575e92e8e021f7838d78f \
     --hash=sha256:c7ef5ad63d5484246908bd1ce583c22837c66c1a7b593c9b816f4ead2421c995