django-healthchecks 0.7.0

django-healthchecks

===================



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



Status

======

.. image:: https://travis-ci.org/mvantellingen/django-healthchecks.svg?branch=master

:target: https://travis-ci.org/mvantellingen/django-healthchecks



.. image:: http://codecov.io/github/mvantellingen/django-healthchecks/coverage.svg?branch=master

:target: http://codecov.io/github/mvantellingen/django-healthchecks?branch=master



.. image:: https://pypip.in/version/django_healthchecks/badge.svg

:target: https://pypi-hypernode.com/pypi/django_healthchecks/



Installation

============



.. code-block:: shell



pip install django_healthchecks



Usage

=====



Add the following to your urls.py:





.. code-block:: python



url(r'^healthchecks/', include('django_healthchecks.urls')),



Add a setting with the available healthchecks:



.. code-block:: python



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:





.. code-block:: python



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 `*`.



.. code-block:: python



HEALTH_CHECKS_BASIC_AUTH = {

'*': [('admin', 'pass')],

'solr': [],

}

Home-page: https://github.com/mvantellingen/django-healthchecks
Author: Michael van Tellingen
Author-email: michaelvantellingen@gmail.com
License: MIT
Description: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.7
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5