IDPF-92 Added Logging & Deployment Fixes (#19)

Procfile

@@ -1 +1 @@
-web: python manage.py check --deploy && python manage.py migrate --noinput && python manage.py clearcache && granian --interface wsgi config.wsgi:application --host 0.0.0.0 --port $PORT
+web: python manage.py check --deploy && python manage.py migrate --noinput && granian --interface wsgi config.wsgi:application --host 0.0.0.0 --port $PORT

config/settings/base.py

@@ -10,6 +10,8 @@
 https://docs.djangoproject.com/en/5.1/ref/settings/
 """
 
+import os
+import sys
 from pathlib import Path
 from typing import Any
 
@@ -60,6 +62,7 @@
     "django.contrib.staticfiles",
     "django.contrib.postgres",
     "core.apps.CoreConfig",
+    "pingdom.apps.PingdomConfig",
 ]
 
 MIDDLEWARE: list[str] = [
@@ -88,6 +91,44 @@
     },
 ]
 
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "handlers": {
+        "stdout": {
+            "class": "logging.StreamHandler",
+            "stream": sys.stdout,
+        },
+    },
+    "root": {
+        "handlers": ["stdout"],
+        "level": os.getenv("ROOT_LOG_LEVEL", "INFO"),
+    },
+    "loggers": {
+        "django": {
+            "handlers": [
+                "stdout",
+            ],
+            "level": os.getenv("DJANGO_LOG_LEVEL", "INFO"),
+            "propagate": True,
+        },
+        "django.request": {
+            "handlers": [
+                "stdout",
+            ],
+            "level": os.getenv("DJANGO_LOG_LEVEL", "INFO"),
+            "propagate": True,
+        },
+        "requestlogs": {
+            "handlers": [
+                "stdout",
+            ],
+            "level": os.getenv("DJANGO_LOG_LEVEL", "INFO"),
+            "propagate": False,
+        },
+    },
+}
+
 # Sentry
 # https://docs.sentry.io/platforms/python/integrations/django/
 SENTRY_DSN: str = env.str("SENTRY_DSN")

config/urls.py

@@ -21,5 +21,6 @@
 
 urlpatterns = [
     path("", include("core.urls")),
+    path("pingdom/", include("pingdom.urls")),
     path("admin/", admin.site.urls),
 ]

pingdom/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class PingdomConfig(AppConfig):
+    name = "pingdom"
+    verbose_name = "Pingdom config"

pingdom/services.py

@@ -0,0 +1,17 @@
+from django.contrib.auth import get_user_model
+from django.db import DatabaseError
+
+
+class CheckDatabase:
+    name = "database"
+
+    def check(self):
+        try:
+            user = get_user_model()
+            user.objects.all().exists()
+            return True, ""
+        except DatabaseError as e:
+            return False, e
+
+
+services_to_check = (CheckDatabase,)

pingdom/tests.py

@@ -0,0 +1,12 @@
+from django.shortcuts import reverse
+from django.test import TestCase
+
+
+class PingdomTest(TestCase):
+    def test_ping_response(self):
+        url = reverse("pingdom")
+        response = self.client.get(url)
+
+        self.assertEqual(response.status_code, 200)
+        assert "<status>OK</status>" in str(response.content)
+        assert response.headers["content-type"] == "text/xml"

pingdom/urls.py

@@ -0,0 +1,8 @@
+from django.urls import path
+
+from .views import pingdom
+
+
+urlpatterns = [
+    path("ping.xml", pingdom, name="pingdom"),
+]

pingdom/views.py

@@ -0,0 +1,27 @@
+from django.http import HttpResponse
+
+from .services import services_to_check
+
+
+PINGDOM_TEMPLATE = """<?xml version="1.0" encoding="UTF-8"?>
+<pingdom_http_custom_check>
+    <status>{status}</status>
+</pingdom_http_custom_check>\n"""
+
+COMMENT_TEMPLATE = "<!--{comment}-->\n"
+
+
+def pingdom(request):
+    checked = {}
+    for service in services_to_check:
+        checked[service.name] = service().check()
+
+    if all(item[0] for item in checked.values()):
+        return HttpResponse(
+            PINGDOM_TEMPLATE.format(status="OK"), content_type="text/xml"
+        )
+    else:
+        body = PINGDOM_TEMPLATE.format(status="FALSE")
+        for service_result in filter(lambda x: x[0] is False, checked.values()):
+            body += COMMENT_TEMPLATE.format(comment=service_result[1])
+        return HttpResponse(body, status=500, content_type="text/xml")