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

@@ -177,6 +177,9 @@
 COMMIT_HASH = env("OPENSHIFT_BUILD_COMMIT")
 VERSION = __version__
 
+# Django helsinki health endpoints
+SENTRY_RELEASE = env("SENTRY_RELEASE")
+
 SENTRY_TRACES_SAMPLE_RATE = env("SENTRY_TRACES_SAMPLE_RATE")
 SENTRY_TRACES_IGNORE_PATHS = env.list("SENTRY_TRACES_IGNORE_PATHS")
 
@@ -199,7 +202,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"),
@@ -249,9 +252,8 @@ def sentry_traces_sampler(sampling_context: SamplingContext) -> float:
     "auditlog",
     "auditlog_extra",
     "resilient_logger",
-    "health_check",
+    "helsinki_health_endpoints",
     # local apps under this line
-    "custom_health_checks",
     "utils",
     "organisations",
     "occurrences",

custom_health_checks/__init__.py

@@ -2,20 +2,16 @@
 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
 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 common.utils import get_api_version
-from custom_health_checks.views import HealthCheckJSONView
-from palvelutarjotin import __version__
 from palvelutarjotin.views import SentryGraphQLView
 
 admin.site.index_title = " ".join([gettext("Kultus API"), get_api_version()])
@@ -57,25 +53,8 @@ def graphql_view(request, *args, **kwargs):
 ]
 
 
-#
 # 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.COMMIT_HASH,
-        "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),
-]
+urlpatterns += [path("", include("helsinki_health_endpoints.urls"))]
 
 
 if settings.DEBUG:

custom_health_checks/apps.py

@@ -9,8 +9,8 @@ django-csp
 django-environ
 django-filter
 django-graphql-jwt
-django-health-check
 django-helusers
+django-helsinki-health-endpoints
 django-ilmoitin
 django-ipware
 django-logger-extra