CrawleeInstrumentation

Hierarchy

• InstrumentationBase<CrawleeInstrumentationConfig>
  • CrawleeInstrumentation

Index

Constructors

• constructor

Properties

• instrumentationName
• instrumentationVersion

Methods

• disable
• enable
• getConfig
• getModuleDefinitions
• isEnabled
• setConfig
• setLoggerProvider
• setMeterProvider
• setTracerProvider

Constructors

constructor

• new CrawleeInstrumentation(config): CrawleeInstrumentation

• Overrides InstrumentationBase<CrawleeInstrumentationConfig>.constructor

  Parameters

  • config: CrawleeInstrumentationConfig = {}

  Returns CrawleeInstrumentation

Properties

externalreadonlyinheritedinstrumentationName

instrumentationName: string

Inherited from InstrumentationBase.instrumentationName

Instrumentation Name

externalreadonlyinheritedinstrumentationVersion

instrumentationVersion: string

Inherited from InstrumentationBase.instrumentationVersion

Instrumentation Version

Methods

externalinheriteddisable

• disable(): void

• Inherited from InstrumentationBase.disable

  Returns void

externalinheritedenable

• enable(): void

• Inherited from InstrumentationBase.enable

  Returns void

externalinheritedgetConfig

• getConfig(): CrawleeInstrumentationConfig

• Inherited from InstrumentationBase.getConfig

  Method to get instrumentation config

  ---

  Returns CrawleeInstrumentationConfig

externalinheritedgetModuleDefinitions

• getModuleDefinitions(): InstrumentationModuleDefinition[]

• Inherited from InstrumentationBase.getModuleDefinitions

  experimental

  Get module definitions defined by init. This can be used for experimental compile-time instrumentation.

  ---

  Returns InstrumentationModuleDefinition[]

  an array of InstrumentationModuleDefinition

externalinheritedisEnabled

• isEnabled(): boolean

• Inherited from InstrumentationBase.isEnabled

  Returns boolean

externalinheritedsetConfig

• setConfig(config): void

• Inherited from InstrumentationBase.setConfig

  Sets InstrumentationConfig to this plugin

  ---

  Parameters

  • externalconfig: CrawleeInstrumentationConfig

  Returns void

externalinheritedsetLoggerProvider

• setLoggerProvider(loggerProvider): void

• Inherited from InstrumentationBase.setLoggerProvider

  Sets LoggerProvider to this plugin

  ---

  Parameters

  • externalloggerProvider: LoggerProvider

  Returns void

externalinheritedsetMeterProvider

• setMeterProvider(meterProvider): void

• Inherited from InstrumentationBase.setMeterProvider

  Sets MeterProvider to this plugin

  ---

  Parameters

  • externalmeterProvider: MeterProvider

  Returns void

publicsetTracerProvider

• setTracerProvider(tracerProvider): void

• Overrides InstrumentationBase.setTracerProvider

  Shares the tracer with the exported wrapWithSpan helper, so that manually wrapped handlers end up in the same instrumentation scope as the automatic spans.

  This has to happen here rather than in the constructor. The constructor can only reach the tracer of the global API, and that is not necessarily the one this instrumentation ends up using - a tracerProvider passed to registerInstrumentations is never registered globally, and a duplicated @opentelemetry/api in the dependency tree has its own global. Handing over a tracer from the wrong provider silences every span, including the automatic ones, and because it is not undefined it also shadows the fallback in wrapWithSpan.

  ---

  Parameters

  • tracerProvider: TracerProvider

  Returns void