Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface elasticsearch

This plugin automatically instruments the elasticsearch module.

Hierarchy

  • Instrumentation
    • elasticsearch

Index

Properties

Optional analytics

analytics: boolean | number | {}

Whether to enable App Analytics. Can also be set to a number instead to control the sample rate, or to an key-value pair with span names as keys and booleans or sample rates as values for more granular control.

Optional enabled

enabled: boolean

Whether to enable the plugin.

default

true

Optional hooks

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

Hooks to run before spans are finished.

Type declaration

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

    Hook to execute just before the query span finishes.

      • (span?: Span, params?: TransportRequestParams): any
      • Parameters

        • Optional span: Span
        • Optional params: TransportRequestParams

        Returns any

Optional service

service: string

The service name to be used for this plugin.

Generated using TypeDoc