Class NodeTracerProvider

Register this TracerProvider for use with the OpenTelemetry API. Undefined values may be replaced with defaults, and null values will be skipped.

Param: config

Configuration object for SDK registration

Hierarchy

  • BasicTracerProvider
    • NodeTracerProvider

Constructors

constructor

Properties

activeSpanProcessor resource _registeredExporters _registeredPropagators

Methods

_buildExporterFromEnv _buildPropagatorFromEnv _getPropagator _getSpanExporter addSpanProcessor forceFlush getActiveSpanProcessor getTracer register shutdown

Constructors

constructor

  • new NodeTracerProvider(config?: TracerConfig): NodeTracerProvider

    Parameters

    • Optionalconfig: TracerConfig

    Returns NodeTracerProvider

Properties

activeSpanProcessor

activeSpanProcessor: SpanProcessor

Readonlyresource

resource: IResource

Protected Static Readonly_registeredExporters

_registeredExporters: Map<string, EXPORTER_FACTORY>

Protected Static Readonly_registeredPropagators

_registeredPropagators: Map<string, PROPAGATOR_FACTORY>

Methods

Protected_buildExporterFromEnv

  • _buildExporterFromEnv(): undefined | SpanExporter

    Returns undefined | SpanExporter

Protected_buildPropagatorFromEnv

  • _buildPropagatorFromEnv(): undefined | TextMapPropagator<any>

    Returns undefined | TextMapPropagator<any>

Protected_getPropagator

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

    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

    Parameters

    • name: string

    Returns undefined | SpanExporter

addSpanProcessor

  • addSpanProcessor(spanProcessor: SpanProcessor): void

    Parameters

    • spanProcessor: SpanProcessor

      the new SpanProcessor to be added.

    Returns void

    Deprecated

    please use TracerConfig spanProcessors property Adds a new SpanProcessor to this tracer.

forceFlush

  • forceFlush(): Promise<void>

    Returns Promise<void>

getActiveSpanProcessor

  • getActiveSpanProcessor(): SpanProcessor

    Returns SpanProcessor

getTracer

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

    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. NoopTracerProvider vs. a functional tracer).

    Parameters

    • name: string

      The name of the tracer or instrumentation library.

    • Optionalversion: string

      The version of the tracer or instrumentation library.

    • Optionaloptions: { schemaUrl?: string }

      The options of the tracer or instrumentation library.

    Returns Tracer

    Tracer A Tracer with the given name and version

register

  • register(config?: SDKRegistrationConfig): void

    Register this TracerProvider for use with the OpenTelemetry API. Undefined values may be replaced with defaults, and null values will be skipped.

    Parameters

    • Optionalconfig: SDKRegistrationConfig

      Configuration object for SDK registration

    Returns void

shutdown

  • shutdown(): Promise<void>

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods