Documentation
    Preparing search index...

    Interface IBenchmarkEvent

    One benchmarked request as the servant observed it.

    metadata is the fetch route, status is the HTTP status or null when there was no response, and the three timestamps are ISO 8601 strings, with respond_at null when no response arrived. success is false for every request made by a benchmark function that threw.

    contracts/common.md#principled-implementation The event mirrors the fetcher's log event with timestamps in ISO strings, so it can cross the process boundary as plain data.

    contracts/common.md#clear-and-simple-design A flat record shared by the servant, the master, and the report code.

    contracts/common.md#prohibited-implementation-shortcuts Route, status and times come from the fetcher's event; success records whether the enclosing benchmark function threw, independent of HTTP status.

    contracts/common.md#meaningful-documentation The comment states each optional state and the meaning of success.

    interface IBenchmarkEvent {
        completed_at: string;
        metadata: IFetchRoute<any>;
        respond_at: string | null;
        started_at: string;
        status: number | null;
        success: boolean;
    }
    Index
    completed_at metadata respond_at started_at status success
    completed_at: string

    ISO 8601 time when the request completed or failed.

    metadata: IFetchRoute<any>

    Fetch route, including its concrete path and optional grouping template.

    respond_at: string | null

    ISO 8601 response time, or null when no response arrived.

    started_at: string

    ISO 8601 time when the request started.

    status: number | null

    HTTP status, or null when the request received no response.

    success: boolean

    Whether the enclosing benchmark function completed without throwing.

    Settings
    Member Visibility

    On This Page
    Properties