Health check API for backend & Prompt Sevice (#1048)

* Health check APIs

* Health Check for prompt service

* removing debugging changes

* Fixing security hotspots

* Changing health check endpoints

backend/backend/base_urls.py

@@ -22,4 +22,5 @@
         f"{settings.API_DEPLOYMENT_PATH_PREFIX}/pipeline/",
         include("pipeline_v2.public_api_urls"),
     ),
+    path("", include("health.urls")),
 ]

backend/backend/public_urls_v2.py

@@ -33,6 +33,8 @@
     path("flags/", include("feature_flag.urls")),
     # Pipeline
     path("pipeline/", include("pipeline_v2.public_api_urls")),
+    # health checks
+    path("", include("health.urls")),
 ]
 if settings.ADMIN_ENABLED:
     # Admin URLs

backend/backend/settings/base.py

@@ -224,6 +224,8 @@ def get_required_setting(
     "django_celery_beat",
     # For additional helper commands
     "commands",
+    # health checks
+    "health",
 )
 v2_apps = (
     "migrating.v2",
@@ -446,6 +448,8 @@ def get_required_setting(
 # White lists workflow-api-deployment path
 WHITELISTED_PATHS.append(f"/{API_DEPLOYMENT_PATH_PREFIX}")
 
+# Whitelisting health check API
+WHITELISTED_PATHS.append("/health")
 
 # API Doc Generator Settings
 # https://drf-yasg.readthedocs.io/en/stable/settings.html

backend/health/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class HealthConfig(AppConfig):
+    name = "health"

backend/health/urls.py

@@ -0,0 +1,8 @@
+from django.urls import path
+from rest_framework.urlpatterns import format_suffix_patterns
+
+from .views import health_check
+
+urlpatterns = format_suffix_patterns(
+    [path("health", health_check, name="health-check")]
+)

backend/health/views.py

@@ -0,0 +1,15 @@
+import logging
+
+from django.views.decorators.http import require_http_methods
+from rest_framework.decorators import api_view
+from rest_framework.request import Request
+from rest_framework.response import Response
+
+logger = logging.getLogger(__name__)
+
+
+@api_view(["GET"])
+@require_http_methods(["GET"])
+def health_check(request: Request) -> Response:
+    logger.debug("Verifying backend health..")
+    return Response(status=200)

prompt-service/src/unstract/prompt_service/main.py

@@ -83,6 +83,11 @@ def wrapper(*args: Any, **kwargs: Any) -> Any:
     return wrapper
 
 
+@app.route("/health", methods=["GET"], endpoint="health_check")
+def health_check() -> str:
+    return "OK"
+
+
 @app.route(
     "/answer-prompt",
     endpoint="answer_prompt",