Class TraceAPI

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

Since

1.0.0

Properties

deleteSpan getActiveSpan getSpan getSpanContext isSpanContextValid setSpan setSpanContext wrapSpanContext

Methods

disable getTracer getTracerProvider setGlobalTracerProvider getInstance

Properties

deleteSpan

deleteSpan: (context: Context) => Context = deleteSpan

Type declaration

getActiveSpan

getActiveSpan: () => undefined | Span = getActiveSpan

Type declaration

    • (): undefined | Span

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

      Returns undefined | Span

getSpan

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

Type declaration

    • (context: Context): undefined | Span

    • Return the span if one exists

      Parameters

      • context: Context

        context to get span from

      Returns undefined | Span

getSpanContext

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

Type declaration

isSpanContextValid

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

Type declaration

setSpan

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

Type declaration

setSpanContext

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

Type declaration

wrapSpanContext

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

Type declaration

Methods

disable

  • disable(): void

    Remove the global tracer provider

    Returns void

getTracer

  • getTracer(name: string, version?: string): Tracer

    Returns a tracer from the global tracer provider.

    Parameters

    • name: string
    • Optionalversion: string

    Returns Tracer

getTracerProvider

setGlobalTracerProvider

  • setGlobalTracerProvider(provider: TracerProvider): boolean

    Set the current global tracer.

    Parameters

    Returns boolean

    true if the tracer provider was successfully registered, else false

StaticgetInstance

Settings

Member Visibility

On This Page

Properties
Methods