Version 3.21

Changes

• Resolve settings inconsistency (by removing them).
• Simplify implementation to improve maintainability.
• Deprecate and remove duplicate or outdated checks.

Motivation

Settings inconsistency has long been an issue of this package. Some use package dictionaries; some use single-value settings.

Over time this package has also accumulated a host of checks, some of which are outdated or similar or superior to others.

Migration Guide

1. Remove these health_check.* sub‑apps from INSTALLED_APPS but keep health_check!

2. Remove all HEALTH_CHECK_* settings from your settings file.

3. Replace the URL include with the view and explicit checks list.
   Before:

   # urls.py
   path("ht/", include("health_check.urls"))

   After (example):

   # urls.py
   from health_check.views import HealthCheckView
   
   path(
       "ht/",
       HealthCheckView.as_view(
           checks=[
               "health_check.Cache",
               "health_check.Database",
               "health_check.Disk",
               "health_check.Mail",
               "health_check.Memory",
               "health_check.Storage",
               # 3rd party checks
               "health_check.contrib.celery.Ping",
               "health_check.contrib.rabbitmq.RabbitMQ",
               "health_check.contrib.redis.Redis",
           ]
       ),
   )

Removals and Replacements

• StorageHealthCheck, DefaultFileStorageHealthCheck, S3BotoStorageHealthCheck, S3Boto3StorageHealthCheck have been replaced with Storage.
• CeleryHealthCheck has been replaced with Ping.
• MigrationsHealthCheck has been removed; its functionality is covered by Django's check framework.
• DatabaseHealthCheck has been replaced with Database which doesn't require a table and supports multiple database aliases.

Full Changelog: 3.20.8...3.21.0