Interface opensearch

This plugin automatically instruments the opensearch module.

interface opensearch {
    enabled?: boolean;
    hooks?: {
        query?: ((span?, params?) => any);
    };
    measured?: boolean | {
        [key: string]: boolean;
    };
    service?: any;
}

Hierarchy (view full)

Properties

enabled? hooks? measured? service?

Properties

Optional enabled

enabled?: boolean

Whether to enable the plugin.

Default

true

Optional hooks

hooks?: {
    query?: ((span?, params?) => any);
}

Hooks to run before spans are finished.

Type declaration

  • Optional query?: ((span?, params?) => any)

    Hook to execute just before the query span finishes.

      • (span?, params?): any

      • Parameters

        • Optional span: export=.Span
        • Optional params: TransportRequestParams

        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 service

service?: any

The service name to be used for this plugin.

Settings

Member Visibility

Theme

On This Page

enabledhooksmeasuredservice