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

django-health-check is replaced by django-helsinki-health-endpoints.

Refs: KEH-242

Author: nicobav

custom_health_checks/README.md

@@ -303,10 +303,8 @@ def sentry_before_send(event: Event, hint: Hint):
     "guardian",
     "rest_framework",
     "drf_spectacular",
-    "health_check",  # requirement
     "social_django",  # For django-admin Keycloak login
     # local apps
-    "custom_health_checks",
     "users",
     "children",
     "utils",
@@ -323,6 +321,7 @@ def sentry_before_send(event: Event, hint: Hint):
     "logger_extra",
     "resilient_logger",
     "kukkuu",
+    "helsinki_health_endpoints",
     "django_cleanup.apps.CleanupConfig",  # This must be included last
 ]
 
@@ -618,3 +617,5 @@ def sentry_before_send(event: Event, hint: Hint):
     with open(local_settings_path) as fp:
         code = compile(fp.read(), local_settings_path, "exec")
     exec(code, globals(), locals())
+
+SENTRY_RELEASE = env("SENTRY_RELEASE")

custom_health_checks/__init__.py

@@ -2,18 +2,14 @@
 from csp.decorators import csp_update
 from django.conf import settings
 from django.conf.urls.static import static
-from django.http import JsonResponse
 from django.urls import include, path, re_path
 from django.utils.translation import gettext_lazy as _
 from django.views.decorators.csrf import csrf_exempt
-from django.views.decorators.http import require_http_methods
 from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView
 from helusers.admin_site import admin
 from rest_framework import routers
 
 from common.utils import get_api_version
-from custom_health_checks.views import HealthCheckJSONView
-from kukkuu import __version__
 from kukkuu.views import SentryGraphQLView
 from reports.api import ChildViewSet, EventGroupViewSet, EventViewSet, VenueViewSet
 
@@ -65,27 +61,8 @@ def graphql_view(request, *args, **kwargs):
     path("gdpr-api/", include("helsinki_gdpr.urls")),
 ]
 
-
-#
-# Kubernetes liveness & readiness probes
-#
-
-
-@require_http_methods(["GET", "HEAD"])
-def readiness(*args, **kwargs):
-    response_json = {
-        "status": "ok",
-        "release": settings.APP_RELEASE,
-        "packageVersion": __version__,
-        "commitHash": settings.REVISION,
-        "buildTime": settings.APP_BUILD_TIME.strftime("%Y-%m-%dT%H:%M:%S.000Z"),
-    }
-    return JsonResponse(response_json, status=200)
-
-
 urlpatterns += [
-    path(r"healthz", HealthCheckJSONView.as_view(), name="healthz"),
-    path("readiness", readiness),
+    path("", include("helsinki_health_endpoints.urls")),
 ]
 if settings.DEBUG:
     urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

custom_health_checks/apps.py

@@ -7,7 +7,7 @@ django-environ
 django-filter
 django-graphql-jwt
 django-guardian
-django-health-check
+django-helsinki-health-endpoints
 django-helusers
 django-ilmoitin
 django-parler