Class ShimTracer

constructor

• new ShimTracer(otelTracer: Tracer): ShimTracer

  Parameters

  • otelTracer: Tracer

  Returns ShimTracer

active

activeTraceParams

eventListeners

logger

propagation

sampler

currentRootSpan

• get currentRootSpan(): Span

  Gets the current root span.

  Returns Span

clearCurrentTrace

• clearCurrentTrace(): void

  Clear the currentRootSpan from tracer instance

  Returns void

onEndSpan

• onEndSpan(): void

  Happens when a span is ended

  Returns void

onStartSpan

• onStartSpan(): void

  Happens when a span is started

  Returns void

registerSpanEventListener

• registerSpanEventListener(): void

  Register a OnEndSpanEventListener on the tracer instance

  Returns void

setCurrentRootSpan

• setCurrentRootSpan(): void

  Sets the current root span.

  Returns void

start

• start(config: TracerConfig): this

  Start a tracer instance

  Parameters

  • config: TracerConfig

    Configuration for tracer instace

  Returns this

  A tracer instance started

startChildSpan

• startChildSpan(options?: SpanOptions): Span

  Start a new Span instance to the currentRootSpan

  Parameters

  • Optionaloptions: SpanOptions

    A TraceOptions object to start a root span.

  Returns Span

  The new Span instance started

startRootSpan

• startRootSpan<T>(options: TraceOptions, fn: (root: Span) => T): T

  Starts a root span.

  Type Parameters

  • T

  Parameters

  • options: TraceOptions

    A TraceOptions object to start a root span.
  • fn: (root: Span) => T

    A callback function to run after starting a root span.

  Returns T

stop

• stop(): this

  Noop implementations

  Returns this

unregisterSpanEventListener

• unregisterSpanEventListener(): void

  Unregisters an end span event listener.

  Returns void

wrap

• wrap<T>(fn: Func<T>): Func<T>

  Binds the trace context to the given function. This is necessary in order to create child spans correctly in functions that are called asynchronously (for example, in a network response handler).

  Type Parameters

  • T

  Parameters

  • fn: Func<T>

    A function to which to bind the trace context.

  Returns Func<T>

wrapEmitter

• wrapEmitter(emitter: EventEmitter): void

  Binds the trace context to the given event emitter. This is necessary in order to create child spans correctly in event handlers.

  Parameters

  • emitter: EventEmitter

    An event emitter whose handlers should have the trace context binded to them.

  Returns void