Package io.opentelemetry.sdk.trace.export

Class BatchSpanProcessor

java.lang.Object

io.opentelemetry.sdk.trace.export.BatchSpanProcessor

All Implemented Interfaces:

SpanProcessor, Closeable, AutoCloseable

public final class BatchSpanProcessor
extends Object
implements SpanProcessor

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

All spans reported by the SDK implementation are first added to a synchronized queue (with a maxQueueSize maximum size, if queue is full spans are dropped). Spans are exported either when there are maxExportBatchSize pending spans or scheduleDelayNanos has passed since the last export finished.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	BatchSpanProcessor.Worker

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	exportUnsampledSpans
private final AtomicBoolean	isShutdown
private static final Logger	logger
private static final AttributeKey<Boolean>	SPAN_PROCESSOR_DROPPED_LABEL
private static final AttributeKey<String>	SPAN_PROCESSOR_TYPE_LABEL
private static final String	SPAN_PROCESSOR_TYPE_VALUE
private final BatchSpanProcessor.Worker	worker
private static final String	WORKER_THREAD_NAME

Constructor Summary

Constructors

Constructor	Description
BatchSpanProcessor(SpanExporter spanExporter, boolean exportUnsampledSpans, MeterProvider meterProvider, long scheduleDelayNanos, int maxQueueSize, int maxExportBatchSize, long exporterTimeoutNanos)

Method Summary

Modifier and Type	Method	Description
static BatchSpanProcessorBuilder	builder(SpanExporter spanExporter)	Returns a new Builder for BatchSpanProcessor.
CompletableResultCode	forceFlush()	Processes all span events that have not yet been processed.
(package private) List<SpanData>	getBatch()
(package private) Queue<ReadableSpan>	getQueue()
SpanExporter	getSpanExporter()	Return the processor's configured SpanExporter.
boolean	isEndRequired()	Returns true if this SpanProcessor requires end events.
boolean	isStartRequired()	Returns true if this SpanProcessor requires start events.
void	onEnd(ReadableSpan span)	Called when a Span is ended, if the Span.isRecording() returns true.
void	onStart(Context parentContext, ReadWriteSpan span)	Called when a Span is started, if the Span.isRecording() returns true.
CompletableResultCode	shutdown()	Processes all span events that have not yet been processed and closes used resources.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.opentelemetry.sdk.trace.SpanProcessor

close

Field Details

logger

private static final Logger logger

WORKER_THREAD_NAME

private static final String WORKER_THREAD_NAME

SPAN_PROCESSOR_TYPE_LABEL

private static final AttributeKey<String> SPAN_PROCESSOR_TYPE_LABEL

SPAN_PROCESSOR_DROPPED_LABEL

private static final AttributeKey<Boolean> SPAN_PROCESSOR_DROPPED_LABEL

SPAN_PROCESSOR_TYPE_VALUE

private static final String SPAN_PROCESSOR_TYPE_VALUE

exportUnsampledSpans

private final boolean exportUnsampledSpans

worker

private final BatchSpanProcessor.Worker worker

isShutdown

private final AtomicBoolean isShutdown

Constructor Details

BatchSpanProcessor

BatchSpanProcessor(SpanExporter spanExporter,
 boolean exportUnsampledSpans,
 MeterProvider meterProvider,
 long scheduleDelayNanos,
 int maxQueueSize,
 int maxExportBatchSize,
 long exporterTimeoutNanos)

Method Details

builder

public static BatchSpanProcessorBuilder builder(SpanExporter spanExporter)

Returns a new Builder for BatchSpanProcessor.

Parameters:

spanExporter - the SpanExporter to which the Spans are pushed.

Returns:

a new BatchSpanProcessorBuilder.

Throws:

NullPointerException - if the spanExporter is null.

onStart

public void onStart(Context parentContext,
 ReadWriteSpan span)

Description copied from interface: SpanProcessor

Called when a Span is started, if the Span.isRecording() returns true.

This method is called synchronously on the execution thread, should not throw or block the execution thread.

Specified by:

onStart in interface SpanProcessor

Parameters:

parentContext - the parent Context of the span that just started.

span - the Span that just started.

isStartRequired

public boolean isStartRequired()

Description copied from interface: SpanProcessor

Returns true if this SpanProcessor requires start events.

Specified by:

isStartRequired in interface SpanProcessor

Returns:

true if this SpanProcessor requires start events.

onEnd

public void onEnd(ReadableSpan span)

Description copied from interface: SpanProcessor

Called when a Span is ended, if the Span.isRecording() returns true.

This method is called synchronously on the execution thread, should not throw or block the execution thread.

Specified by:

onEnd in interface SpanProcessor

Parameters:

span - the Span that just ended.

isEndRequired

public boolean isEndRequired()

Description copied from interface: SpanProcessor

Returns true if this SpanProcessor requires end events.

Specified by:

isEndRequired in interface SpanProcessor

Returns:

true if this SpanProcessor requires end events.

shutdown

public CompletableResultCode shutdown()

Description copied from interface: SpanProcessor

Processes all span events that have not yet been processed and closes used resources.

Specified by:

shutdown in interface SpanProcessor

Returns:

a CompletableResultCode which completes when shutdown is finished.

forceFlush

public CompletableResultCode forceFlush()

Description copied from interface: SpanProcessor

Processes all span events that have not yet been processed.

Specified by:

forceFlush in interface SpanProcessor

Returns:

a CompletableResultCode which completes when currently queued spans are finished processing.

getSpanExporter

public SpanExporter getSpanExporter()

Return the processor's configured SpanExporter.

Since:

1.37.0

getBatch

List<SpanData> getBatch()

getQueue

Queue<ReadableSpan> getQueue()

toString

public String toString()

Overrides:

toString in class Object