Skip to main content

Simple Django app/framework to publish health checks

Project description

Simple Django app/framework to publish health check for monitoring purposes

Status

https://travis-ci.org/mvantellingen/django-healthchecks.svg?branch=master http://codecov.io/github/mvantellingen/django-healthchecks/coverage.svg?branch=master https://img.shields.io/pypi/v/django-healthchecks.svg

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',
}

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-healthchecks-1.2.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

django_healthchecks-1.2.0-py2.py3-none-any.whl (7.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-healthchecks-1.2.0.tar.gz.

File metadata

File hashes

Hashes for django-healthchecks-1.2.0.tar.gz
Algorithm Hash digest
SHA256 e026bf2310cdd1751559a466aeb4ca6823b87e09d700423315c9ff7e00a53ef6
MD5 f817e3de83fb298665fb0c92de006c13
BLAKE2b-256 75a6d812cdc6b6dc2e3168809a1ccaa6299917ff4784df3ee1a9977c567d6516

See more details on using hashes here.

File details

Details for the file django_healthchecks-1.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_healthchecks-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 82341554ae0cadec7ea2cdcc7e462a0a0362512811a34794b472b2d7f38f75c5
MD5 d2ba530d8bb5f3f06bce3da49664a486
BLAKE2b-256 abd688ffbdffc6c8c938bd0bbb206b6e4534f30b5b781c6e623329538ab1d480

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page