fastapi-healthchecks

What it is and what it does

fastapi-healthchecks is a FastAPI extension that registers health check endpoints in your application. It lets you define named probes (like 'readiness' and 'liveness') that run a collection of checks against external dependencies—databases, caches, message brokers, and HTTP services—and report their status via GET endpoints. The package includes built-in checks for PostgreSQL, Redis, RabbitMQ, Ceph, HTTP endpoints, and Pydantic settings validation, and you can extend it with custom Check implementations.

The package depends on fastapi, pydantic, and pydantic-settings. It installs as a pure Python wheel with low friction. Maintenance is dormant (last release February 2024, 925 days ago), but it supports current Python versions (3.10–3.12) and has no known vulnerabilities. It is most useful in containerized or orchestrated environments where external health check endpoints are expected.

Use it for:

• Kubernetes liveness and readiness probes: expose /health/liveness and /health/readiness endpoints for pod health monitoring.
• Database and cache dependency checks: verify PostgreSQL, Redis, or RabbitMQ connectivity at startup or on demand.
• Custom dependency validation: implement checks for internal services, feature flags, or configuration state via the Check interface.
• Load balancer health checks: provide HTTP endpoints for upstream services to determine if the application is ready to receive traffic.
• Monitoring and alerting: expose structured health status for scraping by monitoring systems or dashboards.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Adds configurable health check endpoints to FastAPI applications, supporting checks for PostgreSQL, Redis, RabbitMQ, HTTP endpoints, Ceph, and custom implementations.

Yes, if you need health check endpoints for a FastAPI application and are comfortable with dormant maintenance. The package is stable, has no vulnerabilities, and the core functionality (routing probes and running checks) is unlikely to break. Install it if you are building containerized services or need Kubernetes-compatible health endpoints; skip it if you require active maintenance or expect frequent updates to the check implementations.

Install

fastapi-healthchecks on PyPI

pip install fastapi-healthchecks

uv add fastapi-healthchecks

poetry add fastapi-healthchecks

Installing fastapi-healthchecks

Before you install

Low install friction with a pure-Python wheel. Dormant maintenance status (925 days since last release) means no active development, but the package targets current Python versions (3.10–3.12) and carries no known vulnerabilities.

License in practice

MIT license is permissive; you can use, modify, and distribute this package freely in commercial and private projects with minimal restrictions.

Quickstart

pip install fastapi-healthchecks

from fastapi import FastAPI
from fastapi_healthchecks import HealthcheckRouter, Probe, PostgreSqlCheck

app = FastAPI()
app.include_router(
    HealthcheckRouter(
        Probe(name="readiness", checks=[PostgreSqlCheck(host="db.example.com", username="user", password="pass")])
    ),
    prefix="/health"
)

Verify before relying

• Whether bundled checks (PostgreSQL, Redis, RabbitMQ, Ceph, HTTP) require additional system libraries or network access to function.
• Whether the package is actively maintained despite dormant status, or if it is effectively abandoned.
• Performance characteristics when running many concurrent health checks.

Package facts

Evidence: fastapi_healthchecks-1.1.0-py3-none-any.whl

Keywords: fastapi, healthcheck

Tags

More Monitoring packages