Beignet API reference
    Preparing search index...

    Interface RequestProviderInstrumentationEvent

    HTTP request instrumentation emitted by server adapters.

    interface RequestProviderInstrumentationEvent {
        contractName?: string;
        details?: unknown;
        durationMs?: number;
        id?: string;
        method: string;
        parentSpanId?: string;
        path: string;
        requestId?: string;
        responseOwner?: "route" | "framework" | "transport" | "unknown";
        spanId?: string;
        stages?: {
            beforeHandleMs: number;
            contextMs: number;
            handlerMs: number;
            onRequestMs: number;
            parseMs: number;
            sendMs: number;
        };
        status?: number;
        summary?: string;
        timestamp?: string;
        traceId?: string;
        traceparent?: string;
        tracestate?: string;
        type: "request";
        watcher?: string;
    }

    Hierarchy (View Summary)

    Index
    contractName? details? durationMs? id? method parentSpanId? path requestId? responseOwner? spanId? stages? status? summary? timestamp? traceId? traceparent? tracestate? type watcher?
    contractName?: string

    Matched contract name, when known.

    details?: unknown

    Provider-specific structured details. Values are redacted before being recorded by createProviderInstrumentation(...).

    durationMs?: number

    Request duration in milliseconds.

    id?: string

    Optional event identifier supplied by the caller.

    method: string

    HTTP method.

    parentSpanId?: string

    Parent span identifier for nested operations.

    path: string

    Request path.

    requestId?: string

    Request correlation ID for events emitted during request handling.

    responseOwner?: "route" | "framework" | "transport" | "unknown"

    Which layer produced the response.

    spanId?: string

    Span identifier for the current operation.

    stages?: {
        beforeHandleMs: number;
        contextMs: number;
        handlerMs: number;
        onRequestMs: number;
        parseMs: number;
        sendMs: number;
    }

    Per-stage timing breakdown of the request pipeline, in milliseconds: onRequest hooks, request parsing, context creation, route hooks plus beforeHandle hooks, the handler, and response preparation.

    status?: number

    Response status code.

    summary?: string

    Human-readable summary for devtools lists.

    timestamp?: string

    ISO timestamp supplied by the caller. Devtools can also assign a timestamp when one is omitted.

    traceId?: string

    Trace identifier for distributed tracing integrations.

    traceparent?: string

    W3C traceparent header value, when available.

    tracestate?: string

    W3C tracestate value associated with the current operation.

    type: "request"
    watcher?: string

    Watcher category used by devtools and instrumentation sinks.

    Settings
    Member Visibility

    On This Page
    Properties