From e7ed9b9d492c69b35fdd8d57d53e28720cd44cee Mon Sep 17 00:00:00 2001
From: Ed Morley <501702+edmorley@users.noreply.github.com>
Date: Thu, 16 Jan 2025 22:00:30 +0000
Subject: [PATCH] Add a custom Django `LOGGING` configuration

Since by default full Django logs are only emitted when `DEBUG=True`
(which otherwise makes diagnosing errors much harder in production):
https://docs.djangoproject.com/en/5.1/ref/logging/#default-logging-configuration
https://docs.djangoproject.com/en/5.1/howto/logging/

GUS-W-17618372.
---
 gettingstarted/settings.py | 39 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/gettingstarted/settings.py b/gettingstarted/settings.py
index 087b3a776..9303c63cb 100644
--- a/gettingstarted/settings.py
+++ b/gettingstarted/settings.py
@@ -196,3 +196,42 @@
 # https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+# Customise the default logging config, since by default full Django logs are only emitted when
+# `DEBUG=True` (which otherwise makes diagnosing errors much harder in production):
+# https://docs.djangoproject.com/en/5.1/ref/logging/#default-logging-configuration
+# For more advanced logging you may want to try: https://django-structlog.readthedocs.io
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {
+        "simple": {
+            "format": "[{levelname}] {message}",
+            "style": "{",
+        },
+    },
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "simple",
+        },
+    },
+    # Fallback for anything not configured via `loggers`.
+    "root": {
+        "handlers": ["console"],
+        "level": "INFO",
+    },
+    "loggers": {
+        "django": {
+            "handlers": ["console"],
+            "level": "INFO",
+            # Prevent double logging due to the root logger.
+            "propagate": False,
+        },
+        "django.request": {
+            # Suppress the WARNINGS from any HTTP 4xx responses (in particular for 404s caused by
+            # web crawlers), but still show any ERRORs from HTTP 5xx responses/exceptions.
+            "level": "ERROR",
+        },
+    },
+}