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

Uploaded Source

Built Distribution

django_healthchecks-1.3.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.3.0.tar.gz.

File metadata

File hashes

Hashes for django-healthchecks-1.3.0.tar.gz
Algorithm Hash digest
SHA256 bd57b91c943499c9127c9f35b499e4e2aff9d977a848381f21e103ba0dd81b0b
MD5 74c31739eb867d3c0d25f81059bf7ca2
BLAKE2b-256 3a098ecc032ed5c6b02b8a8569bbcaa942c94353f945aa028d015bb2af99f12d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_healthchecks-1.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cbc4bd336198b653a24695112f5af41c866ef0d626e3f0ba555e4cd555226ca6
MD5 f1b5e272ccf50c36cc90939ebecb5337
BLAKE2b-256 162fb43f5572a9bc288c2237d3659c90b7ebfb1bc655f40341c0a20f4ef43c00

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