Module io.helidon.telemetry.otelconfig

Package io.helidon.telemetry.otelconfig

Interface BatchSpanProcessorConfig

All Superinterfaces:

Prototype.Api, SpanProcessorConfig

All Known Implementing Classes:

BatchSpanProcessorConfig.BuilderBase.BatchSpanProcessorConfigImpl

public interface BatchSpanProcessorConfig
extends Prototype.Api, SpanProcessorConfig

Configuration for a batch span processor.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BatchSpanProcessorConfig.Builder	Fluent API builder for BatchSpanProcessorConfig.
static class	BatchSpanProcessorConfig.BuilderBase<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>	Fluent API builder base for BatchSpanProcessorConfig.

Method Summary

Modifier and Type	Method	Description
static BatchSpanProcessorConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static BatchSpanProcessorConfig.Builder	builder(BatchSpanProcessorConfig instance)	Create a new fluent API builder from an existing instance.
static BatchSpanProcessorConfig	create()	Create a new instance with default values.
static BatchSpanProcessorConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static BatchSpanProcessorConfig	create(Config config)	Create a new instance from configuration.
Optional<Integer>	maxExportBatchSize()	Maximum number of spans batched for export together.
Optional<Integer>	maxQueueSize()	Maximum number of spans retained before discarding excess unexported ones.
Optional<Duration>	scheduleDelay()	Delay between consecutive exports.
Optional<Duration>	timeout()	Maximum time an export can run before being cancelled.

Methods inherited from interface io.helidon.telemetry.otelconfig.SpanProcessorConfig

exporters, type

Method Details

builder

static BatchSpanProcessorConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static BatchSpanProcessorConfig.Builder builder(BatchSpanProcessorConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static BatchSpanProcessorConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

@Deprecated
static BatchSpanProcessorConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static BatchSpanProcessorConfig create()

Create a new instance with default values.

Returns:

a new instance

scheduleDelay

Optional<Duration> scheduleDelay()

Delay between consecutive exports.

Returns:

delay between consecutive exports

maxQueueSize

Optional<Integer> maxQueueSize()

Maximum number of spans retained before discarding excess unexported ones.

Returns:

maximum number of spans kept

maxExportBatchSize

Optional<Integer> maxExportBatchSize()

Maximum number of spans batched for export together. OpenTelemetry requires this value to not exceed the maxQueueSize().

Returns:

maximum number of spans batched

timeout

Optional<Duration> timeout()

Maximum time an export can run before being cancelled.

Returns:

maximum export time