feat: use django-helsinki-health-endpoints for readiness and healthz

Make use of django-helsinki-health-endpoints library to publish
readiness and healthz endpoints.

Add SENTRY_RELEASE to django settings from env for the library.

Refs: KEH-242

Author: nicobav

atv/settings.py

@@ -67,6 +67,9 @@
 if os.path.exists(env_file):
     env.read_env(env_file)
 
+# Django helsinki health endpoints
+SENTRY_RELEASE = env.str("SENTRY_RELEASE")
+
 SENTRY_TRACES_SAMPLE_RATE = env("SENTRY_TRACES_SAMPLE_RATE")
 SENTRY_TRACES_IGNORE_PATHS = env("SENTRY_TRACES_IGNORE_PATHS")
 
@@ -89,7 +92,7 @@ def sentry_traces_sampler(sampling_context: SamplingContext) -> float:
     sentry_sdk.init(
         dsn=env("SENTRY_DSN"),
         environment=env("SENTRY_ENVIRONMENT"),
-        release=env("SENTRY_RELEASE"),
+        release=SENTRY_RELEASE,
         integrations=[DjangoIntegration()],
         traces_sampler=sentry_traces_sampler,
         profile_session_sample_rate=env("SENTRY_PROFILE_SESSION_SAMPLE_RATE"),
@@ -161,6 +164,7 @@ def sentry_traces_sampler(sampling_context: SamplingContext) -> float:
     "audit_log",
     "logger_extra",
     "resilient_logger",
+    "helsinki_health_endpoints",
 ]
 
 MIDDLEWARE = [

atv/tests/test_endpoints.py

@@ -1,6 +1,12 @@
-def test_healthz_and_readiness_endpoints(client):
+import pytest
+
+
+def test_healthz_endpoint(client):
     response = client.get("/healthz")
     assert response.status_code == 200
 
+
+@pytest.mark.django_db
+def test_readiness_endpoint(client):
     response = client.get("/readiness")
     assert response.status_code == 200

atv/urls.py

@@ -1,6 +1,5 @@
 from django.conf import settings
 from django.contrib import admin
-from django.http import HttpResponse
 from django.urls import include, path
 from drf_spectacular.views import (
     SpectacularAPIView,
@@ -60,17 +59,6 @@
         ),
     ]
 
-#
-# Kubernetes liveness & readiness probes
-#
-
-
-def healthz(*args, **kwargs):
-    return HttpResponse(status=200)
-
 
-def readiness(*args, **kwargs):
-    return HttpResponse(status=200)
-
-
-urlpatterns += [path("healthz", healthz), path("readiness", readiness)]
+# Kubernetes liveness & readiness probes
+urlpatterns += [path("", include("helsinki_health_endpoints.urls"))]

requirements.in

@@ -4,6 +4,7 @@ django-environ
 django-filter
 django-guardian
 django-helusers
+django-helsinki-health-endpoints
 django-logger-extra
 django-resilient-logger
 django-searchable-encrypted-fields

requirements.txt

@@ -154,6 +154,7 @@ django==5.2.12 \
     #   django-cors-headers
     #   django-filter
     #   django-guardian
+    #   django-helsinki-health-endpoints
     #   django-helusers
     #   django-logger-extra
     #   django-resilient-logger
@@ -178,6 +179,10 @@ django-guardian==3.2.0 \
     --hash=sha256:0768565a057988a93fc4a1d93649c4a794abfd7473a8408a079cfbf83c559d77 \
     --hash=sha256:9e18ecd2e211b665972690c2d03d27bce0ea4932b5efac24a4bb9d526950a69e
     # via -r requirements.in
+django-helsinki-health-endpoints==1.0.0 \
+    --hash=sha256:75670113e99bfd1fc23e317a3a22cff563140f495655c2a5f6ab219389dafd52 \
+    --hash=sha256:eebf1baa6917d7b0e11123aec191df773883102ec1653025a86d7037dba389e2
+    # via -r requirements.in
 django-helusers==0.14.0 \
     --hash=sha256:424f97e7aa6792ae255de56344f765795444849ea82e9d4e01666494c28e960c \
     --hash=sha256:79b922d51278a9e9793a00279782e5455b72e9e9d0f261dd17be2f0dbcbaa1f9