Optional
allowlistList of URLs/paths that should be instrumented.
Note that when used for an http client the entry represents a full
outbound URL (https://example.org/api/foo
) but when used as a
server the entry represents an inbound path (/api/foo
).
/^.*$/
Optional
blocklistList of URLs/paths that should not be instrumented. Takes precedence over allowlist if a URL matches an entry in both.
Note that when used for an http client the entry represents a full
outbound URL (https://example.org/api/foo
) but when used as a
server the entry represents an inbound path (/api/foo
).
[]
Optional
enabledWhether to enable the plugin.
true
Optional
headersAn array of headers to include in the span metadata.
[]
Optional
hooksHooks to run before spans are finished.
Optional
request?: ((span?, req?, res?) => any)Hook to execute just before the request span finishes.
Optional
measuredWhether to measure the span. Can also be set to a key-value pair with span names as keys and booleans as values for more granular control.
Optional
middlewareWhether to enable instrumentation of
true
Optional
serviceThe service name to be used for this plugin.
Optional
validateCallback function to determine if there was an error. It should take a
status code as its only parameter and return true
for success or false
for errors.
Callback function to determine if there was an error. It should take a
status code as its only parameter and return true
for success or false
for errors.
code => code < 500
code => code < 500
Generated using TypeDoc
This plugin automatically instruments the connect module.