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://pypip.in/version/django_healthchecks/badge.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-0.7.1.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

django_healthchecks-0.7.1-py2.py3-none-any.whl (6.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for django-healthchecks-0.7.1.tar.gz
Algorithm Hash digest
SHA256 5744bc58d12af02e5525fdcfe2dc5cd10f65b0f0ed57599a4b39fa0882829043
MD5 5e293568c5b6412ecf2e8106c2db6ba4
BLAKE2b-256 20aa86184c2efb65e55842975c57d5cdfb6ff0f84bc8971ac82abf7450c8e385

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_healthchecks-0.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 043d9da071464163d6a9abd54e8af974c2ae91a78f9ea0adcf8239df36afa5df
MD5 7bd4af5860b89bee275d6842c4a9699b
BLAKE2b-256 a5c22f299e1b8787a5cfcee6ffb875393d0d37062e9f7b88f29d28aec4651afa

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