Fast Healthchecks¶

Framework-agnostic health checks with integrations for the most popular ASGI frameworks: FastAPI / FastStream / Litestar to help you implement the Health Check API pattern.

Documentation¶

• Installation — install with pip, poetry, or uv; optional extras.
• Usage — mount health checks per framework; examples (FastAPI, FastStream, Litestar).
• Lifecycle and shutdown — closing cached clients on app shutdown; ProbeRunner for advanced control.
• Probe options — probe parameters and build_probe_route_options.
• Running probes without ASGI — run_probe for CLI, cron, tests.
• Configuration objects — config argument and types in fast_healthchecks.checks.configs.
• URL check and SSRF protection — block_private_hosts for UrlHealthCheck.
• DSN formats — URL schemes for from_dsn(); PostgreSQL TLS certificate rotation.

For API reference (configs, check classes, public API boundary), see API Reference.

Additional Resources¶

• Changelog — release history and changes.
• Style guide — code style conventions.
• Contributing — how to contribute to the project.
• Security — security policy and guidelines.
• Decisions — architectural decision records.