Stone.js API
    Preparing search index...

    Interface HealthOptions

    How the health probe is configured (stone.telemetry.health.*).

    interface HealthOptions {
        checks?: MetaHealthCheck[];
        path?: string | false;
        timeout?: number;
    }
    Index
    checks? path? timeout?
    checks?: MetaHealthCheck[]

    The registered checks. Modules and applications add to this list.

    path?: string | false

    Where the probe answers. Default /health, false to serve nothing.

    A probe is an inbound question from something that cannot read a log: a load balancer deciding whether to route traffic, a platform deciding whether to replace an instance.

    timeout?: number

    How long a single check may take before it counts as failed. Default 2000ms.

    Settings
    Member Visibility

    On This Page
    Properties