Migration to version 4.x

Important

Version 3.21 started to deprecate the old settings, checks, and APIs. Versions 3.21 and later still support the old and new configuration styles. Thus the migration is easier.

1. If you have health_check.db in your INSTALLED_APPS, revert the migration to remove the TestModel table:

   python manage.py migrate db zero
   

2. Update the dependencies. Include the extras for the checks you want to use.

   uv add 'django-health-check[psutil,celery,kafka,rabbitmq,redis,rss,atlassian]>=4.0.0'
   

3. Remove these health_check.* sub-apps from INSTALLED_APPS. Do not remove health_check.

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

5. 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.Mail",
               "health_check.Storage",
               # 3rd party checks
               "health_check.contrib.psutil.Disk",
               "health_check.contrib.psutil.Memory",
               "health_check.contrib.celery.Ping",
               "health_check.contrib.rabbitmq.RabbitMQ",
               "health_check.contrib.redis.Redis",
           ]
       ),
       name="health_check",
   )
   

Removals and Replacements

• The classes StorageHealthCheck, DefaultFileStorageHealthCheck, S3BotoStorageHealthCheck, and S3Boto3StorageHealthCheck are replaced with Storage.
• CeleryHealthCheck is replaced with Ping.
• MigrationsHealthCheck is removed. Django's check framework does the same function.
• DatabaseHealthCheck is replaced with Database. It does not require a table. It supports multiple database aliases.