Setu-TS
    Preparing search index...

    Interface IRealtimeObservationCollector

    The collector a realtime plugin attaches to its component. It answers snapshot() itself; the plugin registers its frozen source facade, which exposes snapshot() alone.

    Every entry point is non-throwing and never changes the application's result: a failing clock or gauge reader latches collection-failed, clears the records and stops capture until the plugin is recreated.

    0.8.0

    interface IRealtimeObservationCollector {
        enabled: boolean;
        source: IRealtimeDiagnosticsSource;
        close(): void;
        observe(
            operation: RealtimeObservationOperation,
            succeeded: boolean,
            backpressure?: boolean,
        ): void;
        observePublish<T>(call: () => Promise<T>): Promise<T>;
        snapshot(): RealtimeDiagnosticsSnapshot;
    }

    Hierarchy (View Summary)

    Index
    enabled source
    close observe observePublish snapshot
    enabled: boolean

    true when opted in and not yet closed; a capture site skips work when false.

    source: IRealtimeDiagnosticsSource

    The frozen, snapshot-only facade a plugin registers under CAPABILITIES.REALTIME_DIAGNOSTICS. Registering the collector itself would hand every registry reader its observe and close.

    • Runs one backplane publication and records it as backplane-publish with its duration. The returned promise settles with the SAME value or the SAME rejection reason as the call's, so an unhandled rejection stays unhandled. A synchronous throw is recorded as failed and rethrown.

      Type Parameters

      • T

      Parameters

      • call: () => Promise<T>

        Invokes the transport's publish

      Returns Promise<T>

      A promise derived from the call's

    Settings
    Member Visibility

    On This Page
    Properties
    Methods