OpenTelemetry SDK
    Preparing search index...

    Interface HttpInstrumentationConfig

    Options available for the HTTP instrumentation (see documentation)

    interface HttpInstrumentationConfig {
        applyCustomAttributesOnSpan?: HttpCustomAttributeFunction;
        disableIncomingRequestInstrumentation?: boolean;
        disableOutgoingRequestInstrumentation?: boolean;
        enabled?: boolean;
        enableSyntheticSourceDetection?: boolean;
        headersToSpanAttributes?: {
            client?: { requestHeaders?: string[]; responseHeaders?: string[] };
            server?: { requestHeaders?: string[]; responseHeaders?: string[] };
        };
        ignoreIncomingRequestHook?: IgnoreIncomingRequestFunction;
        ignoreOutgoingRequestHook?: IgnoreOutgoingRequestFunction;
        redactedQueryParams?: string[];
        redactedQueryParamsServer?: string[];
        requestHook?: HttpRequestCustomAttributeFunction;
        requireParentforIncomingSpans?: boolean;
        requireParentforOutgoingSpans?: boolean;
        responseHook?: HttpResponseCustomAttributeFunction;
        serverName?: string;
        startIncomingSpanHook?: StartIncomingSpanCustomAttributeFunction;
        startOutgoingSpanHook?: StartOutgoingSpanCustomAttributeFunction;
    }

    Hierarchy (View Summary)

    Index
    applyCustomAttributesOnSpan? disableIncomingRequestInstrumentation? disableOutgoingRequestInstrumentation? enabled? enableSyntheticSourceDetection? headersToSpanAttributes? ignoreIncomingRequestHook? ignoreOutgoingRequestHook? redactedQueryParams? redactedQueryParamsServer? requestHook? requireParentforIncomingSpans? requireParentforOutgoingSpans? responseHook? serverName? startIncomingSpanHook? startOutgoingSpanHook?
    applyCustomAttributesOnSpan?: HttpCustomAttributeFunction

    Function for adding custom attributes after response is handled

    disableIncomingRequestInstrumentation?: boolean

    If set to true, incoming requests will not be instrumented at all.

    disableOutgoingRequestInstrumentation?: boolean

    If set to true, outgoing requests will not be instrumented at all.

    enabled?: boolean

    Whether to enable the plugin.

    true
    enableSyntheticSourceDetection?: boolean

    Enable automatic population of synthetic source type based on the user-agent header

    headersToSpanAttributes?: {
        client?: { requestHeaders?: string[]; responseHeaders?: string[] };
        server?: { requestHeaders?: string[]; responseHeaders?: string[] };
    }

    Map the following HTTP headers to span attributes.

    ignoreIncomingRequestHook?: IgnoreIncomingRequestFunction

    Do not trace incoming requests for which this function returns true.

    ignoreOutgoingRequestHook?: IgnoreOutgoingRequestFunction

    Do not trace outgoing requests for which this function returns true.

    redactedQueryParams?: string[]

    [Optional] Query parameters to redact on outgoing (client) spans. Use this to specify custom query strings that contain sensitive information. These will replace/overwrite the default query strings that are to be redacted. When omitted, defaults to a built-in list of known sensitive parameter names; see the package README for the current list. Set to an empty array to disable client-side query parameter redaction entirely.

    redactedQueryParamsServer?: string[]

    [Optional] Query parameters to redact on incoming (server) spans. When omitted, defaults to a built-in list of known sensitive parameter names; see the package README for the current list. Set to an empty array to disable server-side query parameter redaction entirely.

    requestHook?: HttpRequestCustomAttributeFunction

    Function for adding custom attributes before request is handled

    requireParentforIncomingSpans?: boolean

    Require parent to create span for incoming requests

    requireParentforOutgoingSpans?: boolean

    Require parent to create span for outgoing requests

    responseHook?: HttpResponseCustomAttributeFunction

    Function for adding custom attributes before response is handled

    serverName?: string

    The primary server name of the matched virtual host.

    No longer used. Stable HTTP semantic conventions do not include the http.server_name attribute; this option has no effect.

    startIncomingSpanHook?: StartIncomingSpanCustomAttributeFunction

    Function for adding custom attributes before a span is started in incomingRequest

    startOutgoingSpanHook?: StartOutgoingSpanCustomAttributeFunction

    Function for adding custom attributes before a span is started in outgoingRequest

    Settings
    Member Visibility

    On This Page
    Properties