io.opentelemetry.sdk.trace.export

Class BatchSpansProcessor

java.lang.Object

io.opentelemetry.sdk.trace.export.BatchSpansProcessor

All Implemented Interfaces:

SpanProcessor

public final class BatchSpansProcessor
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, after the size is reached spans are dropped) and exported every scheduleDelayMillis to the exporter pipeline in batches of maxExportBatchSize.

If the queue gets half full a preemptive notification is sent to the worker thread that exports the spans to wake up and start a new export cycle.

This batch SpanProcessor can cause high contention in a very high traffic service. TODO: Add a link to the SpanProcessor that uses Disruptor as alternative with low contention.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchSpansProcessor.Builder Builder class for BatchSpansProcessor.

Method Summary

Modifier and Type	Method and Description
void	forceFlush() Processes all span events that have not yet been processed.
boolean	isEndRequired() Returns true if this SpanProcessor requires end events.
boolean	isStartRequired() Returns true if this SpanProcessor requires start events.
static BatchSpansProcessor.Builder	newBuilder(SpanExporter spanExporter) Returns a new Builder for BatchSpansProcessor.
void	onEnd(ReadableSpan span) Called when a Span is ended, if the Span.isRecording() returns true.
void	onStart(ReadableSpan span) Called when a Span is started, if the Span.isRecording() returns true.
void	shutdown() Called when TracerSdkProvider.shutdown() is called.

Methods inherited from class java.lang.Object

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

Method Detail

onStart

public void onStart(ReadableSpan 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:

span - the ReadableSpan 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 ReadableSpan 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 void shutdown()

Description copied from interface: SpanProcessor

Called when TracerSdkProvider.shutdown() is called.

Implementations must ensure that all span events are processed before returning.

Specified by:

shutdown in interface SpanProcessor

forceFlush

public void forceFlush()

Description copied from interface: SpanProcessor

Processes all span events that have not yet been processed.

This method is called synchronously on the execution thread, and should not throw exceptions.

Specified by:

forceFlush in interface SpanProcessor

newBuilder

public static BatchSpansProcessor.Builder newBuilder(SpanExporter spanExporter)

Returns a new Builder for BatchSpansProcessor.

Parameters:

spanExporter - the SpanExporter to where the Spans are pushed.

Returns:

a new BatchSpansProcessor.

Throws:

NullPointerException - if the spanExporter is null.