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

Uploaded Source

Built Distribution

django_healthchecks-1.0.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.0.0.tar.gz.

File metadata

File hashes

Hashes for django-healthchecks-1.0.0.tar.gz
Algorithm Hash digest
SHA256 00563dc0f210686551c731a8e798ec7a0c17c5aba6aa11880f2c0a38c36172a0
MD5 10965940e5440eadaa29c2f59d49adde
BLAKE2b-256 a7365b152c8e37252df2706175f5db0205268417a278e1feaf99e419a048e055

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_healthchecks-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cd87cae8e9de245ac92e9719983e47e01dc391c39da5f9cfcd0c8334a395f153
MD5 acba440f357a57c0ac882cc237bbbb81
BLAKE2b-256 019dbde2a5b5f7f9978e7a2db3f946332ead7db051ecac1b94397558ea4d875a

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