Interface ITraceApi

ITraceApi provides an interface definition which is simular to the OpenTelemetry TraceAPI

interface ITraceApi {
    getActiveSpan(): IReadableSpan;
    getTracer(name: string, version?: string, options?: IOTelTracerOptions): IOTelTracer;
    isSpanContextValid(spanContext: IDistributedTraceInit | IDistributedTraceContext | IOTelSpanContext): boolean;
    setActiveSpan(span: IReadableSpan): ISpanScope<ITraceHost<IConfiguration>>;
    wrapSpanContext(spanContext: IDistributedTraceInit | IDistributedTraceContext | IOTelSpanContext): IReadableSpan;
}

Index

Methods

getActiveSpan getTracer isSpanContextValid setActiveSpan wrapSpanContext

Methods

getActiveSpan

getActiveSpan(): IReadableSpan
Gets the span from the current context, if one exists.

Returns IReadableSpan
- Defined in interfaces/otel/trace/IOTelTraceApi.ts:43

getTracer

getTracer(name, version?, options?): IOTelTracer
Returns a Tracer, creating one if one with the given name and version if one has not already created.
Parameters
- name: string
  The name of the tracer or instrumentation library.
- Optionalversion: string
  The version of the tracer or instrumentation library.
- Optionaloptions: IOTelTracerOptions
  The options of the tracer or instrumentation library.
Returns IOTelTracer
Tracer A Tracer with the given name and version
- Defined in interfaces/otel/trace/IOTelTraceApi.ts:24

isSpanContextValid

isSpanContextValid(spanContext): boolean
Returns true if this IDistributedTraceContext is valid.
Parameters
- spanContext: IDistributedTraceInit | IDistributedTraceContext | IOTelSpanContext
Returns boolean
true if this IDistributedTraceContext is valid.
- Defined in interfaces/otel/trace/IOTelTraceApi.ts:38

setActiveSpan

setActiveSpan(span): ISpanScope<ITraceHost<IConfiguration>>
Set or clear the current active span.
Parameters
- span: IReadableSpan
  The span to set as the active span, or null/undefined to clear the active span.
Returns ISpanScope<ITraceHost<IConfiguration>>
An ISpanScope instance returned by the host, or void if there is no defined host.
- Defined in interfaces/otel/trace/IOTelTraceApi.ts:50

wrapSpanContext

wrapSpanContext(spanContext): IReadableSpan
Wrap the given IDistributedTraceContext in a new non-recording IReadableSpan
Parameters
- spanContext: IDistributedTraceInit | IDistributedTraceContext | IOTelSpanContext
  The IDistributedTraceContext to be wrapped
Returns IReadableSpan
a new non-recording IReadableSpan with the provided context
- Defined in interfaces/otel/trace/IOTelTraceApi.ts:32