Skip to content

Health Router

Health check and monitoring endpoints for service status.

health

Attributes

__all__ = ['router'] module-attribute

router = DiracxRouter(require_auth=False, include_in_schema=False) module-attribute

Classes

Health Probes

probes

Health probes for use in Kubernetes and other orchestration systems.

Attributes

__all__ = ['router'] module-attribute

router = DiracxRouter(require_auth=False) module-attribute

Classes

Functions

liveness(config) async

Returns a simple status to indicate the app is running.

The method doesn't use the config but we want to depend on it so the check fails if the config expires without managing to refresh.

Source code in diracx-routers/src/diracx/routers/health/probes.py 
16
17
18
19
20
21
22
23
24
@router.get("/live", include_in_schema=False)
async def liveness(config: Config):
    """Returns a simple status to indicate the app is running.

    The method doesn't use the config but we want to depend on it so the check
    fails if the config expires without managing to refresh.
    """
    assert config  # Depend on the config so we know it's loaded successfully
    return JSONResponse(content={"status": "live"})

ready(config, auth_db) async

Readiness endpoint.

Checks if at least the configuration is loaded and the AuthDB database connection is available.

Source code in diracx-routers/src/diracx/routers/health/probes.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
@router.get("/ready", include_in_schema=False)
async def ready(config: Config, auth_db: AuthDB):
    """Readiness endpoint.

    Checks if at least the configuration is loaded and the AuthDB database
    connection is available.
    """
    assert config  # Depend on the config so we know it's loaded successfully
    try:
        await auth_db.ping()
    except Exception as e:
        raise HTTPException(status_code=503, detail="AuthDB ping failed") from e
    return JSONResponse(content={"status": "ready"})

startup(config, auth_db) async

Startup endpoint.

Checks if at least the configuration is loaded and the AuthDB database connection is available.

Source code in diracx-routers/src/diracx/routers/health/probes.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
@router.get("/startup", include_in_schema=False)
async def startup(config: Config, auth_db: AuthDB):
    """Startup endpoint.

    Checks if at least the configuration is loaded and the AuthDB database
    connection is available.
    """
    assert config  # Depend on the config so we know it's loaded successfully
    try:
        await auth_db.ping()
    except Exception as e:
        raise HTTPException(status_code=503, detail="AuthDB ping failed") from e
    return JSONResponse(content={"status": "startup complete"})