Optional
allowlistList of URLs that should be instrumented.
/^.*$/
Optional
blocklistList of URLs that should not be instrumented. Takes precedence over allowlist if a URL matches an entry in both.
[]
Optional
enableEnable injection of tracing headers into requests signed with AWS IAM headers. Disable this if you get AWS signature errors (HTTP 403).
false
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 restify module.