a pluggable app that runs a full check on the deployment, using a number of plugins to check e.g. database, queue server, celery processes, etc.
Project description
django-health-check
==================
[](https://pypi-hypernode.com/pypi/django-health-check/)
[](https://travis-ci.org/KristianOellegaard/django-health-check)
[](https://coveralls.io/r/KristianOellegaard/django-health-check)
[](https://landscape.io/github/KristianOellegaard/django-health-check/master)
[](LICENSE)
This project checks a number of backends, if they are able to connect and do a simple action, e.g. check out the django ORM backend:
```python
class DjangoDatabaseBackend(BaseHealthCheckBackend):
def check_status(self):
try:
obj = TestModel.objects.create(title="test")
obj.title = "newtest"
obj.save()
obj.delete()
return True
except IntegrityError:
raise ServiceReturnedUnexpectedResult("Integrity Error")
except DatabaseError:
raise ServiceUnavailable("Database error")
```
The project is made using some of the same codes, that the django admin site uses - so when you have sucessfully written a new plugin, you register it to the pool, e.g.
```python
plugin_dir.register(DjangoDatabaseBackend)
```
Install
=======
Add this to urls.py
```python
url(r'^ht/', include('health_check.urls'))
```
Add required apps:
```python
'health_check',
'health_check_celery',
'health_check_db',
'health_check_cache',
'health_check_storage',
```
(remember to add dependencies, e.g. djcelery - however you should have that already, if you have celery running).
You'll also have to make sure that you have a
`result backend <http://celery.readthedocs.org/en/latest/configuration.html?highlight=result_backend#std:setting-CELERY_RESULT_BACKEND>`_
configured.
If you are using celery 3, use ``health_check_celery3`` instead of ``health_check_celery``.
Set up monitoring
=================
E.g. add to pingdom - django-health-check will return HTTP 200 if everything is OK and HTTP 500 if *anything* is not working.
Dependencies
============
Django 1.4+
==================
[](https://pypi-hypernode.com/pypi/django-health-check/)
[](https://travis-ci.org/KristianOellegaard/django-health-check)
[](https://coveralls.io/r/KristianOellegaard/django-health-check)
[](https://landscape.io/github/KristianOellegaard/django-health-check/master)
[](LICENSE)
This project checks a number of backends, if they are able to connect and do a simple action, e.g. check out the django ORM backend:
```python
class DjangoDatabaseBackend(BaseHealthCheckBackend):
def check_status(self):
try:
obj = TestModel.objects.create(title="test")
obj.title = "newtest"
obj.save()
obj.delete()
return True
except IntegrityError:
raise ServiceReturnedUnexpectedResult("Integrity Error")
except DatabaseError:
raise ServiceUnavailable("Database error")
```
The project is made using some of the same codes, that the django admin site uses - so when you have sucessfully written a new plugin, you register it to the pool, e.g.
```python
plugin_dir.register(DjangoDatabaseBackend)
```
Install
=======
Add this to urls.py
```python
url(r'^ht/', include('health_check.urls'))
```
Add required apps:
```python
'health_check',
'health_check_celery',
'health_check_db',
'health_check_cache',
'health_check_storage',
```
(remember to add dependencies, e.g. djcelery - however you should have that already, if you have celery running).
You'll also have to make sure that you have a
`result backend <http://celery.readthedocs.org/en/latest/configuration.html?highlight=result_backend#std:setting-CELERY_RESULT_BACKEND>`_
configured.
If you are using celery 3, use ``health_check_celery3`` instead of ``health_check_celery``.
Set up monitoring
=================
E.g. add to pingdom - django-health-check will return HTTP 200 if everything is OK and HTTP 500 if *anything* is not working.
Dependencies
============
Django 1.4+
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-health-check-1.1.5.tar.gz.
File metadata
- Download URL: django-health-check-1.1.5.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 40ac4bce094cb7da0cab69662e1696ed66ce778b9c6bf4fe94fb16a630bc0533 |
|
| MD5 | bd952002ebc66c82a70f4311250b07ce |
|
| BLAKE2b-256 | 55df0198d289c59baa126e8ac5c77e0c3a59caedb5ec4d40995bca44dcdd9aa8 |
