django-health-check 3.23.3__py3-none-any.whl → 4.0rc2__py3-none-any.whl

health_check/contrib/rabbitmq.py

@@ -0,0 +1,43 @@
+"""RabbitMQ health check."""
+
+import dataclasses
+import logging
+
+import aio_pika
+
+from health_check.base import HealthCheck
+from health_check.exceptions import ServiceUnavailable
+
+logger = logging.getLogger(__name__)
+
+
+@dataclasses.dataclass
+class RabbitMQ(HealthCheck):
+    """
+    Check RabbitMQ service by opening and closing a broker channel.
+
+    Args:
+        amqp_url (str): The URL of the RabbitMQ broker to connect to, e.g., 'amqp://guest:guest@localhost:5672//'.
+
+    """
+
+    amqp_url: str
+
+    async def run(self):
+        logger.debug("Attempting to connect to %r...", self.amqp_url)
+        try:
+            # conn is used as a context to release opened resources later
+            connection = await aio_pika.connect_robust(self.amqp_url)
+            await connection.close()
+        except ConnectionRefusedError as e:
+            raise ServiceUnavailable(
+                "Unable to connect to RabbitMQ: Connection was refused."
+            ) from e
+        except aio_pika.exceptions.ProbableAuthenticationError as e:
+            raise ServiceUnavailable(
+                "Unable to connect to RabbitMQ: Authentication error."
+            ) from e
+        except OSError as e:
+            raise ServiceUnavailable("IOError") from e
+        else:
+            logger.debug("Connection established. RabbitMQ is healthy.")

health_check/contrib/redis.py

@@ -0,0 +1,63 @@
+"""Redis health check."""
+
+import dataclasses
+import logging
+
+from redis import exceptions
+from redis.asyncio import Redis as RedisClient
+from redis.asyncio import RedisCluster
+
+from health_check.base import HealthCheck
+from health_check.exceptions import ServiceUnavailable
+
+logger = logging.getLogger(__name__)
+
+
+@dataclasses.dataclass
+class Redis(HealthCheck):
+    """
+    Check Redis service by pinging a Redis client.
+
+    This check works with any Redis client that implements the ping() method,
+    including standard Redis, Sentinel, and Cluster clients.
+
+    Args:
+        client: A Redis client instance (Redis, Sentinel master, or Cluster).
+                If provided, this takes precedence over redis_url.
+
+    Examples:
+        Using a standard Redis client:
+        >>> from redis.asyncio import Redis as RedisClient
+        >>> Redis(client=RedisClient(host='localhost', port=6379))
+
+        Using a Cluster client:
+        >>> from redis.asyncio import RedisCluster
+        >>> Redis(client=RedisCluster(host='localhost', port=7000))
+
+        Using a Sentinel client:
+        >>> from redis.asyncio import Sentinel
+        >>> sentinel = Sentinel([('localhost', 26379)])
+        >>> Redis(client=sentinel.master_for('mymaster'))
+
+    """
+
+    client: RedisClient | RedisCluster = dataclasses.field(default=None, repr=False)
+
+    async def run(self):
+        logger.debug("Pinging Redis client...")
+        try:
+            await self.client.ping()
+        except ConnectionRefusedError as e:
+            raise ServiceUnavailable(
+                "Unable to connect to Redis: Connection was refused."
+            ) from e
+        except exceptions.TimeoutError as e:
+            raise ServiceUnavailable("Unable to connect to Redis: Timeout.") from e
+        except exceptions.ConnectionError as e:
+            raise ServiceUnavailable(
+                "Unable to connect to Redis: Connection Error"
+            ) from e
+        else:
+            logger.debug("Connection established. Redis is healthy.")
+        finally:
+            await self.client.aclose()

health_check/contrib/rss.py

@@ -0,0 +1,113 @@
+"""RSS feed health checks for cloud provider status pages."""
+
+import dataclasses
+import datetime
+import email.utils
+import logging
+from xml.etree import ElementTree
+
+import httpx
+
+from health_check.base import HealthCheck
+from health_check.exceptions import ServiceUnavailable, ServiceWarning
+
+logger = logging.getLogger(__name__)
+
+
+@dataclasses.dataclass
+class AWS(HealthCheck):
+    """
+    Check AWS service status via their public RSS status feeds.
+
+    Args:
+        region: AWS region code (e.g., 'us-east-1', 'eu-west-1').
+        service: AWS service name (e.g., 'ec2', 's3', 'rds').
+        timeout: Request timeout duration.
+        max_age: Maximum age for an incident to be considered active.
+
+    """
+
+    region: str
+    service: str
+    timeout: datetime.timedelta = dataclasses.field(
+        default=datetime.timedelta(seconds=10), repr=False
+    )
+    max_age: datetime.timedelta = dataclasses.field(
+        default=datetime.timedelta(days=1), repr=False
+    )
+
+    def __post_init__(self):
+        self.feed_url: str = (
+            f"https://status.aws.amazon.com/rss/{self.service}-{self.region}.rss"
+        )
+
+    async def run(self):
+        """Check the RSS feed for incidents."""
+        logger.debug("Fetching feed from %s", self.feed_url)
+
+        async with httpx.AsyncClient() as client:
+            try:
+                response = await client.get(
+                    self.feed_url,
+                    headers={"User-Agent": "django-health-check"},
+                    timeout=self.timeout.total_seconds(),
+                    follow_redirects=True,
+                )
+            except httpx.TimeoutException as e:
+                raise ServiceUnavailable("RSS feed request timed out") from e
+            except httpx.RequestError as e:
+                raise ServiceUnavailable(f"Failed to fetch RSS feed: {e}") from e
+
+            try:
+                response.raise_for_status()
+            except httpx.HTTPStatusError as e:
+                raise ServiceUnavailable(
+                    f"HTTP error {e.response.status_code} fetching RSS feed"
+                ) from e
+
+            content = response.text
+
+        try:
+            root = ElementTree.fromstring(content)  # noqa: S314
+        except ElementTree.ParseError as e:
+            raise ServiceUnavailable("Failed to parse RSS feed") from e
+
+        entries = self._extract_entries(root)
+        incidents = [entry for entry in entries if self._is_recent_incident(entry)]
+
+        if incidents:
+            incident_titles = [self._extract_title(entry) for entry in incidents]
+            raise ServiceWarning(
+                f"Found {len(incidents)} recent incident(s): {', '.join(incident_titles)}"
+            )
+
+        logger.debug("No recent incidents found in RSS feed")
+
+    def _extract_entries(self, root):
+        """Extract entries from RSS 2.0 feed."""
+        return root.findall(".//item")
+
+    def _is_recent_incident(self, entry):
+        """Check if entry is a recent incident."""
+        published_at = self._extract_date(entry)
+        if not published_at:
+            return True
+
+        cutoff = datetime.datetime.now(tz=datetime.timezone.utc) - self.max_age
+        return published_at > cutoff
+
+    def _extract_date(self, entry):
+        """Extract publication date from RSS entry."""
+        pub_date = entry.find("pubDate")
+        if pub_date is not None and (date_text := pub_date.text):
+            try:
+                return email.utils.parsedate_to_datetime(date_text)
+            except (ValueError, TypeError):
+                pass
+
+    def _extract_title(self, entry):
+        """Extract title from RSS entry."""
+        if (title := entry.find("title")) is not None:
+            return title.text or "Untitled incident"
+
+        return "Untitled incident"

health_check/exceptions.py

@@ -1,8 +1,5 @@
-from django.utils.translation import gettext_lazy as _  # noqa: N812
-
-
 class HealthCheckException(Exception):
-    message_type = _("unknown error")
+    message_type: str = "Unknown Error"
 
     def __init__(self, message):
         self.message = message
@@ -12,19 +9,14 @@ class HealthCheckException(Exception):
 
 
 class ServiceWarning(HealthCheckException):
-    """
-    Warning of service misbehavior.
-
-    If the ``HEALTH_CHECK['WARNINGS_AS_ERRORS']`` is set to ``False``,
-    these exceptions will not case a 500 status response.
-    """
+    """Warning of service misbehavior."""
 
-    message_type = _("warning")
+    message_type = "Warning"
 
 
 class ServiceUnavailable(HealthCheckException):
-    message_type = _("unavailable")
+    message_type = "Unavailable"
 
 
 class ServiceReturnedUnexpectedResult(HealthCheckException):
-    message_type = _("unexpected result")
+    message_type = "Unexpected Result"

health_check/management/commands/health_check.py

@@ -1,25 +1,19 @@
-import json
 import sys
 import urllib.error
 import urllib.request
-import warnings
 
 from django.core.management.base import BaseCommand
-from django.http import Http404
 from django.urls import reverse
 
-from health_check.mixins import CheckMixin
 
-
-class Command(CheckMixin, BaseCommand):
+class Command(BaseCommand):
     help = "Run health checks and exit 0 if everything went well."
 
     def add_arguments(self, parser):
         parser.add_argument(
             "endpoint",
-            nargs="?",
             type=str,
-            help="Either URL or URL-pattern name of health check endpoint to test",
+            help="URL-pattern name of health check endpoint to test",
         )
         parser.add_argument(
             "addrport",
@@ -28,65 +22,25 @@ class Command(CheckMixin, BaseCommand):
             help="Optional port number, or ipaddr:port (default: localhost:8000)",
             default="localhost:8000",
         )
-        parser.add_argument("-s", "--subset", type=str, nargs=1, help="deprecated")
 
     def handle(self, *args, **options):
-        if 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": "application/json"}
+        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:
+            response = urllib.request.urlopen(request)  # 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)
+        except urllib.error.URLError as e:
+            self.stderr.write(
+                f'"{url}" is not reachable: {e.reason}\nPlease check your ALLOWED_HOSTS setting.'
             )
-            try:
-                response = urllib.request.urlopen(request)  # noqa: S310
-            except urllib.error.HTTPError as e:
-                content = e.read()
-            except urllib.error.URLError as e:
-                self.stderr.write(f'"{url}" is not reachable: {e.reason}\nPlease check your ALLOWED_HOSTS setting.')
-                sys.exit(2)
-            else:
-                content = response.read()
-
-            try:
-                json_data = json.loads(content.decode("utf-8"))
-            except json.JSONDecodeError as e:
-                self.stderr.write(f"Health check endpoint '{endpoint}' did not return valid JSON: {e.msg}\n")
-                sys.exit(2)
-            else:
-                errors = False
-                for label, msg in json_data.items():
-                    if msg == "OK":
-                        style_func = self.style.SUCCESS
-                    else:
-                        style_func = self.style.ERROR
-                        errors = True
-                    self.stdout.write(f"{label:<50} {style_func(msg)}\n")
-                if errors:
-                    sys.exit(1)
-
+            sys.exit(2)
         else:
-            warnings.warn(
-                "Explicit endpoint argument will be required in the next major version: pass the endpoint name to the command. Action: call `django-admin health_check <endpoint>` or update scripts to pass the endpoint. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
-                UserWarning,
-            )
-
-            if subset := options.get("subset", []):
-                warnings.warn(
-                    "`--subset` option is deprecated: use the endpoint argument instead. Action: call `django-admin health_check <endpoint>` or use `HealthCheckView` with subset-configured checks. See migration guide: https://codingjoe.dev/django-health-check/migrate-to-v4/ (docs/migrate-to-v4.md).",
-                    DeprecationWarning,
-                )
-            # perform all checks
-            subset = subset[0] if subset else None
-            try:
-                errors = self.check(subset=subset)
-            except Http404 as e:
-                self.stdout.write(str(e))
-                sys.exit(1)
-
-            for label, plugin in self.filter_plugins(subset=subset).items():
-                style_func = self.style.SUCCESS if not plugin.errors else self.style.ERROR
-                self.stdout.write(f"{label:<24} ... {style_func(plugin.pretty_status())}\n")
-
-            if errors:
-                sys.exit(1)
+            self.stdout.write(response.read().decode("utf-8"))

health_check/templates/health_check/index.html

@@ -8,6 +8,22 @@
     </title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta name="robots" content="noindex">
+    <link rel="alternate"
+          type="application/json"
+          title="JSON"
+          href="?format=json">
+    <link rel="alternate"
+          type="application/atom+xml"
+          title="Atom Feed"
+          href="?format=atom">
+    <link rel="alternate"
+          type="application/rss+xml"
+          title="RSS Feed"
+          href="?format=rss">
+    <link rel="alternate"
+          type="application/openmetrics-text"
+          title="OpenMetrics"
+          href="?format=openmetrics">
     <style>
     :root {
       color-scheme: light dark;
@@ -78,44 +94,44 @@
 
     @media screen and (max-width: 700px) {
 
-            table,
-            thead,
-            tbody,
-            th,
-            td,
-            tr {
-                display: block;
-            }
-
-            thead tr {
-                position: absolute;
-                top: -9999px;
-                left: -9999px;
-            }
-
-            tr {
-                margin-bottom: 1.5em;
-              box-shadow: 0 0 5px light-dark(#ccc, #000);
-              overflow-x: auto;
-            }
-
-            td {
-                border: none;
-                position: relative;
-                padding: 1em 0.5em 1em 6em;
-            }
-
-            td:before {
-                position: absolute;
-                left: 1.5em;
-                content: attr(data-label);
-                font-weight: bold;
-            }
-
-            .align-right {
-              text-align: unset;
-            }
-        }
+      table,
+      thead,
+      tbody,
+      th,
+      td,
+      tr {
+          display: block;
+      }
+
+      thead tr {
+          position: absolute;
+          top: -9999px;
+          left: -9999px;
+      }
+
+      tr {
+          margin-bottom: 1.5em;
+        box-shadow: 0 0 5px light-dark(#ccc, #000);
+        overflow-x: auto;
+      }
+
+      td {
+          border: none;
+          position: relative;
+          padding: 1em 0.5em 1em 6em;
+      }
+
+      td:before {
+          position: absolute;
+          left: 1.5em;
+          content: attr(data-label);
+          font-weight: bold;
+      }
+
+      .align-right {
+        text-align: unset;
+      }
+    }
     </style>
     {% block extra_head %}
     {% endblock extra_head %}
@@ -146,16 +162,16 @@
           </tr>
         </thead>
         <tbody>
-          {% for plugin in plugins %}
-            <tr {% if not plugin.status %}class="error"{% endif %}>
+          {% for result in results %}
+            <tr {% if result.error %}class="error"{% endif %}>
               <td data-label="Service">
-                {{ plugin }}
+                {{ result.check|stringformat:'r' }}
               </td>
               <td data-label="Status" class="mono">
-                {{ plugin.pretty_status | linebreaks }}
+                {{ result.error|default_if_none:"OK"|linebreaks }}
               </td>
               <td data-label="Timing" class="align-right mono">
-                {{ plugin.time_taken|floatformat:3 }}&#x202F;s
+                {{ result.time_taken|floatformat:3 }}&#x202F;s
               </td>
             </tr>
           {% endfor %}
@@ -164,6 +180,8 @@
       <footer>
         <p class="footer-text">
           Generated at {% now "SHORT_DATETIME_FORMAT" %} with <a href="https://codingjoe.dev/django-health-check/">Django Health Check</a>.
+          <br>
+          Subscribe: <a href="?format=atom">Atom</a> | <a href="?format=rss">RSS</a> | <a href="?format=openmetrics">OpenMetrics</a>
         </p>
       </footer>
     {% endblock content %}