Class BatchSpanProcessor

Hierarchy

BatchSpanProcessorBase<BufferConfig>
- BatchSpanProcessor

Index

Constructors

Methods

forceFlush onEnd onShutdown onStart shutdown

Constructors

constructor

new BatchSpanProcessor(
_exporter: SpanExporter,
config?: BufferConfig,
): BatchSpanProcessor
Parameters
- _exporter: SpanExporter
- Optionalconfig: BufferConfig
Returns BatchSpanProcessor
Inherited from BatchSpanProcessorBase<BufferConfig>.constructor
- Defined in export/BatchSpanProcessorBase.ts:50

Methods

forceFlush

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

Returns Promise<void>
Inherited from BatchSpanProcessorBase.forceFlush
- Defined in export/BatchSpanProcessorBase.ts:81

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
Inherited from BatchSpanProcessorBase.onEnd
- Defined in export/BatchSpanProcessorBase.ts:91

`Protected`onShutdown

onShutdown(): void
Returns void
Overrides BatchSpanProcessorBase.onShutdown
- Defined in platform/node/export/BatchSpanProcessor.ts:21

onStart

onStart(_span: Span, _parentContext: Context): void
Called when a Span is started, if the span.isRecording() returns true.
Parameters
- _span: Span
- _parentContext: Context
Returns void
Inherited from BatchSpanProcessorBase.onStart
- Defined in export/BatchSpanProcessorBase.ts:89

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>
Inherited from BatchSpanProcessorBase.shutdown
- Defined in export/BatchSpanProcessorBase.ts:103