olist / django-healthy

django-healthy

---

Table of Contents

• Installation
• License

Installation

First, install the django-healthy package:

pip install django-healthy

In your settings.py, configure HEALTH_CHECK_BACKENDS with your desired indicators.

HEALTH_CHECK_BACKENDS = {
    "cache": {
        "BACKEND": "healthy.backends.CacheHealthBackend",
    },
    "db": {
        "BACKEND": "healthy.backends.DatabasePingBackend",
    },
}

Lastly, add django-healthy's routes to your urls.py:

path("", include("healthy.urls")),

This adds two routes:

• /ping/
• /health/

License

django-healthy is distributed under the terms of the MIT license.