Interface SpanProcessor

SpanProcessor is the interface Tracer SDK uses to allow synchronous hooks for when a Span is started or when a Span is ended.

interface SpanProcessor {
    forceFlush(): Promise<void>;
    onEnd(span: ReadableSpan): void;
    onEnding(span: Span): void;
    onStart(span: Span, parentContext: Context): void;
    shutdown(): Promise<void>;
}

Implemented by

Index

Methods

forceFlush onEnd onEnding? onStart shutdown

Methods

forceFlush

forceFlush(): Promise<void>
Forces to export all finished spans

Returns Promise<void>
- Defined in SpanProcessor.ts:29

onEnd

onEnd(span: ReadableSpan): void
Called when a ReadableSpan is ended, if the span.isRecording() returns true.
Parameters
- span: ReadableSpan
  the Span that just ended.
Returns void
- Defined in SpanProcessor.ts:52

`Optional`onEnding

onEnding(span: Span): void
Experimental
Called when a Span is ending, if the span.isRecording() returns true.
Parameters
- span: Span
  the Span that is ending.
  
  This method is experimental and may break in minor versions of this package
Returns void
- Defined in SpanProcessor.ts:45

onStart

onStart(span: Span, parentContext: Context): void
Called when a Span is started, if the span.isRecording() returns true.
Parameters
- span: Span
  the Span that just started.
- parentContext: Context
Returns void
- Defined in SpanProcessor.ts:36

shutdown

shutdown(): Promise<void>
Shuts down the processor. Called when SDK is shut down. This is an opportunity for processor to do any cleanup required.

Returns Promise<void>
- Defined in SpanProcessor.ts:58