Add Celery health check endpoint

the-deep · Nov 22, 2024 · c4605f7 · c4605f7
1 parent 8c1c56b
commit c4605f7
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 3 deletions.
diff --git a/deep/settings.py b/deep/settings.py
@@ -218,6 +218,14 @@
     'drf_yasg',  # API Documentation
     'graphene_django',
     'graphene_graphiql_explorer',
+    # heath check
+    'health_check',
+    'health_check.db',                          # stock Django health checkers
+    'health_check.cache',
+    'health_check.storage',
+    'health_check.contrib.migrations',
+    'health_check.contrib.celery',              # requires celery
+    'health_check.contrib.celery_ping',         # requires celery
 ] + [
     '{}.{}.apps.{}Config'.format(
         APPS_DIR.split('/')[-1],

diff --git a/deep/tests/test_case.py b/deep/tests/test_case.py
@@ -11,6 +11,7 @@
 from django.utils import timezone
 from django.conf import settings
 
+
 from deep.middleware import _set_current_request as _set_middleware_current_request
 from user.models import User
 from project.models import ProjectRole, Project

diff --git a/deep/urls.py b/deep/urls.py
@@ -173,7 +173,7 @@
     ProjectPublicVizView,
     PasswordChanged,
     get_frontend_url,
-    graphql_docs
+    graphql_docs,
 )
 from organization.views import (
     OrganizationViewSet,
@@ -619,6 +619,8 @@ def get_api_path(path):
             name="favicon"),
 
     re_path('ses-bounce/?$', ses_bounce_handler_view, name='ses_bounce'),
+    re_path(r'health-check/', include('health_check.urls')),
+
 ] + [
     # graphql patterns
     re_path('^graphql/?$', csrf_exempt(CustomGraphQLView.as_view())),

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -72,6 +72,7 @@ django-environ = "^0.8.1"
 uwsgi = "*"
 django-admin-autocomplete-filter = "^0.7.1"
 aws-sns-message-validator = "0.0.5 "
+django-health-check = "^3.18.3"
 
 # Thumbnail
 # Shapely = "==1.7.1"