Module io.helidon.telemetry.otelconfig

Package io.helidon.telemetry.otelconfig

Class BatchSpanProcessorConfig.BuilderBase<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>

java.lang.Object

io.helidon.telemetry.otelconfig.SpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.telemetry.otelconfig.BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>

Type Parameters:

BUILDER - type of the builder extending this abstract builder

PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()

All Implemented Interfaces:

Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Direct Known Subclasses:

BatchSpanProcessorConfig.Builder

Enclosing interface:

BatchSpanProcessorConfig

public abstract static class BatchSpanProcessorConfig.BuilderBase<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>
extends SpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for BatchSpanProcessorConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BatchSpanProcessorConfig.BuilderBase.BatchSpanProcessorConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class io.helidon.telemetry.otelconfig.SpanProcessorConfig.BuilderBase

SpanProcessorConfig.BuilderBase.SpanProcessorConfigImpl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	clearMaxExportBatchSize()	Clear existing value of this property.
BUILDER	clearMaxQueueSize()	Clear existing value of this property.
BUILDER	clearScheduleDelay()	Clear existing value of this property.
BUILDER	clearTimeout()	Clear existing value of this property.
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
BUILDER	from(BatchSpanProcessorConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(BatchSpanProcessorConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<Integer>	maxExportBatchSize()	Maximum number of spans batched for export together.
BUILDER	maxExportBatchSize(int maxExportBatchSize)	Maximum number of spans batched for export together.
Optional<Integer>	maxQueueSize()	Maximum number of spans retained before discarding excess unexported ones.
BUILDER	maxQueueSize(int maxQueueSize)	Maximum number of spans retained before discarding excess unexported ones.
protected void	preBuildPrototype()	Handles providers and decorators.
Optional<Duration>	scheduleDelay()	Delay between consecutive exports.
BUILDER	scheduleDelay(Duration scheduleDelay)	Delay between consecutive exports.
Optional<Duration>	timeout()	Maximum time an export can run before being cancelled.
BUILDER	timeout(Duration timeout)	Maximum time an export can run before being cancelled.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class io.helidon.telemetry.otelconfig.SpanProcessorConfig.BuilderBase

addExporters, exporters, exporters, from, from, type, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

buildPrototype, self

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(BatchSpanProcessorConfig prototype)

Update this builder from an existing prototype instance. This method disables automatic service discovery.

Parameters:

prototype - existing prototype to update this builder from

Returns:

updated builder instance

from

public BUILDER from(BatchSpanProcessorConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Parameters:

builder - existing builder prototype to update this builder from

Returns:

updated builder instance

config

@Deprecated
public BUILDER config(Config config)

Deprecated.

use config(io.helidon.config.Config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>

Overrides:

config in class SpanProcessorConfig.BuilderBase<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

config

public BUILDER config(Config config)

Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.

Specified by:

config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>

Overrides:

config in class SpanProcessorConfig.BuilderBase<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

clearScheduleDelay

public BUILDER clearScheduleDelay()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• scheduleDelay()

scheduleDelay

public BUILDER scheduleDelay(Duration scheduleDelay)

Delay between consecutive exports.

Parameters:

scheduleDelay - delay between consecutive exports

Returns:

updated builder instance

See Also:

• scheduleDelay()

clearMaxQueueSize

public BUILDER clearMaxQueueSize()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• maxQueueSize()

maxQueueSize

public BUILDER maxQueueSize(int maxQueueSize)

Maximum number of spans retained before discarding excess unexported ones.

Parameters:

maxQueueSize - maximum number of spans kept

Returns:

updated builder instance

See Also:

• maxQueueSize()

clearMaxExportBatchSize

public BUILDER clearMaxExportBatchSize()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• maxExportBatchSize()

maxExportBatchSize

public BUILDER maxExportBatchSize(int maxExportBatchSize)

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

Parameters:

maxExportBatchSize - maximum number of spans batched

Returns:

updated builder instance

See Also:

• maxExportBatchSize()

clearTimeout

public BUILDER clearTimeout()

Clear existing value of this property.

Returns:

updated builder instance

See Also:

• timeout()

timeout

public BUILDER timeout(Duration timeout)

Maximum time an export can run before being cancelled.

Parameters:

timeout - maximum export time

Returns:

updated builder instance

See Also:

• timeout()

scheduleDelay

public Optional<Duration> scheduleDelay()

Delay between consecutive exports.

Returns:

the schedule delay

maxQueueSize

public Optional<Integer> maxQueueSize()

Maximum number of spans retained before discarding excess unexported ones.

Returns:

the max queue size

maxExportBatchSize

public Optional<Integer> maxExportBatchSize()

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

Returns:

the max export batch size

timeout

public Optional<Duration> timeout()

Maximum time an export can run before being cancelled.

Returns:

the timeout

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Overrides:

config in class SpanProcessorConfig.BuilderBase<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>

Returns:

config node used to configure this builder, or empty if not configured

toString

public String toString()

Overrides:

toString in class SpanProcessorConfig.BuilderBase<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class SpanProcessorConfig.BuilderBase<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class SpanProcessorConfig.BuilderBase<BUILDER extends BatchSpanProcessorConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends BatchSpanProcessorConfig>