DEV Community

Cover image for I Built a Lightweight Health Check Package for Django

I Built a Lightweight Health Check Package for Django

While working on several Django projects, I often needed a simple endpoint to verify that the application was actually healthy—not just running.

Most existing solutions were either too heavy, required extra configuration, or didn’t provide the flexibility I wanted.

So I built django-healthkit.

What it does

The package lets you expose a health endpoint that can verify different parts of your application.

Current checks include:

  • Database connectivity
  • Cache availability
  • Disk usage
  • Memory usage
  • CPU usage

Configuration is intentionally simple:

HEALTH_CHECKS = [
    "database",
    "cache",
    "disk",
    "memory",
    "cpu",
]
Enter fullscreen mode Exit fullscreen mode

Then expose the endpoint and you're ready to use it with:

  • Docker health checks
  • Kubernetes probes
  • Traefik
  • Nginx
  • Monitoring systems
  • Uptime monitoring services

Why I built it

My goal wasn't to create another monitoring platform.

I wanted a small package that answers one simple question:

Is my Django application actually healthy?

No dashboards.

No unnecessary dependencies.

Just a clean JSON response that can be consumed by automation.

What's next?

This is only the first release.

Some ideas planned for future versions:

  • Custom health checks
  • Async support
  • Response customization
  • More built-in system checks
  • Better integrations with monitoring tools

I'd love your feedback

If you're using Django, I'd really appreciate your thoughts.

  • What health checks are missing?
  • What features would make this useful in production?
  • Any ideas for improving the API?

Links

Feedback and contributions are always welcome.


About the author

I'm a backend developer focused on Django, distributed systems, developer tools, and open-source software.

Website: https://cyberhuginn.com

GitHub: https://github.com/cyberhuginn

Top comments (0)