Add SIMPLE_HEALTH_CHECK_ERROR_CODE

Author: pikhovkin

README.md

@@ -56,7 +56,7 @@ urlpatterns = [
 ```python
 SIMPLE_HEALTH_CHECKS = {
     'simple_health_check.checks.migrations.Migrations': [
-        dict(alias='db1'),
+        dict(alias='default'),
         dict(alias='db2'),
     ],
     'simple_health_check.checks.db.Databases': None,

setup.py

@@ -7,7 +7,7 @@
 
 setup(
     name='django-simple-health-check',
-    version='0.3.1',
+    version='0.4.0',
     description='Simple Django health check',
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',

simple_health_check/apps.py

@@ -1,6 +1,5 @@
 from django.apps import AppConfig
 from django.conf import settings
-from django.core.signals import setting_changed
 from django.utils.module_loading import import_string
 
 
@@ -10,7 +9,7 @@ class SimpleHealthCheckConfig(AppConfig):
     checks = {}
 
     @classmethod
-    def register_checks(cls, **kwargs):
+    def register_checks(cls):
         cls.checks = {}
         SIMPLE_HEALTH_CHECKS = getattr(settings, 'SIMPLE_HEALTH_CHECKS', None)
         if SIMPLE_HEALTH_CHECKS is None:
@@ -44,6 +43,3 @@ def check_all(cls):
 
     def ready(self):
         self.register_checks()
-
-
-setting_changed.connect(SimpleHealthCheckConfig.register_checks)

simple_health_check/settings.py

@@ -0,0 +1,18 @@
+from django.conf import settings
+from django.core.signals import setting_changed
+
+from .apps import SimpleHealthCheckConfig
+
+
+ERROR_CODE = getattr(settings, 'SIMPLE_HEALTH_CHECK_ERROR_CODE', 503) or 503
+
+
+def reload_settings(setting, value, **kwargs):
+    if setting == 'SIMPLE_HEALTH_CHECKS':
+        SimpleHealthCheckConfig.register_checks()
+    elif setting == 'SIMPLE_HEALTH_CHECK_ERROR_CODE':
+        global ERROR_CODE
+        ERROR_CODE = value
+
+
+setting_changed.connect(reload_settings)

simple_health_check/tests.py

@@ -12,6 +12,14 @@ def test_readiness(self):
 
     @override_settings(SIMPLE_HEALTH_CHECKS={'simple_health_check.checks.dummy.DummyFalse': None})
     def test_no_readiness(self):
+        response = self.client.get('/readiness/')
+        self.assertContains(response, b'down', status_code=503)
+
+    @override_settings(
+        SIMPLE_HEALTH_CHECK_ERROR_CODE=500,
+        SIMPLE_HEALTH_CHECKS={'simple_health_check.checks.dummy.DummyFalse': None},
+    )
+    def test_other_error_code(self):
         response = self.client.get('/readiness/')
         self.assertContains(response, b'down', status_code=500)
 
@@ -54,7 +62,7 @@ def test_cache_aliases(self):
     )
     def test_cache_no_rediness(self):
         response = self.client.get('/readiness/')
-        self.assertContains(response, b'down', status_code=500)
+        self.assertContains(response, b'down', status_code=503)
 
     @override_settings(
         SIMPLE_HEALTH_CHECKS={
@@ -81,7 +89,7 @@ def test_ps_disk_usage(self):
     )
     def test_ps_disk_usage_no_rediness(self):
         response = self.client.get('/readiness/')
-        self.assertContains(response, b'down', status_code=500)
+        self.assertContains(response, b'down', status_code=503)
 
     @override_settings(
         SIMPLE_HEALTH_CHECKS={
@@ -108,4 +116,4 @@ def test_ps_memory_usage(self):
     )
     def test_ps_memory_usage_no_rediness(self):
         response = self.client.get('/readiness/')
-        self.assertContains(response, b'down', status_code=500)
+        self.assertContains(response, b'down', status_code=503)

simple_health_check/views.py

@@ -1,9 +1,10 @@
 import logging
 
 from django.views import View
-from django.http import HttpResponse, JsonResponse, HttpResponseServerError
+from django.http import HttpResponse, HttpResponseServerError
 
 from .apps import SimpleHealthCheckConfig
+from . import settings
 
 
 logger = logging.getLogger(__name__)
@@ -23,6 +24,6 @@ def get(self, request, *args, **kwargs):
         try:
             SimpleHealthCheckConfig.check_all()
         except Exception as e:
-            logger.error(e)
-            return HttpResponseServerError('down')
+            logger.exception(e)
+            return HttpResponseServerError('down', status=settings.ERROR_CODE)
         return HttpResponse('ok')

tests/conf/settings.py

@@ -127,3 +127,5 @@
 # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+
+SIMPLE_HEALTH_CHECK_ERROR_CODE = 503