Class InstrumentationBase<ConfigType>`Abstract`

Base abstract class for instrumenting node plugins

Index

Constructors

constructor

new InstrumentationBase<
    ConfigType extends InstrumentationConfig = InstrumentationConfig,
>(
    instrumentationName: string,
    instrumentationVersion: string,
    config: ConfigType,
): InstrumentationBase<ConfigType>
Type Parameters
- ConfigType extends InstrumentationConfig = InstrumentationConfig
Parameters
- instrumentationName: string
- instrumentationVersion: string
- config: ConfigType
Returns InstrumentationBase<ConfigType>
Overrides InstrumentationAbstract<ConfigType>.constructor
- Defined in experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts:42

Properties

`Protected`_config

_config: ConfigType = ...

`Protected`_diag

_diag: DiagLogger

`Protected`_massUnwrap

_massUnwrap: <Nodule extends object>(
nodules: Nodule[],
names: (keyof Nodule)[],
) => void = ...

`Protected`_massWrap

_massWrap: <Nodule extends object, FieldName extends string | number | symbol>(
    nodules: Nodule[],
    names: FieldName[],
    wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
) => void = ...

`Protected`_unwrap

_unwrap: <Nodule extends object>(nodule: Nodule, name: keyof Nodule) => void = ...

`Protected`_wrap

_wrap: <Nodule extends object, FieldName extends string | number | symbol>(
    nodule: Nodule,
    name: FieldName,
    wrapper: (
        original: Nodule[FieldName],
        name: FieldName,
    ) => Nodule[FieldName],
) => ShimWrapped | undefined = ...

`Readonly`instrumentationName

instrumentationName: string

Instrumentation Name

`Readonly`instrumentationVersion

instrumentationVersion: string

Instrumentation Version

Accessors

`Protected`logger

get logger(): Logger
Returns Logger
Inherited from InstrumentationAbstract.logger
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:89

`Protected`meter

get meter(): Meter
Returns Meter
Inherited from InstrumentationAbstract.meter
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:71

`Protected`tracer

get tracer(): Tracer
Returns Tracer
Inherited from InstrumentationAbstract.tracer
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:158

Methods

`Protected`_runSpanCustomizationHook

_runSpanCustomizationHook<SpanCustomizationInfoType>(
    hookHandler:
        | SpanCustomizationHook<SpanCustomizationInfoType>
        | undefined,
    triggerName: string,
    span: Span,
    info: SpanCustomizationInfoType,
): void
Execute span customization hook, if configured, and log any errors. Any semantics of the trigger and info are defined by the specific instrumentation.
Type Parameters
- SpanCustomizationInfoType
Parameters
- hookHandler: SpanCustomizationHook<SpanCustomizationInfoType> | undefined
  The optional hook handler which the user has configured via instrumentation config
- triggerName: string
  The name of the trigger for executing the hook for logging purposes
- span: Span
  The span to which the hook should be applied
- info: SpanCustomizationInfoType
  The info object to be passed to the hook, with useful data the hook may use
Returns void
Inherited from InstrumentationAbstract._runSpanCustomizationHook
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:185

`Protected`_updateMetricInstruments

_updateMetricInstruments(): void
Sets the new metric instruments with the current Meter.

Returns void
Inherited from InstrumentationAbstract._updateMetricInstruments
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:124

disable

disable(): void
Method to disable the instrumentation

Returns void
Implementation of Instrumentation.disable
Overrides InstrumentationAbstract.disable
- Defined in experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts:313

enable

enable(): void
Method to enable the instrumentation

Returns void
Implementation of Instrumentation.enable
Overrides InstrumentationAbstract.enable
- Defined in experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts:243

getConfig

getConfig(): ConfigType
Method to get instrumentation config

Returns ConfigType
Implementation of Instrumentation.getConfig
Inherited from InstrumentationAbstract.getConfig
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:129

getModuleDefinitions

getModuleDefinitions(): InstrumentationModuleDefinition[]
Experimental
Get module definitions defined by init. This can be used for experimental compile-time instrumentation.

Returns InstrumentationModuleDefinition[]
an array of InstrumentationModuleDefinition
Inherited from InstrumentationAbstract.getModuleDefinitions
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:112

`Protected` `Abstract`init

init(): | void
| InstrumentationModuleDefinition
| InstrumentationModuleDefinition[]
Init method in which plugin should define _modules and patches for methods.

Returns void | InstrumentationModuleDefinition | InstrumentationModuleDefinition[]
Inherited from InstrumentationAbstract.init
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:172

isEnabled

isEnabled(): boolean
Returns boolean
- Defined in experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts:346

setConfig

setConfig(config: ConfigType): void
Sets InstrumentationConfig to this plugin
Parameters
- config: ConfigType
Returns void
Implementation of Instrumentation.setConfig
Inherited from InstrumentationAbstract.setConfig
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:137

setLoggerProvider

setLoggerProvider(loggerProvider: LoggerProvider): void
Sets LoggerProvider to this plugin
Parameters
- loggerProvider: LoggerProvider
Returns void
Implementation of Instrumentation.setLoggerProvider
Inherited from InstrumentationAbstract.setLoggerProvider
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:97

setMeterProvider

setMeterProvider(meterProvider: MeterProvider): void
Sets MeterProvider to this plugin
Parameters
- meterProvider: MeterProvider
Returns void
Implementation of Instrumentation.setMeterProvider
Inherited from InstrumentationAbstract.setMeterProvider
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:79

setTracerProvider

setTracerProvider(tracerProvider: TracerProvider): void
Sets TracerProvider to this plugin
Parameters
- tracerProvider: TracerProvider
Returns void
Implementation of Instrumentation.setTracerProvider
Inherited from InstrumentationAbstract.setTracerProvider
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:150

Class InstrumentationBase<ConfigType>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns InstrumentationBase<ConfigType>

Properties

Protected_config

Protected_diag

Protected_massUnwrap

Protected_massWrap

Protected_unwrap

Protected_wrap

ReadonlyinstrumentationName

ReadonlyinstrumentationVersion

Accessors

Protectedlogger

Returns Logger

Protectedmeter

Returns Meter

Protectedtracer

Returns Tracer

Methods

Protected_runSpanCustomizationHook

Type Parameters

Parameters

Returns void

Protected_updateMetricInstruments

Returns void

disable

Returns void

enable

Returns void

getConfig

Returns ConfigType

getModuleDefinitions

Returns InstrumentationModuleDefinition[]

Protected Abstractinit

Returns void | InstrumentationModuleDefinition | InstrumentationModuleDefinition[]

isEnabled

Returns boolean

setConfig

Parameters

Returns void

setLoggerProvider

Parameters

Returns void

setMeterProvider

Parameters

Returns void

setTracerProvider

Parameters

Returns void

Settings

On This Page

Class InstrumentationBase<ConfigType>`Abstract`

`Protected`_config

`Protected`_diag

`Protected`_massUnwrap

`Protected`_massWrap

`Protected`_unwrap

`Protected`_wrap

`Readonly`instrumentationName

`Readonly`instrumentationVersion

`Protected`logger

`Protected`meter

`Protected`tracer

`Protected`_runSpanCustomizationHook

`Protected`_updateMetricInstruments

`Protected` `Abstract`init