Simple Django app/framework to publish health checks
Project description
Simple Django app/framework to publish health check for monitoring purposes
Status
Installation
pip install django_healthchecks
Usage
Add the following to your urls.py:
url(r'^healthchecks/', include('django_healthchecks.urls')),
Add a setting with the available healthchecks:
HEALTH_CHECKS = {
'postgresql': 'django_healthchecks.contrib.check_database',
'cache_default': 'django_healthchecks.contrib.check_cache_default',
'solr': 'your_project.lib.healthchecks.check_solr',
}
You can also include healthchecks over http. This is useful when you want to monitor if depending services are up:
HEALTH_CHECKS = {
...
'my_microservice': 'https://my-service.services.internal/healthchecks/',
...
}
By default, http health checks will time out after 500ms. You can override this as follows:
HEALTH_CHECKS_HTTP_TIMEOUT = 0.5
By default the status code is always 200, you can change this to something else by using the HEALTH_CHECKS_ERROR_CODE setting:
HEALTH_CHECKS_ERROR_CODE = 503
You can also add some simple protection to your healthchecks via basic auth. This can be specified per check or a wildcard can be used *.
HEALTH_CHECKS_BASIC_AUTH = {
'*': [('admin', 'pass')],
'solr': [],
}
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-healthchecks-1.4.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 482d30ce69f259641ca10a268de38f0af19c6b8a2ebd3072fee23948881826e5 |
|
MD5 | ecfdc4c4c0b30c4019c4b0760e98d197 |
|
BLAKE2b-256 | 466f19e4d131933f2214d1666545828bad7ecac5d8a7423621796e33808e855c |
Hashes for django_healthchecks-1.4.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08109852971d5e688f8e9e931cf44fa11ff4977d345e50b14df7fc44e94f710c |
|
MD5 | 3db9e7ee5cfc3dbd9a7cba21b0ad31e9 |
|
BLAKE2b-256 | b4617cf836c6ec796368cdf87a9ccec305ff66c69acd10039036e4b74d5a2456 |