A Django package that provides an easy-to-use health check url path
Project description
Django-easy-health-check
Django-easy-health-check is a Django package that provides an easy-to-use middleware to allow health check.
Motivation
Django's ALLOWED_HOSTS setting often would prevent health check from being completed successfully in production. A common method of getting around this involves making a request to fetch ip address about the instance itself and adding it to the ALLOWED_HOSTS. This approach often varies depending on deployment platform/environment.
This package provides a simple middleware that allows requests to a specified health check path to be made without checking against ALLOWED_HOSTS setting. This negates the need to modify ALLOWED_HOSTS setting in runtime, and is therefore platform-agnostic.
Quick start
Install using pip:
pip install django-easy-health-check
Or, install from source:
pip install git+https://github.com/oscarychen/django-easy-health-check.git
Add the health check middleware to Django settings before django.middleware.common.CommonMiddleware
:
MIDDLEWARE = [
...,
'easy_health_check.middleware.HealthCheckMiddleware',
'django.middleware.common.CommonMiddleware',
...
]
By default, the health check url will be available at "example.com/healthcheck/".
Settings
You can customize and overwrite the default settings by including the following in your project's settings.py:
DJANGO_EASY_HEALTH_CHECK = {
"PATH": "/healthcheck/",
"RETURN_STATUS_CODE": 200,
"RETURN_BYTE_DATA": "",
"RETURN_HEADERS": None
}
In production, you may also want to set the following Django settings:
ALLOWED_HOSTS = ["example.com"]
SECURE_SSL_REDIRECT = True
SECURE_REDIRECT_EXEMPT = [r'^healthcheck/$']
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-easy-health-check-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e897badc85aa79b49f4cc6c9ab71bf1875a2fffe3e08d06f995f8bdac25cbb10 |
|
MD5 | 940e3d945d585c4dc18b8d24f4e83a7d |
|
BLAKE2b-256 | 733c95cbd83c1dc9bdd6cb975cccdf93b8f7920ac9ba657af422638b309b0b42 |
Hashes for django_easy_health_check-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93be1345f303bd9e486d79918a1266b4c9289148d5678db02016d667eab689ca |
|
MD5 | d9f17eafabe2680f43ba09e514ae7d61 |
|
BLAKE2b-256 | dd1c6e959bf1e099a6eeb32cec7ccdd3820e6add340015266da67881c8c9f608 |