Class BatchSpanProcessorBase<T> Abstract

Implementation of the SpanProcessor that batches spans exported by the SDK then pushes them to the exporter pipeline.

Type Parameters

T extends BufferConfig

Hierarchy

BatchSpanProcessorBase
- BatchSpanProcessor

Implements

SpanProcessor

Index

Constructors

constructor

Methods

Constructors

constructor

new BatchSpanProcessorBase<T>(_exporter: SpanExporter, config?: T): BatchSpanProcessorBase<T>

- Defined in packages/opentelemetry-sdk-trace-base/src/export/BatchSpanProcessorBase.ts:50
Type Parameters
- T extends BufferConfig
Parameters
- _exporter: SpanExporter
- Optional config: T
Returns BatchSpanProcessorBase<T>

Methods

forceFlush

forceFlush(): Promise<void>

Implementation of SpanProcessor.forceFlush
- Defined in packages/opentelemetry-sdk-trace-base/src/export/BatchSpanProcessorBase.ts:82
Forces to export all finished spans

Returns Promise<void>

onEnd

onEnd(span: ReadableSpan): void

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

Parameters
- span: ReadableSpan
Returns void

Protected Abstract onShutdown

onShutdown(): void

- Defined in packages/opentelemetry-sdk-trace-base/src/export/BatchSpanProcessorBase.ts:263
Returns void

onStart

onStart(_span: Span, _parentContext: Context): void

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

Parameters
- _span: Span
- _parentContext: Context
Returns void

shutdown

shutdown(): Promise<void>

Implementation of SpanProcessor.shutdown
- Defined in packages/opentelemetry-sdk-trace-base/src/export/BatchSpanProcessorBase.ts:104
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