Class GrpcInstrumentation

Base abstract class for instrumenting node plugins

Hierarchy (View Summary)

InstrumentationBase<GrpcInstrumentationConfig>
- GrpcInstrumentation

Index

Constructors

constructor

new GrpcInstrumentation(config?: GrpcInstrumentationConfig): GrpcInstrumentation
Parameters
- config: GrpcInstrumentationConfig = {}
Returns GrpcInstrumentation
Overrides InstrumentationBase.constructor
- Defined in experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts:93

Properties

`Protected`_config

_config: GrpcInstrumentationConfig

`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]) => Nodule[FieldName],
) => void

`Readonly`instrumentationName

instrumentationName: string

Instrumentation Name

`Readonly`instrumentationVersion

instrumentationVersion: string

Instrumentation Version

Accessors

`Protected`logger

get logger(): Logger
Returns Logger
Inherited from InstrumentationBase.logger
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:26

`Protected`meter

get meter(): Meter
Returns Meter
Inherited from InstrumentationBase.meter
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:20

`Protected`tracer

get tracer(): Tracer
Returns Tracer
Inherited from InstrumentationBase.tracer
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:56

Methods

`Protected`_runSpanCustomizationHook

_runSpanCustomizationHook<SpanCustomizationInfoType>(
    hookHandler:
        | undefined
        | SpanCustomizationHook<SpanCustomizationInfoType>,
    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: 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
Inherited from InstrumentationBase._runSpanCustomizationHook
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:72

`Protected`_updateMetricInstruments

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

Returns void
Inherited from InstrumentationBase._updateMetricInstruments
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:44

disable

disable(): void
Method to disable the instrumentation

Returns void
Inherited from InstrumentationBase.disable
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/platform/node/instrumentation.d.ts:22

enable

enable(): void
Method to enable the instrumentation

Returns void
Inherited from InstrumentationBase.enable
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/platform/node/instrumentation.d.ts:21

getConfig

getConfig(): GrpcInstrumentationConfig
Method to get instrumentation config

Returns GrpcInstrumentationConfig
Inherited from InstrumentationBase.getConfig
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:45

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 InstrumentationBase.getModuleDefinitions
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:40

init

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

Returns InstrumentationNodeModuleDefinition[]
Overrides InstrumentationBase.init
- Defined in experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts:98

isEnabled

isEnabled(): boolean
Returns boolean
Inherited from InstrumentationBase.isEnabled
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/platform/node/instrumentation.d.ts:23

setConfig

setConfig(config?: GrpcInstrumentationConfig): void
Sets InstrumentationConfig to this plugin
Parameters
- config: GrpcInstrumentationConfig = {}
Returns void
Overrides InstrumentationBase.setConfig
- Defined in experimental/packages/opentelemetry-instrumentation-grpc/src/instrumentation.ts:170

setLoggerProvider

setLoggerProvider(loggerProvider: LoggerProvider): void
Sets LoggerProvider to this plugin
Parameters
- loggerProvider: LoggerProvider
Returns void
Inherited from InstrumentationBase.setLoggerProvider
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:31

setMeterProvider

setMeterProvider(meterProvider: MeterProvider): void
Sets MeterProvider to this plugin
Parameters
- meterProvider: MeterProvider
Returns void
Inherited from InstrumentationBase.setMeterProvider
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:25

setTracerProvider

setTracerProvider(tracerProvider: TracerProvider): void
Sets TraceProvider to this plugin
Parameters
- tracerProvider: TracerProvider
Returns void
Inherited from InstrumentationBase.setTracerProvider
- Defined in experimental/packages/opentelemetry-instrumentation/build/src/instrumentation.d.ts:55

Class GrpcInstrumentation

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GrpcInstrumentation

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 GrpcInstrumentationConfig

getModuleDefinitions

Returns InstrumentationModuleDefinition[]

init

Returns InstrumentationNodeModuleDefinition[]

isEnabled

Returns boolean

setConfig

Parameters

Returns void

setLoggerProvider

Parameters

Returns void

setMeterProvider

Parameters

Returns void

setTracerProvider

Parameters

Returns void

Settings

On This Page

`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