Arize Phoenix TS
    Preparing search index...

    Interface NodeTracerProvider

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

    Configuration object for SDK registration

    interface NodeTracerProvider {
        activeSpanProcessor: SpanProcessor;
        resource: IResource;
        _buildExporterFromEnv(): SpanExporter | undefined;
        _buildPropagatorFromEnv(): TextMapPropagator<any> | undefined;
        _getPropagator(name: string): TextMapPropagator<any> | undefined;
        _getSpanExporter(name: string): SpanExporter | undefined;
        addSpanProcessor(spanProcessor: SpanProcessor): void;
        forceFlush(): Promise<void>;
        getActiveSpanProcessor(): SpanProcessor;
        getTracer(
            name: string,
            version?: string,
            options?: { schemaUrl?: string },
        ): Tracer;
        register(config?: SDKRegistrationConfig): void;
        shutdown(): Promise<void>;
    }

    Hierarchy

    • BasicTracerProvider
      • NodeTracerProvider
    Index

    Properties

    activeSpanProcessor resource

    Methods

    _buildExporterFromEnv _buildPropagatorFromEnv _getPropagator _getSpanExporter addSpanProcessor forceFlush getActiveSpanProcessor getTracer register shutdown

    Properties

    activeSpanProcessor: SpanProcessor
    resource: IResource

    Methods

    Protected_buildExporterFromEnv

    • _buildExporterFromEnv(): SpanExporter | undefined

      Returns SpanExporter | undefined

    Protected_buildPropagatorFromEnv

    • _buildPropagatorFromEnv(): TextMapPropagator<any> | undefined

      Returns TextMapPropagator<any> | undefined

    Protected_getPropagator

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

      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 TextMapPropagator<any> | undefined

    Protected_getSpanExporter

    • _getSpanExporter(name: string): SpanExporter | undefined

      Parameters

      • name: string

      Returns SpanExporter | undefined

    • Parameters

      • spanProcessor: SpanProcessor

        the new SpanProcessor to be added.

      Returns void

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

    • Returns Promise<void>

    • Returns SpanProcessor

    • 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 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

    • Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods