Iskra API Reference
    Preparing search index...

    Interface HealthReport

    What a health endpoint found, for a custom HealthCheckConfig.body.

    interface HealthReport {
        checks: Record<
            string,
            { status: "ok"
            | "error"; [key: string]: unknown },
        >;
        endpoint: "health" | "ready" | "live";
        failed: string[];
        ok: boolean;
        timestamp: string;
        uptime: number;
    }
    Index
    checks endpoint failed ok timestamp uptime
    checks: Record<string, { status: "ok" | "error"; [key: string]: unknown }>

    Each check by name: the db/cache probes and checks for health, the readiness checks for ready, none for live. A custom check's result is kept as it returned it.

    endpoint: "health" | "ready" | "live"

    The endpoint: path (health), readinessPath (ready) or livenessPath (live).

    failed: string[]

    The names of the checks that failed.

    ok: boolean

    Whether every check passed: the endpoint answers 200, otherwise 503.

    timestamp: string

    ISO 8601 time of the report.

    uptime: number

    Seconds the process has been running.

    Settings
    Member Visibility

    On This Page
    Properties