Interface express

This plugin automatically instruments the express module.

interface express {
    allowlist?: string | RegExp | ((urlOrPath) => boolean) | (string | RegExp | ((urlOrPath) => boolean))[];
    blocklist?: string | RegExp | ((urlOrPath) => boolean) | (string | RegExp | ((urlOrPath) => boolean))[];
    enabled?: boolean;
    headers?: string[];
    hooks?: {
        request?: ((span?, req?, res?) => any);
    };
    measured?: boolean | {
        [key: string]: boolean;
    };
    middleware?: boolean;
    service?: any;
    validateStatus?: ((code) => boolean);
}

Hierarchy

  • HttpServer
    • express

Properties

allowlist? blocklist? enabled? headers? hooks? measured? middleware? service? validateStatus?

Properties

Optional allowlist

allowlist?: string | RegExp | ((urlOrPath) => boolean) | (string | RegExp | ((urlOrPath) => boolean))[]

List 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).

Type declaration

    • (urlOrPath): boolean

    • Parameters

      • urlOrPath: string

      Returns boolean

Default

/^.*$/

Optional blocklist

blocklist?: string | RegExp | ((urlOrPath) => boolean) | (string | RegExp | ((urlOrPath) => boolean))[]

List 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).

Type declaration

    • (urlOrPath): boolean

    • Parameters

      • urlOrPath: string

      Returns boolean

Default

[]

Optional enabled

enabled?: boolean

Whether to enable the plugin.

Default

true

Optional headers

headers?: string[]

An array of headers to include in the span metadata.

Default

[]

Optional hooks

hooks?: {
    request?: ((span?, req?, res?) => any);
}

Hooks to run before spans are finished.

Type declaration

  • Optional request?: ((span?, req?, res?) => any)

    Hook to execute just before the request span finishes.

      • (span?, req?, res?): any

      • Hook to execute just before the request span finishes.

        Parameters

        • Optional span: export=.Span
        • Optional req: IncomingMessage
        • Optional res: ServerResponse<IncomingMessage>

        Returns any

Optional measured

measured?: boolean | {
    [key: string]: boolean;
}

Whether 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.

Type declaration

  • [key: string]: boolean

Optional middleware

middleware?: boolean

Whether to enable instrumentation of .middleware spans

Default

true

Optional service

service?: any

The service name to be used for this plugin.

Optional validateStatus

validateStatus?: ((code) => boolean)

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.

Type declaration

    • (code): boolean

    • 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.

      Parameters

      • code: number

      Returns boolean

      Default

      code => code < 500

Default

code => code < 500

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc