Class BatchSpanProcessor

Hierarchy (View Summary)

BatchSpanProcessorBase<BatchSpanProcessorOptions>
- BatchSpanProcessor

Index

Constructors

Methods

forceFlush onEnd onShutdown onStart shutdown

Constructors

constructor

new BatchSpanProcessor(options: BatchSpanProcessorOptions): BatchSpanProcessor
Parameters
- options: BatchSpanProcessorOptions
Returns BatchSpanProcessor
Inherited from BatchSpanProcessorBase<BatchSpanProcessorOptions>.constructor
- Defined in export/BatchSpanProcessorBase.ts:43

Methods

forceFlush

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

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

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:82

`Protected`onShutdown

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

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:80

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:94