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.

Hierarchy

SpanProcessor

Implemented by

Index

Methods

Methods

forceFlush

forceFlush(): Promise<void>

- Defined in packages/opentelemetry-sdk-trace-base/src/SpanProcessor.ts:29
Forces to export all finished spans

Returns Promise<void>

onEnd

onEnd(span: ReadableSpan): void

- Defined in packages/opentelemetry-sdk-trace-base/src/SpanProcessor.ts:43
Called when a ReadableSpan is ended, if the span.isRecording() returns true.

Parameters
- span: ReadableSpan
  
  the Span that just ended.
Returns void

onStart

onStart(span: Span, parentContext: Context): void

- Defined in packages/opentelemetry-sdk-trace-base/src/SpanProcessor.ts:36
Called when a Span is started, if the span.isRecording() returns true.

Parameters
- span: Span
  
  the Span that just started.
- parentContext: Context
Returns void

shutdown

shutdown(): Promise<void>

- Defined in packages/opentelemetry-sdk-trace-base/src/SpanProcessor.ts:49
Shuts down the processor. Called when SDK is shut down. This is an opportunity for processor to do any cleanup required.

Returns Promise<void>

Generated using TypeDoc