OpenTelemetry SDK
    Preparing search index...

    Interface TraceAPI

    Singleton object which represents the entry point to the OpenTelemetry Tracing API

    1.0.0

    interface TraceAPI {
        deleteSpan: (context: Context) => Context;
        getActiveSpan: () => Span | undefined;
        getSpan: (context: Context) => Span | undefined;
        getSpanContext: (context: Context) => SpanContext | undefined;
        isSpanContextValid: (spanContext: SpanContext) => boolean;
        setSpan: (context: Context, span: Span) => Context;
        setSpanContext: (context: Context, spanContext: SpanContext) => Context;
        wrapSpanContext: (spanContext: SpanContext) => Span;
        disable(): void;
        getTracer(name: string, version?: string): Tracer;
        getTracerProvider(): TracerProvider;
        setGlobalTracerProvider(provider: TracerProvider): boolean;
    }
    Index
    deleteSpan getActiveSpan getSpan getSpanContext isSpanContextValid setSpan setSpanContext wrapSpanContext
    disable getTracer getTracerProvider setGlobalTracerProvider
    deleteSpan: (context: Context) => Context = deleteSpan

    Type Declaration

      • (context: Context): Context

      • Remove current span stored in the context

        Parameters

        • context: Context

          context to delete span from

        Returns Context

    getActiveSpan: () => Span | undefined = getActiveSpan

    Type Declaration

      • (): Span | undefined

      • Gets the span from the current context, if one exists.

        Returns Span | undefined

    getSpan: (context: Context) => Span | undefined = getSpan

    Type Declaration

      • (context: Context): Span | undefined

      • Return the span if one exists

        Parameters

        • context: Context

          context to get span from

        Returns Span | undefined

    getSpanContext: (context: Context) => SpanContext | undefined = getSpanContext

    Type Declaration

    isSpanContextValid: (spanContext: SpanContext) => boolean = isSpanContextValid

    Type Declaration

    setSpan: (context: Context, span: Span) => Context = setSpan

    Type Declaration

    setSpanContext: (context: Context, spanContext: SpanContext) => Context = setSpanContext

    Type Declaration

    wrapSpanContext: (spanContext: SpanContext) => Span = wrapSpanContext

    Type Declaration

    • Remove the global tracer provider

      Returns void

    • Returns a tracer from the global tracer provider.

      Parameters

      • name: string
      • Optionalversion: string

      Returns Tracer

    • Set the current global tracer.

      Parameters

      Returns boolean

      true if the tracer provider was successfully registered, else false

    Settings
    Member Visibility

    On This Page
    Properties
    Methods