Skip to main content

No project description provided

Project description

Installation

pip install dj-healthchecks

Usage

Add to a project

In urls.py:

from django.conf.urls import url, include

from rest_framework import routers
from healthchecks.api import HealthViewSet

router = routers.DefaultRouter()
router.register(r'health', HealthViewSet, basename='health')

urlpatterns = [
    path('admin/', admin.site.urls),
    url(r'^', include(router.urls)),
]

You define your healthchecks in settings.py

HEALTH_CHECKS = [
    'healthchecks.checks.im_ok',
    'healthchecks.checks.connect_to_db',
    'healthchecks.checks.connect_to_queue',
    'healthchecks.checks.connect_to_redis',
    'healthchecks.checks.ping_upstream_urls',
    ...
]

This library provides some utility healthchecks, but you can also easily write your own.

Provided healthchecks are in healthchecks/checks.py

Specifying your own healthcheck:

HEALTH_CHECKS = [
    ...
    'myapp.myodule.my_health_check',
]

Now you have:

GET /health/ # run all health checks in settings.py
GET /health/some-health-check/ # run a specific healthcheck

Note: for a specific healthcheck, you - will be replaced with .

Run project:

docker-compose up

Run tests:

docker-compose run --rm web python manage.py test

Profit.

Updating

Bump the version:

bumpversion manjor|minor|patch

Push to master

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
dj-healthchecks-0.0.1.tar.gz (3.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page