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[];
    requestHook?: HttpRequestCustomAttributeFunction;
    requireParentforIncomingSpans?: boolean;
    requireParentforOutgoingSpans?: boolean;
    responseHook?: HttpResponseCustomAttributeFunction;
    serverName?: string;
    startIncomingSpanHook?: StartIncomingSpanCustomAttributeFunction;
    startOutgoingSpanHook?: StartOutgoingSpanCustomAttributeFunction;
}

Hierarchy (View Summary)

Properties

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

Properties

OptionalapplyCustomAttributesOnSpan

applyCustomAttributesOnSpan?: HttpCustomAttributeFunction

Function for adding custom attributes after response is handled

OptionaldisableIncomingRequestInstrumentation

disableIncomingRequestInstrumentation?: boolean

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

OptionaldisableOutgoingRequestInstrumentation

disableOutgoingRequestInstrumentation?: boolean

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

Optionalenabled

enabled?: boolean

Whether to enable the plugin.

Default

true

Optional ExperimentalenableSyntheticSourceDetection

enableSyntheticSourceDetection?: boolean

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

OptionalheadersToSpanAttributes

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

Map the following HTTP headers to span attributes.

OptionalignoreIncomingRequestHook

ignoreIncomingRequestHook?: IgnoreIncomingRequestFunction

Not trace all incoming requests that matched with custom function

OptionalignoreOutgoingRequestHook

ignoreOutgoingRequestHook?: IgnoreOutgoingRequestFunction

Not trace all outgoing requests that matched with custom function

Optional ExperimentalredactedQueryParams

redactedQueryParams?: string[]

[Optional] Additional query parameters to redact. Use this to specify custom query strings that contain sensitive information. These will replace/overwrite the default query strings that are to be redacted.

Example

default strings ['sig','Signature','AWSAccessKeyId','X-Goog-Signature']
@experimental

OptionalrequestHook

requestHook?: HttpRequestCustomAttributeFunction

Function for adding custom attributes before request is handled

OptionalrequireParentforIncomingSpans

requireParentforIncomingSpans?: boolean

Require parent to create span for incoming requests

OptionalrequireParentforOutgoingSpans

requireParentforOutgoingSpans?: boolean

Require parent to create span for outgoing requests

OptionalresponseHook

responseHook?: HttpResponseCustomAttributeFunction

Function for adding custom attributes before response is handled

OptionalserverName

serverName?: string

The primary server name of the matched virtual host.

OptionalstartIncomingSpanHook

startIncomingSpanHook?: StartIncomingSpanCustomAttributeFunction

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

OptionalstartOutgoingSpanHook

startOutgoingSpanHook?: StartOutgoingSpanCustomAttributeFunction

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

Settings

Member Visibility

On This Page

Properties