Skip to content

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.

Notifications You must be signed in to change notification settings

johnnydobbins/django-health-check

 
 

Repository files navigation

django-health-check

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:

class DjangoDatabaseBackend(BaseHealthCheckBackend):

    def check_status(self):
        try:
            obj = TestModel.objects.create(title="test")
            obj.title = "newtest"
            obj.save()
            obj.delete()
            return HealthCheckStatusType.working
        except IntegrityError:
            return HealthCheckStatusType.unexpected_result
        except DatabaseError:
            return HealthCheckStatusType.unavailable

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.

plugin_dir.register(DjangoDatabaseBackend)

Installing

Add this to urls.py

url(r'^ht/', include('health_check.urls'))

Add required apps:

    '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)

About

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.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published