TraceProvider

Constructors

Constructor

new TraceProvider(options?): TraceProvider;

Parameters

Parameter	Type
options	TraceProviderOptions

Returns

TraceProvider

Methods

createSpan()

createSpan<TSpanData>(spanOptions, parent?): Span<TSpanData>;

Type Parameters

Type Parameter
TSpanData extends SpanData

Parameters

Parameter	Type
spanOptions	CreateSpanOptions<TSpanData>
parent?	| Span<any> | Trace

Returns

Span<TSpanData>

---

createTrace()

createTrace(traceOptions): Trace;

Parameters

Parameter	Type
traceOptions	TraceOptions

Returns

Trace

---

dispatchSpan()

dispatchSpan<TSpanData>(span): Promise<void>;

Dispatches a completed span lifecycle to all registered processors.

This is useful when an integration receives a span that already has lifecycle timestamps and needs to fan out the lifecycle without mutating those timestamps.

Type Parameters

Type Parameter
TSpanData extends SpanData

Parameters

Parameter	Type
span	Span<TSpanData>

Returns

Promise<void>

---

dispatchSpanEnd()

dispatchSpanEnd<TSpanData>(span): Promise<void>;

Dispatches a span end event to all registered processors.

This is useful when an integration receives a span end outside this process and needs to fan out the end without mutating the span state.

Type Parameters

Type Parameter
TSpanData extends SpanData

Parameters

Parameter	Type
span	Span<TSpanData>

Returns

Promise<void>

---

dispatchSpanStart()

dispatchSpanStart<TSpanData>(span): Promise<void>;

Dispatches a span start event to all registered processors.

This is useful when an integration receives a span start outside this process and needs to fan out the start without mutating the span state.

Type Parameters

Type Parameter
TSpanData extends SpanData

Parameters

Parameter	Type
span	Span<TSpanData>

Returns

Promise<void>

---

dispatchTrace()

dispatchTrace(trace): Promise<void>;

Dispatches a completed trace lifecycle to all registered processors.

This is useful when an integration receives a trace that was started and ended outside this process and needs to fan out the lifecycle without mutating the trace state.

Parameters

Parameter	Type
trace	Trace

Returns

Promise<void>

---

forceFlush()

forceFlush(): Promise<void>;

Returns

Promise<void>

---

generateSpanId()

generateSpanId(): string;

Generate a new span ID.

Override this in custom providers to take precedence over configured ID generators.

Returns

string

---

generateTraceId()

generateTraceId(): string;

Generate a new trace ID.

Override this in custom providers to take precedence over configured ID generators.

Returns

string

---

getCurrentSpan()

getCurrentSpan():
  | Span<any>
  | null;

Returns

| Span<any> | null

---

getCurrentTrace()

getCurrentTrace(): Trace | null;

Get the current trace.

Returns

Trace | null

The current trace.

---

registerProcessor()

registerProcessor(processor): void;

Add a processor to the list of processors. Each processor will receive all traces/spans.

Parameters

Parameter	Type	Description
processor	TracingProcessor	The processor to add.

Returns

void

---

setDisabled()

setDisabled(disabled): void;

Parameters

Parameter	Type
disabled	boolean

Returns

void

---

setIdGenerator()

setIdGenerator(idGenerator?): void;

Parameters

Parameter	Type
idGenerator?	Partial<Readonly<{ generateSpanId: () => string; generateTraceId: () => string; }>>

Returns

void

---

setProcessors()

setProcessors(processors): void;

Set the list of processors. This will replace any existing processors.

Parameters

Parameter	Type	Description
processors	TracingProcessor[]	The list of processors to set.

Returns

void

---

shutdown()

shutdown(timeout?): Promise<void>;

Parameters

Parameter	Type
timeout?	number

Returns

Promise<void>

---

startExportLoop()

startExportLoop(): void;

Returns

void