Setu-TS
    Preparing search index...

    Interface IDiagnosticsClient

    The native diagnostics client: performs the signed status pairing exchange automatically before the first data operation, then serves bounded snapshot and event reads.

    Calls are serialized and reserve unique, strictly increasing sequence numbers; a number is never reused, including after a network failure. Failed initial pairing is terminal: discard the client (and the session) and relaunch rather than accepting another server under the same identity. Once paired, every response is bound to the paired instance: its signed x-setu-instance header and any body instanceId must both equal it, so a peer holding the session key cannot answer as a different instance. Every body is then checked against its exact DTO before it is returned — the core snapshot and event batch included — and every result is deeply frozen.

    0.8.0

    interface IDiagnosticsClient {
        authorization(
            after: number,
            limit?: number,
        ): Promise<AuthorizationDiagnosticsBatch>;
        cache(): Promise<CacheDiagnosticsResponse>;
        close(): void;
        configuration(): Promise<ConfigDiagnosticsSnapshot>;
        events(): Promise<EventDiagnosticsResponse>;
        health(): Promise<HealthDiagnosticsSnapshot>;
        outboundHttp(): Promise<OutboundHttpDiagnosticsResponse>;
        queues(after: number, limit?: number): Promise<QueueDiagnosticsBatch>;
        read(after: number, limit?: number): Promise<DiagnosticsBatch>;
        realtime(): Promise<RealtimeDiagnosticsResponse>;
        renew(): Promise<DiagnosticsSessionLifetime>;
        scheduler(): Promise<SchedulerDiagnosticsResponse>;
        session(): Promise<DiagnosticsSessionLifetime>;
        snapshot(): Promise<DiagnosticsSnapshot>;
        storage(): Promise<StorageDiagnosticsResponse>;
        traces(after: number, limit?: number): Promise<TraceDiagnosticsBatch>;
    }
    Index
    authorization cache close configuration events health outboundHttp queues read realtime renew scheduler session snapshot storage traces

    • Reads the next bounded page of authorization decision explanations through the signed protocol (M98h). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      The cursor follows the M98a contract: 0 starts at the oldest retained decision, lost is per batch, and an empty page echoes the cursor. When the negotiated inspector manifest reports the authorization inspector as unsupported, a frozen typed unsupported batch echoing the cursor is returned WITHOUT sending an addon request.

      Parameters

      • after: number

        Sequence cursor; 0 starts at the oldest retained decision

      • Optionallimit: number

        Maximum decisions, 1–128 (default 128)

      Returns Promise<AuthorizationDiagnosticsBatch>

      The frozen authorization batch projection

      For invalid arguments, and under the same conditions as snapshot

      0.8.0

    • Reads every registered cache source's operation counters through the signed protocol (M98i). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      When the negotiated inspector manifest reports the cache inspector as unsupported, a frozen typed unsupported response with no sources is returned WITHOUT sending an addon request. Otherwise the authenticated /v1/cache exchange is performed and its exact contract validated. The response never carries a key, prefix, value, URL, factory result or error text.

      Returns Promise<CacheDiagnosticsResponse>

      The deeply frozen cache response

      Under the same conditions as snapshot

      0.8.0

    • Reads the value-free configuration provenance through the signed protocol (M98e). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      The inspector support manifest negotiated during pairing decides the answer: when it reports the configuration inspector as unsupported, a frozen typed unsupported snapshot is returned WITHOUT sending an addon request. When supported, the authenticated /v1/config exchange is performed and its exact DTO is validated before being returned. The snapshot never carries a configuration value, hash, length, or path.

      Returns Promise<ConfigDiagnosticsSnapshot>

      The frozen configuration provenance projection

      Under the same conditions as snapshot

      0.8.0

    • Reads the minimized event-dispatch observations through the signed protocol (M98j). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      The inspector support manifest negotiated during pairing decides the answer: when it reports the event inspector as unsupported, a frozen typed unsupported response is returned WITHOUT sending an addon request. When supported, the authenticated /v1/event exchange is performed and its exact DTO is validated before being returned. The response never carries an event type, payload, identifier, handler name or thrown value — only approved aliases and bounded counters.

      Returns Promise<EventDiagnosticsResponse>

      The frozen event-dispatch response projection

      Under the same conditions as snapshot

      0.8.0

    • Reads the minimized health observations through the signed protocol (M98d). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      The inspector support manifest negotiated during pairing decides the answer: when it reports the health inspector as unsupported, a frozen typed unsupported snapshot is returned WITHOUT sending an addon request. When supported, the authenticated /v1/health exchange is performed and its exact DTO is validated before being returned.

      Returns Promise<HealthDiagnosticsSnapshot>

      The frozen health snapshot projection

      Under the same conditions as snapshot

      0.8.0

    • Reads the minimized outbound HTTP attempt observations through the signed protocol (M98n). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      When the negotiated inspector manifest reports the outbound HTTP inspector as unsupported, a frozen typed unsupported response with no sources is returned WITHOUT sending an addon request. Otherwise the authenticated /v1/outbound-http exchange is performed and its exact contract — including every counting invariant — validated. The response never carries a URL, host, header, body, signal or error.

      Returns Promise<OutboundHttpDiagnosticsResponse>

      The deeply frozen outbound HTTP response

      Under the same conditions as snapshot

      0.8.0

    • Reads the next bounded page of queue attempt observations, plus every queue source's status and latest depths, through the signed protocol (M98f). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      The cursor is the connector's merge cursor: 0 starts at the oldest retained attempt, and the returned next continues from there. When the negotiated inspector manifest reports the queue inspector as unsupported, a frozen typed unsupported batch echoing the cursor is returned WITHOUT sending an addon request.

      Parameters

      • after: number

        Merge cursor; 0 starts at the oldest retained attempt

      • Optionallimit: number

        Maximum attempts, 1–128 (default 128)

      Returns Promise<QueueDiagnosticsBatch>

      The frozen queue batch projection

      For invalid arguments, and under the same conditions as snapshot

      0.8.0

    • Reads the next bounded batch of execution events after after.

      The body must match the M98a batch DTO, with consecutive event sequences and next equal to the last one, and must honor the cursor this call sent: at most limit events, an empty page echoes after with no loss, and a returned page starts past after with lost counting exactly the unreadable gap (evicted, or discarded by a failed start). An event statusCode is left unranged, as the application set it: any finite number, not necessarily a valid HTTP status (the kernel omits a non-finite one).

      Parameters

      • after: number

        Sequence cursor; 0 starts at the oldest retained record

      • Optionallimit: number

        Maximum events, 1–128 (default 128)

      Returns Promise<DiagnosticsBatch>

      The deeply frozen M98a event batch (every event included)

      Under the same conditions as snapshot

    • Reads the minimized realtime lifecycle observations through the signed protocol (M98l). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      When the negotiated inspector manifest reports the realtime inspector as unsupported, a frozen typed unsupported response with no sources is returned WITHOUT sending an addon request. Otherwise the authenticated /v1/realtime exchange is performed and its exact contract — including the kind/operation and kind/gauge combinations — validated. The response never carries a frame, message, close reason, room or channel name, connection id, header, principal or backplane origin.

      Returns Promise<RealtimeDiagnosticsResponse>

      The deeply frozen realtime response

      Under the same conditions as snapshot

      0.8.0

    • Extends the current session window without changing its key, session ID, instance binding, or sequence space. An unpaired client pairs first. If the authenticated status did not advertise renewal, this throws locally without sending a renewal request.

      Schedule this call with margin, normally after half of expiresInMs.

      Returns Promise<DiagnosticsSessionLifetime>

      The frozen authenticated lifetime after renewal

      When renewal is unsupported or under the same conditions as snapshot

      0.8.0

    • Reads every registered scheduler source's execution observations through the signed protocol (M98k). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      When the negotiated inspector manifest reports the scheduler inspector as unsupported, a frozen typed unsupported response with no sources is returned WITHOUT sending an addon request. Otherwise the authenticated /v1/scheduler exchange is performed and its exact contract validated. The response never carries a job name, cron expression, payload, lock key or token, or error text; a fire observation never claims cluster completeness.

      Returns Promise<SchedulerDiagnosticsResponse>

      The deeply frozen scheduler response

      Under the same conditions as snapshot

      0.8.0

    • Reads the current application-composition snapshot through the signed protocol. Performs the /v1/status pairing exchange first if the session has not yet been bound to the application instance.

      The body must match the M98a snapshot DTO: only the defined keys, every enum from its fixed vocabulary, each node carrying only its kind's fields under a unique id minted with its kind's prefix, labels bounded and free of control characters, and every edge joining two nodes in the same snapshot, once. A middleware priority is left unranged, as the DTO types it: any finite number (the kernel omits a non-finite one).

      Returns Promise<DiagnosticsSnapshot>

      The deeply frozen M98a snapshot projection (nodes and edges included)

      When the client is closed, pairing failed terminally, the response cannot be verified, or the peer violates the protocol

    • Reads every registered storage source's operation counters through the signed protocol (M98m). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      When the negotiated inspector manifest reports the storage inspector as unsupported, a frozen typed unsupported response with no sources is returned WITHOUT sending an addon request. Otherwise the authenticated /v1/storage exchange is performed and its exact contract validated. The response never carries a path, byte, metadata entry, content type, signed URL, credential or error text.

      Returns Promise<StorageDiagnosticsResponse>

      The deeply frozen storage response

      Under the same conditions as snapshot

      0.8.0

    • Reads the next bounded page of completed, sampled span observations through the signed protocol (M98g). Performs the /v1/status pairing exchange first if the session has not yet been bound.

      The cursor follows the M98a contract: 0 starts at the oldest retained span, lost is per batch, and an empty page echoes the cursor. When the negotiated inspector manifest reports the trace inspector as unsupported, a frozen typed unsupported batch echoing the cursor is returned WITHOUT sending an addon request.

      Parameters

      • after: number

        Sequence cursor; 0 starts at the oldest retained span

      • Optionallimit: number

        Maximum spans, 1–128 (default 128)

      Returns Promise<TraceDiagnosticsBatch>

      The frozen trace batch projection

      For invalid arguments, and under the same conditions as snapshot

      0.8.0

    Settings
    Member Visibility

    On This Page
    Methods