traceperf
    Preparing search index...

    Interface InstrumentMethodsOptions

    Options for a single tracked function or call. Anything left out falls back to the instance configuration at the time of the call.

    interface InstrumentMethodsOptions {
        captureArgs?: boolean;
        enableNestedTracking?: boolean;
        label?: string;
        labelFor?: (method: string, args: unknown[]) => string;
        parentExecutionId?: string | null;
        prefix?: string;
        sampleRate?: number;
        silent?: boolean;
        threshold?: number;
        trackingMode?: TrackingModeName;
        trackMemory?: boolean;
    }

    Hierarchy (View Summary)

    Index
    captureArgs? enableNestedTracking? label? labelFor? parentExecutionId? prefix? 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)

    label?: string

    Label shown in output and stats (default: the function name)

    labelFor?: (method: string, args: unknown[]) => string

    Compute the label per call, e.g. from the SQL text

    parentExecutionId?: string | null

    Attach this call to a specific parent execution

    prefix?: string

    Label prefix, e.g. "pg." (default: the constructor name of target plus ".")

    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