Class BasicTracerProvider

This class represents a basic tracer provider which platform libraries can extend

Hierarchy

BasicTracerProvider

Implements

TracerProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BasicTracerProvider(config?: TracerConfig): BasicTracerProvider

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:76
Parameters
- config: TracerConfig = {}
Returns BasicTracerProvider

Properties

activeSpanProcessor

activeSpanProcessor: SpanProcessor

Readonly resource

resource: IResource

Static Protected Readonly _registeredExporters

_registeredExporters: Map<string, EXPORTER_FACTORY> = ...

Static Protected Readonly _registeredPropagators

_registeredPropagators: Map<string, PROPAGATOR_FACTORY> = ...

Methods

Protected _buildExporterFromEnv

_buildExporterFromEnv(): undefined | SpanExporter

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:288
Returns undefined | SpanExporter

Protected _buildPropagatorFromEnv

_buildPropagatorFromEnv(): undefined | TextMapPropagator<any>

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:251
Returns undefined | TextMapPropagator<any>

Protected _getPropagator

_getPropagator(name: string): undefined | TextMapPropagator<any>

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:239
TS cannot yet infer the type of this.constructor: https://github.com/Microsoft/TypeScript/issues/3841#issuecomment-337560146 There is no need to override either of the getters in your child class. The type of the registered component maps should be the same across all classes in the inheritance tree.

Parameters
- name: string
Returns undefined | TextMapPropagator<any>

Protected _getSpanExporter

_getSpanExporter(name: string): undefined | SpanExporter

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:245
Parameters
- name: string
Returns undefined | SpanExporter

addSpanProcessor

addSpanProcessor(spanProcessor: SpanProcessor): void

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:134
deprecated
please use TracerConfig spanProcessors property Adds a new SpanProcessor to this tracer.

Parameters
- spanProcessor: SpanProcessor
  
  the new SpanProcessor to be added.
Returns void

forceFlush

forceFlush(): Promise<void>

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:179
Returns Promise<void>

getActiveSpanProcessor

getActiveSpanProcessor(): SpanProcessor

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:153
Returns SpanProcessor

getTracer

getTracer(name: string, version?: string, options?: { schemaUrl?: string }): Tracer

Implementation of TracerProvider.getTracer
- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:108
Returns a Tracer, creating one if one with the given name and version is not already created.

This function may return different Tracer types (e.g. {@link NoopTracerProvider} vs. a functional tracer).

Parameters
- name: string
- Optional version: string
- Optional options: { schemaUrl?: string }
  - Optional schemaUrl?: string
Returns Tracer
Tracer A Tracer with the given name and version

register

register(config?: SDKRegistrationConfig): void

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:164
Register this TracerProvider for use with the OpenTelemetry API. Undefined values may be replaced with defaults, and null values will be skipped.

Parameters
- config: SDKRegistrationConfig = {}
  
  Configuration object for SDK registration
Returns void

shutdown

shutdown(): Promise<void>

- Defined in packages/opentelemetry-sdk-trace-base/src/BasicTracerProvider.ts:228
Returns Promise<void>

Generated using TypeDoc