Class BatchSpanProcessor

A BatchSpanProcessor that applies OTEL_* environment variable fallbacks per https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/

Hierarchy (View Summary)

BatchSpanProcessor
- BatchSpanProcessor

Index

Constructors

Methods

forceFlush onEnd onShutdown onStart shutdown

Constructors

constructor

new BatchSpanProcessor(
exporter: SpanExporter,
config?: BufferConfig | BatchSpanProcessorBrowserConfig,
): BatchSpanProcessor
Parameters
- exporter: SpanExporter
- Optionalconfig: BufferConfig | BatchSpanProcessorBrowserConfig
Returns BatchSpanProcessor
Overrides BatchSpanProcessor.constructor
- Defined in opentelemetry-sdk-trace-base/build/src/BatchSpanProcessor-shim.d.ts:9

Methods

forceFlush

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

Returns Promise<void>
Inherited from BatchSpanProcessor.forceFlush
- Defined in sdk-trace/build/src/export/BatchSpanProcessorBase.d.ts:23

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 BatchSpanProcessor.onEnd
- Defined in sdk-trace/build/src/export/BatchSpanProcessorBase.d.ts:25

`Protected`onShutdown

onShutdown(): void
Returns void
Inherited from BatchSpanProcessor.onShutdown
- Defined in sdk-trace/build/src/platform/node/export/BatchSpanProcessor.d.ts:4

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 BatchSpanProcessor.onStart
- Defined in sdk-trace/build/src/export/BatchSpanProcessorBase.d.ts:24

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 BatchSpanProcessor.shutdown
- Defined in sdk-trace/build/src/export/BatchSpanProcessorBase.d.ts:26