django-simple-health-check

PyPI - Python Version PyPI - Django Version

Simple Django health check

Inspired by:

Installation

$ pip install django-simple-health-check

Use pip install django-simple-health-check[psutil] for using simple_health_check.checks.ps.* checks.

Quick start

Install the package
Add simple_health_check to your INSTALLED_APPS settings like this:

INSTALLED_APPS = [
    ...,
    'simple_health_check',
    ...,
]

Add simple_health_check.urls to main urls.py:

from django.urls import path, include

urlpatterns = [
    ...,
    path('', include('simple_health_check.urls')),
    ...,
]

Configure the readiness checks:

SIMPLE_HEALTH_CHECKS = {
    'simple_health_check.checks.migrations.Migrations': [
        dict(alias='default'),
        dict(alias='db2'),
    ],
    'simple_health_check.checks.db.Databases': None,

    # The simplest way to add your own check
    'your_package.path_to_checks.SomeCheck': {...} or [{...}, ...] or None,
}

by default

SIMPLE_HEALTH_CHECKS = {
    'simple_health_check.checks.migrations.Migrations': None,  # check all aliases
    'simple_health_check.checks.db.Databases': None,  # check all aliases
}

Built-in checks

A check	Built-in/expected
simple_health_check.checks.db.Databases	:heavy_check_mark:
simple_health_check.checks.migrations.Migrations	:heavy_check_mark:
simple_health_check.checks.caches.CacheBackends	:heavy_check_mark:
simple_health_check.checks.ps.DiskUsage	:heavy_check_mark:
simple_health_check.checks.ps.MemoryUsage	:heavy_check_mark:
simple_health_check.checks.dummy.DummyTrue	:heavy_check_mark:
simple_health_check.checks.dummy.DummyFalse	:heavy_check_mark:
emails	:hourglass_flowing_sand:
queues	:hourglass_flowing_sand:
storages	:hourglass_flowing_sand:

License

MIT

Release files for django-simple-health-check 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-simple-health-check 0.6.1
File	Size	Uploaded
django-simple-health-check-0.6.1.tar.gz	6.4 kB	Dec 5, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for django-simple-health-check 0.6.1
File	Interpreter	ABI	Platform	Reset
django_simple_health_check-0.6.1-py3-none-any.whl 9.8 kB Dec 5, 2023	Python 3	none	any	Details

Total release size: 16.1 kB

Release files / django-simple-health-check-0.6.1.tar.gz

Download URL	django-simple-health-check-0.6.1.tar.gz
Size	6.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`69755a538e54189703f9d81fe605ce0ea0c1d76816015fe641a141c5d5432622`
BLAKE2b-256 checksum How to use checksums	`732952555857064237fedd70fe2bde22952b00a09b778e3f20efc8a5cd262a39`
Upload date	Dec 5, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.12.0`

Release files / django_simple_health_check-0.6.1-py3-none-any.whl

Download URL	django_simple_health_check-0.6.1-py3-none-any.whl
Size	9.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e84955b24b3b6dad5ec09dcb6adbd6e31c2151a84134335187817531d0196b07`
BLAKE2b-256 checksum How to use checksums	`33f05c9c9392d7c22fb1760a60e2326edef0230ef8576d339f293aee32567d8b`
Upload date	Dec 5, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.12.0`