django-health-check 3.20.7__tar.gz → 3.21.0__tar.gz

{django_health_check-3.20.7 → django_health_check-3.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-health-check
-Version: 3.20.7
+Version: 3.21.0
 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>
@@ -28,12 +28,19 @@ Classifier: Topic :: System :: Monitoring
 Classifier: Topic :: Utilities
 License-File: LICENSE
 Requires-Dist: Django>=4.2
+Requires-Dist: psutil
+Requires-Dist: celery>=5.0.0 ; extra == "celery"
+Requires-Dist: kombu>=5.0.0 ; extra == "rabbitmq"
+Requires-Dist: redis>=3.0.0 ; extra == "redis"
 Project-URL: Changelog, https://github.com/codingjoe/django-health-check/releases
 Project-URL: Documentation, https://codingjoe.dev/django-health-check/
 Project-URL: Homepage, https://codingjoe.dev/django-health-check/
 Project-URL: Issues, https://github.com/codingjoe/django-health-check/issues
 Project-URL: Releasenotes, https://github.com/codingjoe/django-health-check/releases/latest
 Project-URL: Source, https://github.com/codingjoe/django-health-check
+Provides-Extra: celery
+Provides-Extra: rabbitmq
+Provides-Extra: redis
 
 <p align="center">
   <picture>

django_health_check-3.21.0/health_check/__init__.py

@@ -0,0 +1,30 @@
+"""Monitor the health of your Django app and its connected services."""
+
+from . import _version  # noqa
+from .cache.backends import CacheBackend as Cache
+from .contrib.mail.backends import MailHealthCheck as Mail
+from .contrib.psutil.backends import DiskUsage as Disk, MemoryUsage as Memory
+from .contrib.db_heartbeat.backends import DatabaseHeartBeatCheck as Database
+from .storage.backends import StorageHealthCheck as Storage
+from .backends import HealthCheck
+
+__version__ = _version.__version__
+VERSION = _version.__version_tuple__
+
+Cache.__qualname__ = "Cache"
+Database.__qualname__ = "Database"
+Disk.__qualname__ = "Disk"
+Mail.__qualname__ = "Mail"
+Storage.__qualname__ = "Storage"
+Memory.__qualname__ = "Memory"
+__all__ = [
+    "__version__",
+    "VERSION",
+    "Cache",
+    "Database",
+    "Disk",
+    "Mail",
+    "Storage",
+    "Memory",
+    "HealthCheck",
+]

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.20.7'
-__version_tuple__ = version_tuple = (3, 20, 7)
+__version__ = version = '3.21.0'
+__version_tuple__ = version_tuple = (3, 21, 0)
 
-__commit_id__ = commit_id = 'g1c04d5acb'
+__commit_id__ = commit_id = 'gae94a27bd'

django_health_check-3.21.0/health_check/backends.py

@@ -0,0 +1,101 @@
+import dataclasses
+import logging
+import warnings
+from timeit import default_timer as timer
+
+from health_check.exceptions import HealthCheckException
+
+logger = logging.getLogger("health-check")
+
+
+@dataclasses.dataclass()
+class HealthCheck:
+    """
+    Base class for all health check backends.
+
+    To create your own health check backend, subclass this class
+    and implement the ``check_status`` method.
+    """
+
+    critical_service: bool = dataclasses.field(init=False, default=True, repr=False)
+    errors: list[HealthCheckException] = dataclasses.field(init=False, default_factory=list, repr=False)
+
+    def check_status(self):
+        """
+        Execute the health check logic.
+
+        This method should be overridden by subclasses to implement
+        specific health check logic. If the check fails, it should
+        call `self.add_error` with an appropriate error message or
+        raise a `HealthCheckException`.
+
+        Raises:
+            HealthCheckException: If the health check fails.
+            ServiceWarning: If the health check encounters a warning condition.
+
+        """
+        raise NotImplementedError
+
+    def run_check(self):
+        start = timer()
+        self.errors = []
+        try:
+            self.check_status()
+        except HealthCheckException as e:
+            self.add_error(e, e)
+        except BaseException:
+            logger.exception("Unexpected Error!")
+            raise
+        finally:
+            self.time_taken = timer() - start
+
+    def add_error(self, error, cause=None):
+        if isinstance(error, HealthCheckException):
+            pass
+        elif isinstance(error, str):
+            msg = error
+            error = HealthCheckException(msg)
+        else:
+            msg = "unknown error"
+            error = HealthCheckException(msg)
+        if isinstance(cause, BaseException):
+            logger.exception(str(error))
+        else:
+            logger.error(str(error))
+        self.errors.append(error)
+
+    def pretty_status(self):
+        if self.errors:
+            return "\n".join(str(e) for e in self.errors)
+        return "OK"
+
+    @property
+    def status(self):
+        return int(not self.errors)
+
+    def __repr__(self):
+        if hasattr(self, "identifier"):
+            warnings.warn(
+                "`identifier()` method is deprecated: implement `__repr__()` instead to return a stable identifier. Action: update your backend class to implement `__repr__` and remove `identifier()`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+                DeprecationWarning,
+            )
+            return self.identifier()
+
+        return self.__class__.__name__
+
+
+class BaseHealthCheck(HealthCheck):
+    """
+    Deprecated base class for health check backends.
+
+    This class is maintained for backward compatibility.
+    New health check backends should inherit from `HealthCheck` instead.
+    """
+
+    def __init_subclass__(cls, **kwargs):
+        warnings.warn(
+            f"{cls.__name__} inherits from deprecated `BaseHealthCheck`: inherit from `HealthCheck` instead. Action: update subclass to inherit from `health_check.backends.HealthCheck`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init_subclass__(**kwargs)

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/cache/apps.py

@@ -11,4 +11,4 @@ class HealthCheckConfig(AppConfig):
         from .backends import CacheBackend
 
         for backend in settings.CACHES:
-            plugin_dir.register(CacheBackend, backend=backend)
+            plugin_dir.register(CacheBackend, alias=backend)

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/cache/backends.py

@@ -1,7 +1,10 @@
+import dataclasses
+import datetime
+
 from django.conf import settings
 from django.core.cache import CacheKeyWarning, caches
 
-from health_check.backends import BaseHealthCheckBackend
+from health_check.backends import HealthCheck
 from health_check.exceptions import ServiceReturnedUnexpectedResult, ServiceUnavailable
 
 try:
@@ -17,21 +20,27 @@ except ModuleNotFoundError:
         pass
 
 
-class CacheBackend(BaseHealthCheckBackend):
-    def __init__(self, backend="default"):
-        super().__init__()
-        self.backend = backend
-        self.cache_key = getattr(settings, "HEALTHCHECK_CACHE_KEY", "djangohealthcheck_test")
+@dataclasses.dataclass
+class CacheBackend(HealthCheck):
+    """
+    Check that the cache backend is able to set and get a value.
 
-    def identifier(self):
-        return f"Cache backend: {self.backend}"
+    Args:
+        alias: The cache alias to test against.
 
-    def check_status(self):
-        cache = caches[self.backend]
+    """
 
+    alias: str = dataclasses.field(default="default")
+    cache_key: str = dataclasses.field(
+        default=getattr(settings, "HEALTHCHECK_CACHE_KEY", "djangohealthcheck_test"), repr=False
+    )
+
+    def check_status(self):
+        cache = caches[self.alias]
+        ts = datetime.datetime.now().timestamp()
         try:
-            cache.set(self.cache_key, "itworks")
-            if not cache.get(self.cache_key) == "itworks":
+            cache.set(self.cache_key, f"itworks-{ts}")
+            if not cache.get(self.cache_key) == f"itworks-{ts}":
                 raise ServiceUnavailable(f"Cache key {self.cache_key} does not match")
         except CacheKeyWarning as e:
             self.add_error(ServiceReturnedUnexpectedResult("Cache key warning"), e)

django_health_check-3.21.0/health_check/contrib/celery/__init__.py

@@ -0,0 +1,3 @@
+from ..celery_ping.backends import CeleryPingHealthCheck as Ping
+
+__all__ = ["Ping"]

django_health_check-3.21.0/health_check/contrib/celery/apps.py

@@ -0,0 +1,31 @@
+import warnings
+
+from celery import current_app
+from django.apps import AppConfig
+from django.conf import settings
+
+from health_check.plugins import plugin_dir
+
+
+class HealthCheckConfig(AppConfig):
+    name = "health_check.contrib.celery"
+
+    def ready(self):
+        from .backends import CeleryHealthCheck
+
+        warnings.warn(
+            "The `health_check.contrib.celery` app is deprecated: checks are now configured via `HealthCheckView`. Action: remove this sub-app from `INSTALLED_APPS` and add the Celery check(s) to your `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+            DeprecationWarning,
+        )
+
+        if hasattr(settings, "HEALTHCHECK_CELERY_TIMEOUT"):
+            warnings.warn(
+                "`HEALTHCHECK_CELERY_TIMEOUT` setting is deprecated: it was split into separate timeouts. Action: replace it with `HEALTHCHECK_CELERY_RESULT_TIMEOUT` and `HEALTHCHECK_CELERY_QUEUE_TIMEOUT`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+                DeprecationWarning,
+            )
+
+        for queue in current_app.amqp.queues:
+            celery_class_name = "CeleryHealthCheck" + queue.title()
+
+            celery_class = type(celery_class_name, (CeleryHealthCheck,), {"queue": queue})
+            plugin_dir.register(celery_class)

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/contrib/celery/backends.py

@@ -1,13 +1,17 @@
 from celery.exceptions import TaskRevokedError, TimeoutError
 from django.conf import settings
 
-from health_check.backends import BaseHealthCheckBackend
+from health_check.backends import HealthCheck
+from health_check.deprecation import deprecated
 from health_check.exceptions import ServiceReturnedUnexpectedResult, ServiceUnavailable
 
 from .tasks import add
 
 
-class CeleryHealthCheck(BaseHealthCheckBackend):
+@deprecated(
+    "`CeleryHealthCheck` is deprecated: use `health_check.contrib.celery.Ping` (or the new view-based Celery ping check) instead. Action: remove legacy CeleryHealthCheck subclasses and configure `HealthCheckView` with the new Celery ping check in your `checks` list. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md)."
+)
+class CeleryHealthCheck(HealthCheck):
     def check_status(self):
         timeout = getattr(settings, "HEALTHCHECK_CELERY_TIMEOUT", 3)
         result_timeout = getattr(settings, "HEALTHCHECK_CELERY_RESULT_TIMEOUT", timeout)

django_health_check-3.21.0/health_check/contrib/celery_ping/apps.py

@@ -0,0 +1,19 @@
+import warnings
+
+from django.apps import AppConfig
+
+from health_check.plugins import plugin_dir
+
+
+class HealthCheckConfig(AppConfig):
+    name = "health_check.contrib.celery_ping"
+
+    def ready(self):
+        from .backends import CeleryPingHealthCheck
+
+        warnings.warn(
+            "The `health_check.contrib.celery_ping` app is deprecated: checks are now configured via `HealthCheckView`. Action: remove this sub-app from `INSTALLED_APPS` and add `health_check.contrib.celery.Ping` or the appropriate ping check to your `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+            DeprecationWarning,
+        )
+
+        plugin_dir.register(CeleryPingHealthCheck)

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/contrib/celery_ping/backends.py

@@ -1,18 +1,29 @@
+import dataclasses
+import datetime
+
 from celery.app import default_app as app
 from django.conf import settings
 
-from health_check.backends import BaseHealthCheckBackend
+from health_check.backends import HealthCheck
 from health_check.exceptions import ServiceUnavailable
 
 
-class CeleryPingHealthCheck(BaseHealthCheckBackend):
+@dataclasses.dataclass
+class CeleryPingHealthCheck(HealthCheck):
+    """
+    Check Celery worker availability using the ping control command.
+
+    Args:
+        timeout: Timeout duration for the ping command.
+
+    """
+
     CORRECT_PING_RESPONSE = {"ok": "pong"}
+    timeout: datetime.timedelta = datetime.timedelta(seconds=getattr(settings, "HEALTHCHECK_CELERY_PING_TIMEOUT", 1))
 
     def check_status(self):
-        timeout = getattr(settings, "HEALTHCHECK_CELERY_PING_TIMEOUT", 1)
-
         try:
-            ping_result = app.control.ping(timeout=timeout)
+            ping_result = app.control.ping(timeout=self.timeout.total_seconds())
         except OSError as e:
             self.add_error(ServiceUnavailable("IOError"), e)
         except NotImplementedError as exc:

django_health_check-3.21.0/health_check/contrib/db_heartbeat/apps.py

@@ -0,0 +1,19 @@
+import warnings
+
+from django.apps import AppConfig
+
+from health_check.plugins import plugin_dir
+
+
+class HealthCheckConfig(AppConfig):
+    name = "health_check.contrib.db_heartbeat"
+
+    def ready(self):
+        from .backends import DatabaseHeartBeatCheck
+
+        warnings.warn(
+            "The `health_check.contrib.db_heartbeat` app is deprecated: checks are now configured via `HealthCheckView`. Action: remove this sub-app from `INSTALLED_APPS` and add `health_check.contrib.db_heartbeat.DatabaseHeartBeatCheck` to your `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+            DeprecationWarning,
+        )
+
+        plugin_dir.register(DatabaseHeartBeatCheck)

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/contrib/db_heartbeat/backends.py

@@ -1,7 +1,9 @@
-from django.db import connection
+import dataclasses
+
+from django.db import connections
 from django.db.models import Expression
 
-from health_check.backends import BaseHealthCheckBackend
+from health_check.backends import HealthCheck
 from health_check.exceptions import ServiceUnavailable
 
 
@@ -15,10 +17,20 @@ class SelectOne(Expression):
         return "SELECT 1 FROM DUAL", []
 
 
-class DatabaseHeartBeatCheck(BaseHealthCheckBackend):
-    """Health check that runs a simple SELECT 1; query to test if the database connection is alive."""
+@dataclasses.dataclass
+class DatabaseHeartBeatCheck(HealthCheck):
+    """
+    Check database connectivity by executing a simple SELECT 1 query.
+
+    Args:
+        alias: The alias of the database connection to check.
+
+    """
+
+    alias: str = dataclasses.field(default="default")
 
     def check_status(self):
+        connection = connections[self.alias]
         try:
             result = None
             compiler = connection.ops.compiler("SQLCompiler")(SelectOne(), connection, None)

django_health_check-3.21.0/health_check/contrib/mail/apps.py

@@ -0,0 +1,19 @@
+import warnings
+
+from django.apps import AppConfig
+
+from health_check.plugins import plugin_dir
+
+
+class HealthCheckConfig(AppConfig):
+    name = "health_check.contrib.mail"
+
+    def ready(self):
+        from .backends import MailHealthCheck
+
+        warnings.warn(
+            "The `health_check.contrib.mail` app is deprecated: checks are now configured via `HealthCheckView`. Action: remove this sub-app from `INSTALLED_APPS` and add `health_check.Mail` to your `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+            DeprecationWarning,
+        )
+
+        plugin_dir.register(MailHealthCheck)

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/contrib/mail/backends.py

@@ -1,6 +1,9 @@
+import dataclasses
+import datetime
 import logging
 import smtplib
 
+from django.conf import settings
 from django.core.mail import get_connection
 from django.core.mail.backends.base import BaseEmailBackend
 
@@ -9,13 +12,26 @@ from health_check import backends, conf, exceptions
 logger = logging.getLogger(__name__)
 
 
-class MailHealthCheck(backends.BaseHealthCheckBackend):
-    """Check that mail backend is working."""
+@dataclasses.dataclass
+class MailHealthCheck(backends.HealthCheck):
+    """
+    Check that mail backend is able to open and close connection.
+
+    Args:
+        backend: The email backend to test against.
+        timeout: Timeout for connection to mail server.
+
+    """
+
+    backend: str = settings.EMAIL_BACKEND
+    timeout: datetime.timedelta = dataclasses.field(
+        default=datetime.timedelta(seconds=conf.HEALTH_CHECK.get("MAIL_TIMEOUT", 15)),
+        repr=False,
+    )
 
     def check_status(self) -> None:
-        """Open and close connection with email server."""
-        connection: BaseEmailBackend = get_connection(fail_silently=False)
-        connection.timeout = conf.HEALTH_CHECK.get("MAIL_TIMEOUT", 15)
+        connection: BaseEmailBackend = get_connection(self.backend, fail_silently=False)
+        connection.timeout = self.timeout.total_seconds()
         logger.debug("Trying to open connection to mail backend.")
         try:
             connection.open()
@@ -42,4 +58,4 @@ class MailHealthCheck(backends.BaseHealthCheckBackend):
             )
         finally:
             connection.close()
-        logger.debug("Connection established. Mail backend is healthy.")
+        logger.debug("Connection established. Mail backend %r is healthy.", self.backend)

django_health_check-3.21.0/health_check/contrib/migrations/apps.py

@@ -0,0 +1,19 @@
+import warnings
+
+from django.apps import AppConfig
+
+from health_check.plugins import plugin_dir
+
+
+class HealthCheckConfig(AppConfig):
+    name = "health_check.contrib.migrations"
+
+    def ready(self):
+        from .backends import MigrationsHealthCheck
+
+        warnings.warn(
+            "The `health_check.contrib.migrations` app is deprecated: checks are now configured via `HealthCheckView`. Action: remove this sub-app from `INSTALLED_APPS` and add the migration check to your `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+            DeprecationWarning,
+        )
+
+        plugin_dir.register(MigrationsHealthCheck)

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/contrib/migrations/backends.py

@@ -4,13 +4,17 @@ from django.conf import settings
 from django.db import DEFAULT_DB_ALIAS, DatabaseError, connections
 from django.db.migrations.executor import MigrationExecutor
 
-from health_check.backends import BaseHealthCheckBackend
+from health_check.backends import HealthCheck
+from health_check.deprecation import deprecated
 from health_check.exceptions import ServiceUnavailable
 
 logger = logging.getLogger(__name__)
 
 
-class MigrationsHealthCheck(BaseHealthCheckBackend):
+@deprecated(
+    "`MigrationsHealthCheck` is deprecated and removed: Django's system check framework covers migrations. Action: remove this check and rely on Django's check framework or add an alternative check to `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md)."
+)
+class MigrationsHealthCheck(HealthCheck):
     def get_migration_plan(self, executor):
         return executor.migration_plan(executor.loader.graph.leaf_nodes())
 

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/contrib/psutil/apps.py

@@ -1,3 +1,5 @@
+import warnings
+
 from django.apps import AppConfig
 from django.conf import settings
 
@@ -10,6 +12,11 @@ class HealthCheckConfig(AppConfig):
     def ready(self):
         from .backends import DiskUsage, MemoryUsage
 
+        warnings.warn(
+            "The `health_check.contrib.psutil` app is deprecated: checks are now configured via `HealthCheckView` and explicit `checks` lists. Action: remove this sub-app from `INSTALLED_APPS` and add `health_check.Disk` and `health_check.Memory` to your `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+            DeprecationWarning,
+        )
+
         # Ensure checks haven't been explicitly disabled before registering
         if (
             hasattr(settings, "HEALTH_CHECK")

django_health_check-3.21.0/health_check/contrib/psutil/backends.py

@@ -0,0 +1,63 @@
+import dataclasses
+import os
+import pathlib
+import socket
+
+import psutil
+
+from health_check.backends import HealthCheck
+from health_check.conf import HEALTH_CHECK
+from health_check.exceptions import ServiceReturnedUnexpectedResult, ServiceWarning
+
+
+@dataclasses.dataclass()
+class DiskUsage(HealthCheck):
+    """
+    Check system disk usage.
+
+    Args:
+        path: Path to check disk usage for.
+        max_disk_usage_percent: Maximum disk usage in percent or None to disable the check.
+
+    """
+
+    path: pathlib.Path | str = dataclasses.field(default=os.getcwd())
+    max_disk_usage_percent: float | None = dataclasses.field(default=HEALTH_CHECK["DISK_USAGE_MAX"], repr=False)
+    hostname: str = dataclasses.field(default_factory=socket.gethostname, init=False)
+
+    def check_status(self):
+        try:
+            du = psutil.disk_usage(str(self.path))
+            if self.max_disk_usage_percent and du.percent >= self.max_disk_usage_percent:
+                raise ServiceWarning(f"{du.percent}\u202f% disk usage")
+        except ValueError as e:
+            self.add_error(ServiceReturnedUnexpectedResult("ValueError"), e)
+
+
+@dataclasses.dataclass()
+class MemoryUsage(HealthCheck):
+    """
+    Check system memory usage.
+
+    Args:
+        min_gibibytes_available: Minimum available memory in gibibytes or None to disable the check.
+        max_memory_usage_percent: Maximum memory usage in percent or None to disable the check.
+
+    """
+
+    min_gibibytes_available: float | None = dataclasses.field(default=None, repr=False)
+    max_memory_usage_percent: float | None = dataclasses.field(default=90.0, repr=False)
+    hostname: str = dataclasses.field(default_factory=socket.gethostname, init=False)
+
+    def check_status(self):
+        try:
+            memory = psutil.virtual_memory()
+            available_gibi = memory.available / (1024**3)
+            total_gibi = memory.total / (1024**3)
+            msg = f"RAM {available_gibi:.1f}/{total_gibi:.1f}GiB ({memory.percent}\u202f%)"
+            if self.min_gibibytes_available and available_gibi < self.min_gibibytes_available:
+                raise ServiceWarning(msg)
+            if self.max_memory_usage_percent and memory.percent >= self.max_memory_usage_percent:
+                raise ServiceWarning(msg)
+        except ValueError as e:
+            self.add_error(ServiceReturnedUnexpectedResult("ValueError"), e)

django_health_check-3.21.0/health_check/contrib/rabbitmq/__init__.py

@@ -0,0 +1,3 @@
+from .backends import RabbitMQHealthCheck as RabbitMQ
+
+__all__ = ["RabbitMQ"]

django_health_check-3.21.0/health_check/contrib/rabbitmq/apps.py

@@ -0,0 +1,19 @@
+import warnings
+
+from django.apps import AppConfig
+
+from health_check.plugins import plugin_dir
+
+
+class HealthCheckConfig(AppConfig):
+    name = "health_check.contrib.rabbitmq"
+
+    def ready(self):
+        from .backends import RabbitMQHealthCheck as RabbitMQ
+
+        warnings.warn(
+            "The `health_check.contrib.rabbitmq` app is deprecated: checks are now configured via `HealthCheckView`. Action: remove this sub-app from `INSTALLED_APPS` and add `health_check.contrib.rabbitmq.RabbitMQ` to your `HealthCheckView.checks`. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
+            DeprecationWarning,
+        )
+
+        plugin_dir.register(RabbitMQ)

{django_health_check-3.20.7 → django_health_check-3.21.0}/health_check/contrib/rabbitmq/backends.py

@@ -1,22 +1,29 @@
+import dataclasses
 import logging
 
 from amqp.exceptions import AccessRefused
 from django.conf import settings
 from kombu import Connection
 
-from health_check.backends import BaseHealthCheckBackend
+from health_check.backends import HealthCheck
 from health_check.exceptions import ServiceUnavailable
 
 logger = logging.getLogger(__name__)
 
 
-class RabbitMQHealthCheck(BaseHealthCheckBackend):
-    """Health check for RabbitMQ."""
+@dataclasses.dataclass
+class RabbitMQHealthCheck(HealthCheck):
+    """
+    Check RabbitMQ service by opening and closing a broker channel.
 
-    namespace = None
+    Args:
+        namespace: Optional namespace for the broker URL setting.
+
+    """
+
+    namespace: str = None
 
     def check_status(self):
-        """Check RabbitMQ service by opening and closing a broker channel."""
         logger.debug("Checking for a broker_url on django settings...")
 
         broker_url_setting_key = f"{self.namespace}_BROKER_URL" if self.namespace else "BROKER_URL"

django_health_check-3.21.0/health_check/contrib/redis/__init__.py

@@ -0,0 +1,3 @@
+from .backends import RedisHealthCheck as Redis
+
+__all__ = ["Redis"]