django-health

Configure Django health checks via the django-health-check library for container readiness and liveness probes.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/carlos-ASG/tu-voz-en-ruta --skill django-health
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: django-health
Source: https://github.com/carlos-ASG/tu-voz-en-ruta/tree/main/skills/django-health
Command: npx skills add https://github.com/carlos-ASG/tu-voz-en-ruta --skill django-health

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Django health checks provide a standardized way to expose endpoints that report the health and readiness of a Django application, enabling container orchestration, monitoring systems, and proactive incident response.

Core Features & Use Cases

  • Built-in checks: database connectivity, migrations status, cache and storage availability.
  • Pluggable architecture: add custom checks and integrate with existing health checks.
  • Output formats: JSON and HTML endpoints suitable for monitoring systems.
  • Public schema readiness: ensure health endpoints are accessible without tenant scoping to support Docker/Kubernetes readiness probes.
  • Use Case: Deploying a Django app in Kubernetes, using health endpoints to drive liveness/readiness probes and alerting.

Quick Start

Install django-health-check with pip, register the apps in INSTALLED_APPS, expose the public URLs in urls_public.py, and test with curl the health endpoint at /health/.

Frequently Asked Questions about django-health

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I expose Django health checks for Kubernetes readiness and liveness probes?

Expose Django health checks by installing django-health-check via pip, registering it in INSTALLED_APPS, and wiring public URLs to output JSON or HTML endpoints that report application readiness for Kubernetes liveness probes.

What does a Django health check endpoint monitor for containerized applications?

A Django health check endpoint monitors database connectivity, migration status, cache availability, and storage health, providing a standardized report that monitoring systems and container orchestrators use to trigger proactive incident response.

Can I add custom health checks to my Django application monitoring?

You can add custom health checks to Django application monitoring using the django-health-check pluggable architecture, allowing integration with existing checks to extend endpoint coverage beyond built-in database, cache, and storage availability reporting.

Does django-health-check work with Docker and Kubernetes deployments?

django-health-check works with Docker and Kubernetes deployments by exposing public health endpoints accessible without tenant scoping, specifically designed to satisfy container orchestration readiness probes and monitoring system requirements.

How do I set up a Django health endpoint for monitoring systems?

Set up a Django health endpoint by installing django-health-check with pip, registering the apps in INSTALLED_APPS, exposing public URLs in urls_public.py, and testing the health endpoint output with curl at the /health/ path.