InstrumentationBase | OpenTelemetry SDK

Base abstract class for instrumenting node plugins

Hierarchy

InstrumentationAbstract
- InstrumentationBase

Implements

Instrumentation

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new InstrumentationBase(instrumentationName: string, instrumentationVersion: string, config?: InstrumentationConfig): InstrumentationBase

Overrides InstrumentationAbstract.constructor
- Defined in experimental/packages/opentelemetry-instrumentation/src/platform/node/instrumentation.ts:48
Parameters
- instrumentationName: string
- instrumentationVersion: string
- config: InstrumentationConfig = {}
Returns InstrumentationBase

Properties

Protected _config

_config: InstrumentationConfig

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:94
Returns Logger

Protected meter

get meter(): Meter

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

Protected tracer

get tracer(): Tracer

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

Methods

Protected _updateMetricInstruments

_updateMetricInstruments(): void

Inherited from InstrumentationAbstract._updateMetricInstruments
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:129
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:313
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:250
Method to enable the instrumentation

Returns void

isEnabled

isEnabled(): boolean

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

setConfig

setConfig(config?: InstrumentationConfig): void

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

Parameters
- config: InstrumentationConfig = {}
Returns void

setLoggerProvider

setLoggerProvider(loggerProvider: LoggerProvider): void

Implementation of Instrumentation.setLoggerProvider
Inherited from InstrumentationAbstract.setLoggerProvider
- Defined in experimental/packages/opentelemetry-instrumentation/src/instrumentation.ts:102
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:84
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:150
Sets TraceProvider to this plugin

Parameters
- tracerProvider: TracerProvider
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

instrumentationName: string

instrumentationVersion: string

config: InstrumentationConfig = {}

Returns InstrumentationBase

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 _updateMetricInstruments

Returns void

disable

Returns void

enable

Returns void

getConfig

Returns InstrumentationConfig

getModuleDefinitions

Returns InstrumentationModuleDefinition[]

Protected Abstract init