io.opentelemetry.sdk.trace.export

Class BatchSpansProcessor.Builder

java.lang.Object

io.opentelemetry.sdk.trace.export.BatchSpansProcessor.Builder

Enclosing class:

BatchSpansProcessor

public static final class BatchSpansProcessor.Builder
extends Object

Builder class for BatchSpansProcessor.

Method Summary

Modifier and Type	Method and Description
BatchSpansProcessor	build() Returns a new BatchSpansProcessor that batches, then converts spans to proto and forwards them to the given spanExporter.
BatchSpansProcessor.Builder	reportOnlySampled(boolean sampled) Set whether only sampled spans should be reported.
BatchSpansProcessor.Builder	setExporterTimeoutMillis(int exporterTimeoutMillis) Sets the maximum time an exporter will be allowed to run before being cancelled.
BatchSpansProcessor.Builder	setMaxExportBatchSize(int maxExportBatchSize) Sets the maximum batch size for every export.
BatchSpansProcessor.Builder	setMaxQueueSize(int maxQueueSize) Sets the maximum number of Spans that are kept in the queue before start dropping.
BatchSpansProcessor.Builder	setScheduleDelayMillis(long scheduleDelayMillis) Sets the delay interval between two consecutive exports.

Methods inherited from class java.lang.Object

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

Method Detail

reportOnlySampled

public BatchSpansProcessor.Builder reportOnlySampled(boolean sampled)

Set whether only sampled spans should be reported.

Parameters:

sampled - report only sampled spans.

Returns:

this.

setScheduleDelayMillis

public BatchSpansProcessor.Builder setScheduleDelayMillis(long scheduleDelayMillis)

Sets the delay interval between two consecutive exports. The actual interval may be shorter if the batch size is getting larger than maxQueuedSpans / 2.

Default value is 5000ms.

Parameters:

scheduleDelayMillis - the delay interval between two consecutive exports.

Returns:

this.

setExporterTimeoutMillis

public BatchSpansProcessor.Builder setExporterTimeoutMillis(int exporterTimeoutMillis)

Sets the maximum time an exporter will be allowed to run before being cancelled.

Default value is 30000ms

Parameters:

exporterTimeoutMillis - the timeout for exports in milliseconds.

Returns:

this

setMaxQueueSize

public BatchSpansProcessor.Builder setMaxQueueSize(int maxQueueSize)

Sets the maximum number of Spans that are kept in the queue before start dropping.

See the BatchSampledSpansProcessor class description for a high-level design description of this class.

Default value is 2048.

Parameters:

maxQueueSize - the maximum number of Spans that are kept in the queue before start dropping.

Returns:

this.

setMaxExportBatchSize

public BatchSpansProcessor.Builder setMaxExportBatchSize(int maxExportBatchSize)

Sets the maximum batch size for every export. This must be smaller or equal to maxQueuedSpans.

Default value is 512.

Parameters:

maxExportBatchSize - the maximum batch size for every export.

Returns:

this.

build

public BatchSpansProcessor build()

Returns a new BatchSpansProcessor that batches, then converts spans to proto and forwards them to the given spanExporter.

Returns:

a new BatchSpansProcessor.

Throws:

NullPointerException - if the spanExporter is null.