読み方のヒント

矢印ボタン(または ← → キー)でページを移動できます。

第3節 状態確認とログ

3.1 /health を作る

health.py に、状態を確かめるAPIを作ります。

@router.get("/health")
def health(session: Annotated[Session, Depends(get_session)]):
    try:
        session.execute(text("SELECT 1"))
    except OperationalError:
        return JSONResponse(status_code=503, content={"status": "error", "database": "unavailable"})
    return {"status": "ok", "database": "ok"}

SELECT 1 は、表を読まずに、データベースに接続できるかだけを確かめるSQLです。

状態応答
APIもデータベースも動いている200、{"status": "ok", "database": "ok"}
データベースに接続できない503、{"status": "error", "database": "unavailable"}
APIが止まっている接続できない(応答がない)

この入口を、決まった間隔で開く仕組み(公開先のサービスの機能など)に登録しておくと、503 や接続の失敗のときに気づけます。

/health の応答には、データベースの接続先や、エラーの詳しい文を入れません。誰でも開ける入口なので、中の作りが分かる情報を出さないためです。

10 / 20