Health Check Endpoint

[mohamedachrefhacheni]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched in the documentation/README.
• I already searched in Google "How to do X" and didn't find any information.
• I already read and followed all the tutorial in the docs/README and didn't find an answer.

Commit to Help

• I commit to help with one of those options 👆

Example Code

# More detailed health check example
@app.get("/health")
async def health_check(
    db: AsyncSession = Depends(get_db),
    cache: Redis = Depends(get_redis)
):
    services = {
        "database": await check_db(db),
        "cache": await check_redis(cache),
        "storage": check_disk_space()
    }
    return services

Description

This discussion covers the design, implementation, and future considerations for the new /health endpoint, which provides critical visibility into service status. Key topics include:

Purpose & Motivation
Why health checks are essential for monitoring, orchestration (Kubernetes), and load balancing
Alignment with DevOps/SRE best practices

Technical Design Choices
Placement at root level (/health) vs. versioned path
Minimalist response format vs. extended diagnostics
Database connectivity verification approach

Operating System

Windows

Operating System Details

windows11

Python Version

3.12.1

Additional Context

No response