traceperf
    Preparing search index...

    Interface HttpServerInstrumentOptions

    interface HttpServerInstrumentOptions {
        captureArgs?: boolean;
        enableNestedTracking?: boolean;
        errorStatus?: number;
        ignore?: (req: { method?: string; url?: string }) => boolean;
        labelFor?: (
            req: {
                headers?: Record<string, unknown>;
                method?: string;
                url?: string;
            },
        ) => string;
        parentExecutionId?: string
        | null;
        sampleRate?: number;
        silent?: boolean;
        threshold?: number;
        trackingMode?: TrackingModeName;
        trackMemory?: boolean;
    }

    Hierarchy (View Summary)

    Index
    captureArgs? enableNestedTracking? errorStatus? ignore? labelFor? parentExecutionId? sampleRate? silent? threshold? trackingMode? trackMemory?
    captureArgs?: boolean

    Include a short rendering of the arguments in output and records

    enableNestedTracking?: boolean

    Attach tracked calls made inside this one as children (default true)

    errorStatus?: number

    Treat HTTP responses with status >= this as failed (default 500)

    ignore?: (req: { method?: string; url?: string }) => boolean

    Skip requests for which this returns true, e.g. health checks

    labelFor?: (
        req: {
            headers?: Record<string, unknown>;
            method?: string;
            url?: string;
        },
    ) => string

    Label for a request (default "GET /users/:id", ids collapsed by normalizePath)

    parentExecutionId?: string | null

    Attach this call to a specific parent execution

    sampleRate?: number

    Fraction of calls to track (0.0 - 1.0)

    silent?: boolean

    Suppress console output for this call

    threshold?: number

    Only report this call if it takes at least this many milliseconds

    trackingMode?: TrackingModeName

    Tracking mode for this call

    trackMemory?: boolean

    Record the heap change for this call

    Settings
    Member Visibility

    On This Page
    Properties