Skip to main content

django-healthkit

Lightweight and extensible health checks for Django applications.

django-healthkit helps you expose health check endpoints for your Django services so they can be monitored by load balancers, container platforms, and monitoring systems.


Features

  • Lightweight and dependency-free (Django only)
  • Class-based health endpoint
  • Database health check
  • Cache health check
  • Configurable via Django settings
  • Extensible architecture
  • Suitable for Docker and Kubernetes

Requirements

  • Python 3.10+
  • Django 5.2+

Installation

pip install django-healthkit

Quick Start

1. Add the application

INSTALLED_APPS = [
    ...
    "django_healthkit",
    ...
]

2. Configure HealthKit

HEALTHKIT = {
    "CHECKS": [
        "django_healthkit.checks.database.DatabaseCheck",
        "django_healthkit.checks.cache.CacheCheck",
    ],
}

3. Register the endpoint

from django.urls import path

from django_healthkit.views import HealthView

urlpatterns = [
    path("health/", HealthView.as_view(), name="health"),
]

4. Visit

GET /health/

Example Response

{
  "healthy": true,
  "checks": [
    {
      "name": "database",
      "healthy": true,
      "message": "Database is healthy.",
      "latency": 0.49
    },
    {
      "name": "cache",
      "healthy": true,
      "message": "Cache is healthy.",
      "latency": 0.57
    }
  ]
}

Why django-healthkit?

Modern applications require reliable health endpoints for orchestration and monitoring.

django-healthkit provides a simple, extensible foundation for exposing the health of your Django application without unnecessary dependencies.


Roadmap

  • Disk health check
  • Memory health check
  • CPU health check
  • Custom check registration
  • Async health checks
  • Prometheus exporter
  • OpenTelemetry integration

Contributing

Contributions, issues, and feature requests are welcome.


License

MIT

Metadata

Release files for django-healthkit 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-healthkit 0.1.1
File Size Uploaded Provenance Actions
django_healthkit-0.1.1.tar.gz 6.1 kB Without provenance Details for django_healthkit-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for django-healthkit 0.1.1
File Interpreter ABI Platform Actions
django_healthkit-0.1.1-py3-none-any.whl Python 3 none any Details for django_healthkit-0.1.1-py3-none-any.whl

Total release size: 13.9 kB

Release files / django_healthkit-0.1.1.tar.gz

Download URL django_healthkit-0.1.1.tar.gz
Size 6.1 kB
Tags Source
SHA-256 checksum
How to use checksums
83a9d001fe82b1a6d2ccc6e0e0c519bad7ad71157e6cbe92a2557a9c92e47347
BLAKE2b-256 checksum
How to use checksums
7b55982843dd69e6e85814f61178b4b68988548d7876f4f76f2a30ccd1259ab8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.9

Release files / django_healthkit-0.1.1-py3-none-any.whl

Download URL django_healthkit-0.1.1-py3-none-any.whl
Size 7.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
75421bd1b6577fd3e69b1683c3eb9b2be5999e8b79dca7085536c449ef82efb8
BLAKE2b-256 checksum
How to use checksums
8cd957f2ac49b31b1eca1bb7b21846791106efa57831d1c02ed178fab24d7816
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.9

Security for django-healthkit 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page