django-health-check 4.0rc1__py3-none-any.whl → 4.0rc3__py3-none-any.whl

{django_health_check-4.0rc1.dist-info → django_health_check-4.0rc3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-health-check
-Version: 4.0rc1
+Version: 4.0rc3
 Summary: Monitor the health of your Django app and its connected services.
 Keywords: django,postgresql
 Author-email: Kristian Ollegaard <kristian@oellegaard.com>, Johannes Maron <johannes@maron.family>

{django_health_check-4.0rc1.dist-info → django_health_check-4.0rc3.dist-info}/RECORD

@@ -1,8 +1,8 @@
 health_check/__init__.py,sha256=1ADgSDnupPOVTlVpJnjHm9nVGDcjhTjVMO_s9e-NGz0,438
-health_check/_version.py,sha256=aT6RyaQ7nKhRVnwCeTgHxtrd9T0i8UdsQNY0JFEplSg,717
+health_check/_version.py,sha256=WQ0-REvimWbQOv0YzR48ShrNHCK3T5uI-X2qdIxGz00,717
 health_check/base.py,sha256=QvErHU2-iQQOua1_nEfLsSuMQIF6Mn5hz68Y9a1OYQY,2932
 health_check/checks.py,sha256=xcBkDIF5u3GDRBILXxm6TQMYTPv2hQcrpnmKUFgUIDI,11362
-health_check/exceptions.py,sha256=Wd7P3F1ZuqJ8ioAIq4kHzmijsyUGL_PBatmqrQB-3-w,655
+health_check/exceptions.py,sha256=qqxMFMLlYsmrAFoaGepHdzsMmllw3u9UnUtd0NKRgx8,525
 health_check/views.py,sha256=HCeEr-BcyfSZD9tS6LBXwvZejT2lSOV0OMLSn9e7hkc,10725
 health_check/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 health_check/contrib/celery.py,sha256=WGqOo3InSooAEQRH1S8BY-NzC1mfRrDo9oTl9BKCxGI,2361
@@ -12,9 +12,9 @@ health_check/contrib/redis.py,sha256=FDYZgZHKw2_Z8hY17pm40QMpHrk0V2mgEPGv3wihT2A
 health_check/contrib/rss.py,sha256=fjcAjqk_nWZGUbjh_UsY6ENfrVZMBZ70aKf4oG4B6CM,3793
 health_check/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 health_check/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-health_check/management/commands/health_check.py,sha256=29VIAGEulKzYkaQbFmw4kyYZR3U6k7IkBjj2qPHVN0A,1579
+health_check/management/commands/health_check.py,sha256=6RY2OB4WoLMIOhgRb8dwzljJDFy676AaAFveiBodn2c,4607
 health_check/templates/health_check/index.html,sha256=BqWM5l-p8CKoOfZn1hmLF_QTqImTJ9dH3lMrXJjNtT4,4523
-django_health_check-4.0rc1.dist-info/licenses/LICENSE,sha256=19Rs8FInCokFQuq03cab_KHwpeyF5pt-lTp7pfJX1iE,1101
-django_health_check-4.0rc1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-django_health_check-4.0rc1.dist-info/METADATA,sha256=lvj2mktANDAIomKXyMw16sKqaf5cpCugsm-hXSYIioQ,3695
-django_health_check-4.0rc1.dist-info/RECORD,,
+django_health_check-4.0rc3.dist-info/licenses/LICENSE,sha256=19Rs8FInCokFQuq03cab_KHwpeyF5pt-lTp7pfJX1iE,1101
+django_health_check-4.0rc3.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+django_health_check-4.0rc3.dist-info/METADATA,sha256=aiLihP5MjMJ67-3dhQbP_ggRClCmAq2Z2vxFmlxwZfo,3695
+django_health_check-4.0rc3.dist-info/RECORD,,

health_check/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '4.0rc1'
-__version_tuple__ = version_tuple = (4, 0, 'rc1')
+__version__ = version = '4.0rc3'
+__version_tuple__ = version_tuple = (4, 0, 'rc3')
 
-__commit_id__ = commit_id = 'g9814c8393'
+__commit_id__ = commit_id = 'g1e96d3f90'

health_check/exceptions.py

@@ -9,12 +9,7 @@ class HealthCheckException(Exception):
 
 
 class ServiceWarning(HealthCheckException):
-    """
-    Warning of service misbehavior.
-
-    If the `HealthCheckView.warnings_as_errors` is set to True,
-    this will be treated as and fail the health check.
-    """
+    """Warning of service misbehavior."""
 
     message_type = "Warning"
 

health_check/management/commands/health_check.py

@@ -1,14 +1,28 @@
+import os
 import sys
 import urllib.error
 import urllib.request
 
+from django.conf import settings
 from django.core.management.base import BaseCommand
-from django.urls import reverse
+from django.urls import NoReverseMatch, reverse
 
 
 class Command(BaseCommand):
     help = "Run health checks and exit 0 if everything went well."
 
+    @property
+    def default_forwarded_host(self):
+        return (
+            settings.ALLOWED_HOSTS[0].strip(".")
+            if settings.ALLOWED_HOSTS and settings.ALLOWED_HOSTS[0] != "*"
+            else None
+        )
+
+    @property
+    def default_addrport(self):
+        return ":".join([os.getenv("HOST", "127.0.0.1"), os.getenv("PORT", "8000")])
+
     def add_arguments(self, parser):
         parser.add_argument(
             "endpoint",
@@ -19,28 +33,92 @@ class Command(BaseCommand):
             "addrport",
             nargs="?",
             type=str,
-            help="Optional port number, or ipaddr:port (default: localhost:8000)",
-            default="localhost:8000",
+            default=self.default_addrport,
+            help=f"Optional port number, or ipaddr:port (default: {self.default_addrport})",
+        )
+        parser.add_argument(
+            "--forwarded-host",
+            type=str,
+            default=self.default_forwarded_host,
+            help=f"Value for X-Forwarded-Host header (default: {self.default_forwarded_host})",
+        )
+        parser.add_argument(
+            "--forwarded-proto",
+            type=str,
+            choices=["http", "https"],
+            default="https",
+            help="Value for X-Forwarded-Proto header (default: https)",
+        )
+        parser.add_argument(
+            "--timeout",
+            type=int,
+            default=5,
+            help="Timeout in seconds for the health check request (default: 5 seconds)",
         )
 
     def handle(self, *args, **options):
         endpoint = options.get("endpoint")
-        path = reverse(endpoint)
-        host, sep, port = options.get("addrport").partition(":")
-        url = f"http://{host}:{port}{path}" if sep else f"http://{host}{path}"
-        request = urllib.request.Request(  # noqa: S310
-            url, headers={"Accept": "text/plain"}
+        try:
+            path = reverse(endpoint)
+        except NoReverseMatch as e:
+            self.stderr.write(
+                f"Could not resolve endpoint {endpoint!r}: {e}\n"
+                "Please provide a valid URL pattern name for the health check endpoint."
+            )
+            sys.exit(2)
+        addrport = options.get("addrport")
+        # Use HTTPS only when SSL redirect is enabled without forwarded headers (direct HTTPS required).
+        # Otherwise use HTTP (typical for containers with X-Forwarded-Proto header support).
+        proto = (
+            "https"
+            if settings.SECURE_SSL_REDIRECT and not settings.USE_X_FORWARDED_HOST
+            else "http"
         )
+        url = f"{proto}://{addrport}{path}"
+
+        headers = {"Accept": "text/plain"}
+
+        # Add X-Forwarded-Host header
+        if forwarded_host := options.get("forwarded_host"):
+            headers["X-Forwarded-Host"] = forwarded_host
+
+        # Add X-Forwarded-Proto header
+        if forwarded_proto := options.get("forwarded_proto"):
+            headers["X-Forwarded-Proto"] = forwarded_proto
+
+        if options.get("verbosity", 1) >= 2:
+            self.stdout.write(
+                f"Checking health endpoint at {url!r} with headers: {headers}"
+            )
+
+        request = urllib.request.Request(url, headers=headers)  # noqa: S310
         try:
-            response = urllib.request.urlopen(request)  # noqa: S310
+            response = urllib.request.urlopen(request, timeout=options["timeout"])  # noqa: S310
         except urllib.error.HTTPError as e:
-            # 500 status codes will raise HTTPError
-            self.stdout.write(e.read().decode("utf-8"))
-            sys.exit(1)
+            match e.code:
+                case 500:  # Health check failed
+                    self.stdout.write(e.read().decode("utf-8"))
+                    sys.exit(1)
+                case 400:
+                    self.stderr.write(
+                        f"{url!r} is not reachable: {e.reason}\nPlease check your ALLOWED_HOSTS setting or use the --forwarded-host option."
+                    )
+                    sys.exit(2)
+                case _:
+                    self.stderr.write(
+                        "Unexpected HTTP error "
+                        f"when trying to reach {url!r}: {e}\n"
+                        f"You may have selected an invalid endpoint {endpoint!r}"
+                        f" or another application is running on {addrport!r}."
+                    )
+                    sys.exit(2)
         except urllib.error.URLError as e:
             self.stderr.write(
-                f'"{url}" is not reachable: {e.reason}\nPlease check your ALLOWED_HOSTS setting.'
+                f"{url!r} is not reachable: {e.reason}\nPlease check your server is running and reachable."
             )
             sys.exit(2)
+        except TimeoutError as e:
+            self.stderr.write(f"Timeout when trying to reach {url!r}: {e}")
+            sys.exit(2)
         else:
             self.stdout.write(response.read().decode("utf-8"))