Setu-TS
    Preparing search index...

    Interface RealtimeObservationCollectorInit

    How a plugin constructs its collector.

    0.8.0

    interface RealtimeObservationCollectorInit {
        alias: string | null;
        clock: () => number;
        gauges?: () => RealtimeGaugeReading;
        kind: RealtimeSourceKind;
    }
    Index
    alias clock gauges? kind
    alias: string | null

    The alias compileRealtimeDiagnosticsAlias returned, or null when the plugin was not opted in (the collector is then inert and answers disabled).

    clock: () => number

    The runtime's monotonic clock in milliseconds (runtime.hrtime).

    gauges?: () => RealtimeGaugeReading

    Reads the plugin's OWN service's size getters. Required for websocket and sse; ignored for backplane, which has no gauges. Called only by snapshot() on an enabled, healthy source, and released by close().

    kind: RealtimeSourceKind

    The kind of component the plugin owns; fixed for the collector's life.

    Settings
    Member Visibility

    On This Page
    Properties