Package io.opentelemetry.sdk.trace.export

Class BatchSpanProcessorBuilder

java.lang.Object

io.opentelemetry.sdk.trace.export.BatchSpanProcessorBuilder

public final class BatchSpanProcessorBuilder
extends Object

Builder class for BatchSpanProcessor.

Method Summary

Modifier and Type	Method	Description
BatchSpanProcessor	build()	Returns a new BatchSpanProcessor that batches, then converts spans to proto and forwards them to the given spanExporter.
BatchSpanProcessorBuilder	setExporterTimeout(long timeout, TimeUnit unit)	Sets the maximum time an export will be allowed to run before being cancelled.
BatchSpanProcessorBuilder	setExporterTimeout(Duration timeout)	Sets the maximum time an export will be allowed to run before being cancelled.
BatchSpanProcessorBuilder	setExportOnlySampled(boolean exportOnlySampled)	Deprecated. Will be removed without replacement, all spans with a sampling result of SamplingDecision.RECORD_AND_SAMPLE will be exported while spans with a result of SamplingDecision.RECORD_ONLY will not.
BatchSpanProcessorBuilder	setMaxExportBatchSize(int maxExportBatchSize)	Sets the maximum batch size for every export.
BatchSpanProcessorBuilder	setMaxQueueSize(int maxQueueSize)	Sets the maximum number of Spans that are kept in the queue before start dropping.
BatchSpanProcessorBuilder	setScheduleDelay(long delay, TimeUnit unit)	Sets the delay interval between two consecutive exports.
BatchSpanProcessorBuilder	setScheduleDelay(Duration delay)	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

setExportOnlySampled

@Deprecated
public BatchSpanProcessorBuilder setExportOnlySampled(boolean exportOnlySampled)

Deprecated.

Will be removed without replacement, all spans with a sampling result of SamplingDecision.RECORD_AND_SAMPLE will be exported while spans with a result of SamplingDecision.RECORD_ONLY will not.

Set whether only sampled spans should be reported.

Default value is true.

Parameters:

exportOnlySampled - if true report only sampled spans.

Returns:

this.

See Also:

DEFAULT_EXPORT_ONLY_SAMPLED

setScheduleDelay

public BatchSpanProcessorBuilder setScheduleDelay(long delay,
                                                  TimeUnit unit)

Sets the delay interval between two consecutive exports. If unset, defaults to 5000Lms.

setScheduleDelay

public BatchSpanProcessorBuilder setScheduleDelay(Duration delay)

Sets the delay interval between two consecutive exports. If unset, defaults to 5000Lms.

setExporterTimeout

public BatchSpanProcessorBuilder setExporterTimeout(long timeout,
                                                    TimeUnit unit)

Sets the maximum time an export will be allowed to run before being cancelled. If unset, defaults to 30000ms.

setExporterTimeout

public BatchSpanProcessorBuilder setExporterTimeout(Duration timeout)

Sets the maximum time an export will be allowed to run before being cancelled. If unset, defaults to 30000ms.

setMaxQueueSize

public BatchSpanProcessorBuilder 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.

See Also:

DEFAULT_MAX_QUEUE_SIZE

setMaxExportBatchSize

public BatchSpanProcessorBuilder 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.

See Also:

DEFAULT_MAX_EXPORT_BATCH_SIZE

build

public BatchSpanProcessor build()

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

Returns:

a new BatchSpanProcessor.

Throws:

NullPointerException - if the spanExporter is null.