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.1.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

django_healthchecks-1.1.0-py2.py3-none-any.whl (7.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-healthchecks-1.1.0.tar.gz
Algorithm Hash digest
SHA256 0d077e5b5bd04c76345997556f99a39d2f6b1bd05370cd7a93f7166261bd647a
MD5 c09cd1b52a0638ccddf89b877c5ce90e
BLAKE2b-256 498ad26dfdf9d7f76d42f4e07c1764787f547096169a8c116ed118553bf4736b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_healthchecks-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 92c3559605d574009839c2e75845e713f80a4ae77bce925a09041c28609b7134
MD5 722aa54b372e6de9f399cd847247b346
BLAKE2b-256 7a2690eefd4c86f3d6539bb5c686e2c6e354f38c142b9c4ee7da5018006fbf06

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