DPM 202 asim formatter logging (#893)

* Use ASIM formatter for logging on production environments
* Upgrade Python version in Docker

.circleci/config.yml

@@ -42,7 +42,7 @@ jobs:
           path: cypress/screenshots
   docs-build:
     docker:
-      - image: python:3.8
+      - image: python:3.12
     steps:
       - checkout
       - dotenv/source:

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8
+FROM python:3.12
 
 RUN mkdir /usr/src/app
 WORKDIR /usr/src/app

app/settings/common.py

@@ -12,50 +12,57 @@
 
 import logging.config
 import os
+import sys
 from urllib.parse import urlencode
 
 import environ
 import sentry_sdk
 from django.core.exceptions import ImproperlyConfigured
 from django.urls import reverse_lazy
 from django.utils import timezone
+from django_log_formatter_asim import ASIMFormatter
 from sentry_sdk.integrations.celery import CeleryIntegration
 from sentry_sdk.integrations.django import DjangoIntegration
 
 environ.Env.read_env()  # read the .env file which should be in the same folder as settings.py
 env = environ.Env()
 
-logging.config.dictConfig({
+# Logging
+LOGGING = {
     'version': 1,
     'disable_existing_loggers': False,
     'formatters': {
-        'console': {
-            'format': '[%(asctime)s] [%(levelname)-4s] %(name)-8s: %(message)s',
-            'datefmt': '%d-%m-%Y %H:%M:%S'
+        'verbose': {
+            'format': '%(asctime)s [%(levelname)s] [%(name)s] %(message)s'
+        },
+        'asim_formatter': {
+            '()': ASIMFormatter,
         },
-        'file': {
-            'format': '%(asctime)s %(name)-12s %(levelname)-8s %(message)s'
-        }
     },
     'handlers': {
-        'console': {
+        'asim': {
             'class': 'logging.StreamHandler',
-            'formatter': 'console'
+            'formatter': 'asim_formatter',
+            'stream': sys.stdout,
         },
-        'file': {
-            'level': 'DEBUG' if env.bool('DEBUG') else 'INFO',
-            'class': 'logging.FileHandler',
-            'formatter': 'file',
-            'filename': '/tmp/debug.log'
-        }
+    },
+    'root': {
+        'level': 'INFO',
+        'handlers': ['asim'],
     },
     'loggers': {
-        '': {
+        'django': {
             'level': 'INFO',
-            'handlers': ['console', 'file']
-        }
-    }
-})
+            'handlers': ['asim'],
+            'propagate': False,
+        },
+        'django.db.backends': {
+            'level': 'ERROR',
+            'handlers': ['asim'],
+            'propagate': False,
+        },
+    },
+}
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

app/settings/e2etest.py

@@ -1,3 +1,36 @@
 from app.settings.common import *
 
 ROOT_URLCONF = 'app.testfixtureapi_urls'
+
+# For local/E2E tests use "plain" logging (read non ASIM formatted)
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'formatters': {
+        'console': {
+            'format': '[%(asctime)s] [%(levelname)-4s] %(name)-8s: %(message)s',
+            'datefmt': '%d-%m-%Y %H:%M:%S'
+        },
+        'file': {
+            'format': '%(asctime)s %(name)-12s %(levelname)-8s %(message)s'
+        }
+    },
+    'handlers': {
+        'console': {
+            'class': 'logging.StreamHandler',
+            'formatter': 'console'
+        },
+        'file': {
+            'level': 'DEBUG' if env.bool('DEBUG') else 'INFO',
+            'class': 'logging.FileHandler',
+            'formatter': 'file',
+            'filename': '/tmp/debug.log'
+        }
+    },
+    'loggers': {
+        '': {
+            'level': 'INFO',
+            'handlers': ['console', 'file']
+        }
+    }
+}

doc/source/conf.py

@@ -90,7 +90,7 @@
                        re.MULTILINE | re.DOTALL).group(1)
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.8", None),
+    "python": ("https://docs.python.org/3.12", None),
     "django": (
         "https://docs.djangoproject.com/en/dev/",
         "https://docs.djangoproject.com/en/dev/_objects/",

requirements.txt

@@ -17,6 +17,7 @@ django-cache-memoize==0.2.0
 django-environ==0.11.2
 django-extensions==3.2.3
 django-filter==24.2
+django-log-formatter-asim==0.0.4
 django-redis==5.4.0
 django-rest-knox==4.2.0
 django-staff-sso-client==4.2.2

runtime.txt

@@ -1 +1 @@
-python-3.8.18
+python-3.12.0