InstrumentationBase | OpenTelemetry SDK

Base abstract class for instrumenting node plugins

Type Parameters

ConfigType extends InstrumentationConfig = InstrumentationConfig

Hierarchy

InstrumentationAbstract<ConfigType>
- InstrumentationBase

Implements

Instrumentation<ConfigType>

Index

Constructors

constructor

new InstrumentationBase<ConfigType>(instrumentationName: string, instrumentationVersion: string, config: ConfigType): InstrumentationBase<ConfigType>

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

Properties

Protected _config

_config: ConfigType

Protected _diag

_diag: DiagLogger

Protected _massUnwrap

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

Type declaration

- <Nodule>(nodules: Nodule[], names: (keyof Nodule)[]): void
- Type Parameters
  - Nodule extends object
  Parameters
  - nodules: Nodule[]
  - names: (keyof Nodule)[]
  Returns void

Protected _massWrap

_massWrap: (<Nodule, FieldName>(nodules: Nodule[], names: FieldName[], wrapper: ((original: Nodule[FieldName]) => Nodule[FieldName])) => void) = ...

Type declaration

- <Nodule, FieldName>(nodules: Nodule[], names: FieldName[], wrapper: ((original: Nodule[FieldName]) => Nodule[FieldName])): void
- Type Parameters
  - Nodule extends object
  - FieldName extends string | number | symbol
  Parameters
  - nodules: Nodule[]
  - names: FieldName[]
  - wrapper: ((original: Nodule[FieldName]) => Nodule[FieldName])
    - - (original: Nodule[FieldName]): Nodule[FieldName]
      - Parameters
        original: Nodule[FieldName]
        Returns Nodule[FieldName]
  Returns void

Protected _unwrap

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

Type declaration

- <Nodule>(nodule: Nodule, name: keyof Nodule): void
- Type Parameters
  - Nodule extends object
  Parameters
  - nodule: Nodule
  - name: keyof Nodule
  Returns void

Protected _wrap

_wrap: (<Nodule, FieldName>(nodule: Nodule, name: FieldName, wrapper: ((original: Nodule[FieldName]) => Nodule[FieldName])) => void) = ...

Type declaration

- <Nodule, FieldName>(nodule: Nodule, name: FieldName, wrapper: ((original: Nodule[FieldName]) => Nodule[FieldName])): void
- Type Parameters
  - Nodule extends object
  - FieldName extends string | number | symbol
  Parameters
  - nodule: Nodule
  - name: FieldName
  - wrapper: ((original: Nodule[FieldName]) => Nodule[FieldName])
    - - (original: Nodule[FieldName]): Nodule[FieldName]
      - Parameters
        original: Nodule[FieldName]
        Returns Nodule[FieldName]
  Returns void

Readonly instrumentationName

instrumentationName: string

Instrumentation Name

Readonly instrumentationVersion

instrumentationVersion: string

Instrumentation Version

Accessors

Protected logger

get logger(): Logger

Inherited from InstrumentationAbstract.logger
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:101
Returns Logger

Protected meter

get meter(): Meter

Inherited from InstrumentationAbstract.meter
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:83
Returns Meter

Protected tracer

get tracer(): Tracer

Inherited from InstrumentationAbstract.tracer
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:167
Returns Tracer

Methods

Protected _runSpanCustomizationHook

_runSpanCustomizationHook<SpanCustomizationInfoType>(hookHandler: undefined | SpanCustomizationHook<SpanCustomizationInfoType>, triggerName: string, span: Span, info: SpanCustomizationInfoType): void

Inherited from InstrumentationAbstract._runSpanCustomizationHook
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:194
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: undefined | SpanCustomizationHook<SpanCustomizationInfoType>
  
  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

Protected _updateMetricInstruments

_updateMetricInstruments(): void

Inherited from InstrumentationAbstract._updateMetricInstruments
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:136
Sets the new metric instruments with the current Meter.

Returns void

disable

disable(): void

Implementation of Instrumentation.disable
Overrides InstrumentationAbstract.disable
- Defined in experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts:321
Method to disable the instrumentation

Returns void

enable

enable(): void

Implementation of Instrumentation.enable
Overrides InstrumentationAbstract.enable
- Defined in experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts:259
Method to enable the instrumentation

Returns void

getConfig

getConfig(): ConfigType

Implementation of Instrumentation.getConfig
Inherited from InstrumentationAbstract.getConfig
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:141
Method to get instrumentation config

Returns ConfigType

getModuleDefinitions

getModuleDefinitions(): InstrumentationModuleDefinition[]

Inherited from InstrumentationAbstract.getModuleDefinitions
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:124
experimental
Get module definitions defined by init. This can be used for experimental compile-time instrumentation.

Returns InstrumentationModuleDefinition[]
an array of InstrumentationModuleDefinition

Protected Abstract init

init(): void | InstrumentationModuleDefinition | InstrumentationModuleDefinition[]

Inherited from InstrumentationAbstract.init
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:181
Init method in which plugin should define _modules and patches for methods.

Returns void | InstrumentationModuleDefinition | InstrumentationModuleDefinition[]

isEnabled

isEnabled(): boolean

- Defined in experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts:354
Returns boolean

setConfig

setConfig(config: ConfigType): void

Implementation of Instrumentation.setConfig
Inherited from InstrumentationAbstract.setConfig
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:149
Sets InstrumentationConfig to this plugin

Parameters
- config: ConfigType
Returns void

setLoggerProvider

setLoggerProvider(loggerProvider: LoggerProvider): void

Implementation of Instrumentation.setLoggerProvider
Inherited from InstrumentationAbstract.setLoggerProvider
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:109
Sets LoggerProvider to this plugin

Parameters
- loggerProvider: LoggerProvider
Returns void

setMeterProvider

setMeterProvider(meterProvider: MeterProvider): void

Implementation of Instrumentation.setMeterProvider
Inherited from InstrumentationAbstract.setMeterProvider
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:91
Sets MeterProvider to this plugin

Parameters
- meterProvider: MeterProvider
Returns void

setTracerProvider

setTracerProvider(tracerProvider: TracerProvider): void

Implementation of Instrumentation.setTracerProvider
Inherited from InstrumentationAbstract.setTracerProvider
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:159
Sets TraceProvider to this plugin

Parameters
- tracerProvider: TracerProvider
Returns void

Type Parameters

ConfigType extends InstrumentationConfig = InstrumentationConfig

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

ConfigType extends InstrumentationConfig = InstrumentationConfig

Parameters

instrumentationName: string

instrumentationVersion: string

config: ConfigType

Returns InstrumentationBase<ConfigType>

Properties

Protected _config

Protected _diag

Protected _massUnwrap

Type declaration

Type Parameters

Nodule extends object

Parameters

nodules: Nodule[]

names: (keyof Nodule)[]

Returns void

Protected _massWrap

Type declaration

Type Parameters

Nodule extends object

FieldName extends string | number | symbol

Parameters

nodules: Nodule[]

names: FieldName[]

wrapper: ((original: Nodule[FieldName]) => Nodule[FieldName])

Parameters

original: Nodule[FieldName]

Returns Nodule[FieldName]

Returns void

Protected _unwrap

Type declaration

Type Parameters

Nodule extends object

Parameters

nodule: Nodule

name: keyof Nodule

Returns void

Protected _wrap

Type declaration

Type Parameters

Nodule extends object

FieldName extends string | number | symbol

Parameters

nodule: Nodule

name: FieldName

wrapper: ((original: Nodule[FieldName]) => Nodule[FieldName])

Parameters

original: Nodule[FieldName]

Returns Nodule[FieldName]

Returns void

Readonly instrumentationName

Readonly instrumentationVersion

Accessors

Protected logger

Returns Logger

Protected meter

Returns Meter

Protected tracer

Returns Tracer

Methods

Protected _runSpanCustomizationHook

Type Parameters

SpanCustomizationInfoType

Parameters

hookHandler: undefined | SpanCustomizationHook<SpanCustomizationInfoType>

triggerName: string

span: Span