Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HttpInstrumentationConfig

Options available for the HTTP instrumentation (see documentation)

Hierarchy

Index

Properties

Properties

Optional applyCustomAttributesOnSpan

applyCustomAttributesOnSpan?: HttpCustomAttributeFunction

Function for adding custom attributes after response is handled

Optional headersToSpanAttributes

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

Map the following HTTP headers to span attributes.

Type declaration

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

Optional ignoreIncomingPaths

ignoreIncomingPaths?: IgnoreMatcher[]

Not trace all incoming requests that match paths

deprecated

use ignoreIncomingRequestHook instead

Optional ignoreIncomingRequestHook

ignoreIncomingRequestHook?: IgnoreIncomingRequestFunction

Not trace all incoming requests that matched with custom function

Optional ignoreOutgoingRequestHook

ignoreOutgoingRequestHook?: IgnoreOutgoingRequestFunction

Not trace all outgoing requests that matched with custom function

Optional ignoreOutgoingUrls

ignoreOutgoingUrls?: IgnoreMatcher[]

Not trace all outgoing requests that match urls

deprecated

use ignoreOutgoingRequestHook instead

Optional requestHook

requestHook?: HttpRequestCustomAttributeFunction

Function for adding custom attributes before request is handled

Optional requireParentforIncomingSpans

requireParentforIncomingSpans?: boolean

Require parent to create span for incoming requests

Optional requireParentforOutgoingSpans

requireParentforOutgoingSpans?: boolean

Require parent to create span for outgoing requests

Optional responseHook

responseHook?: HttpResponseCustomAttributeFunction

Function for adding custom attributes before response is handled

Optional serverName

serverName?: string

The primary server name of the matched virtual host.

Optional startIncomingSpanHook

startIncomingSpanHook?: StartIncomingSpanCustomAttributeFunction

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

Optional startOutgoingSpanHook

startOutgoingSpanHook?: StartOutgoingSpanCustomAttributeFunction

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

Generated using TypeDoc