Package io.opentelemetry.sdk.trace.export

Class BatchSpanProcessorBuilder

java.lang.Object

io.opentelemetry.sdk.common.export.ConfigBuilder<BatchSpanProcessorBuilder>

io.opentelemetry.sdk.trace.export.BatchSpanProcessorBuilder

public final class BatchSpanProcessorBuilder
extends io.opentelemetry.sdk.common.export.ConfigBuilder<BatchSpanProcessorBuilder>

Builder class for BatchSpanProcessor.

Nested Class Summary

Nested classes/interfaces inherited from class io.opentelemetry.sdk.common.export.ConfigBuilder

io.opentelemetry.sdk.common.export.ConfigBuilder.NamingConvention

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.
protected BatchSpanProcessorBuilder	fromConfigMap(Map<String,String> configMap, io.opentelemetry.sdk.common.export.ConfigBuilder.NamingConvention namingConvention)	Sets the configuration values from the given configuration map for only the available keys.
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	setExporterTimeoutMillis(int exporterTimeoutMillis)	Deprecated. Use setExporterTimeout(long, TimeUnit)
BatchSpanProcessorBuilder	setExportOnlySampled(boolean exportOnlySampled)	Set whether only sampled spans should be reported.
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.
BatchSpanProcessorBuilder	setScheduleDelayMillis(long scheduleDelayMillis)	Deprecated. Use setScheduleDelay(long, TimeUnit)

Methods inherited from class io.opentelemetry.sdk.common.export.ConfigBuilder

getBooleanProperty, getDoubleProperty, getIntProperty, getLongProperty, getStringProperty, readEnvironmentVariables, readProperties, readSystemProperties

Methods inherited from class java.lang.Object

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

Method Detail

fromConfigMap

protected BatchSpanProcessorBuilder fromConfigMap(Map<String,String> configMap,
                                                  io.opentelemetry.sdk.common.export.ConfigBuilder.NamingConvention namingConvention)

Sets the configuration values from the given configuration map for only the available keys.

Specified by:

fromConfigMap in class io.opentelemetry.sdk.common.export.ConfigBuilder<BatchSpanProcessorBuilder>

Parameters:

configMap - Map holding the configuration values.

Returns:

this.

setExportOnlySampled

public BatchSpanProcessorBuilder setExportOnlySampled(boolean exportOnlySampled)

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.

setScheduleDelayMillis

@Deprecated
public BatchSpanProcessorBuilder setScheduleDelayMillis(long scheduleDelayMillis)

Deprecated.

Use setScheduleDelay(long, TimeUnit)

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.

See Also:

DEFAULT_SCHEDULE_DELAY_MILLIS

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.

setExporterTimeoutMillis

@Deprecated
public BatchSpanProcessorBuilder setExporterTimeoutMillis(int exporterTimeoutMillis)

Deprecated.

Use setExporterTimeout(long, TimeUnit)

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

See Also:

DEFAULT_EXPORT_TIMEOUT_MILLIS

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.