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

java.lang.Object

io.helidon.tracing.ExtendedTracerConfig.BuilderBase<BUILDER, PROTOTYPE>

io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracerConfig.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>

Direct Known Subclasses:

OpenTelemetryTracerConfig.Builder

Enclosing interface:

OpenTelemetryTracerConfig

public abstract static class OpenTelemetryTracerConfig.BuilderBase<BUILDER extends OpenTelemetryTracerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenTelemetryTracerConfig>
extends ExtendedTracerConfig.BuilderBase<BUILDER, PROTOTYPE>
implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER, PROTOTYPE>

Fluent API builder base for OpenTelemetryTracerConfig.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class ExtendedTracerConfig.BuilderBase

ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BUILDER	addPropagator(io.opentelemetry.context.propagation.TextMapPropagator propagator)	Context propagators.
BUILDER	addPropagators(List<? extends io.opentelemetry.context.propagation.TextMapPropagator> propagators)	Context propagators.
BUILDER	addSpanListener(SpanListener spanListener)	Span listeners to be notified of span life cycle events.
BUILDER	addSpanListeners(List<? extends SpanListener> spanListeners)	Span listeners to be notified of span life cycle events.
BUILDER	addTracerTag(String name, boolean value)	Adds a boolean-valued tag.
BUILDER	addTracerTag(String name, Number value)	Adds a numeric-valued tag.
BUILDER	addTracerTag(String name, String value)	Adds a string-valued tag.
BUILDER	clearPropagators()	Clear all propagators.
BUILDER	clearSpanListeners()	Clear all spanListeners.
BUILDER	config(Config config)	Update builder from configuration (node of this type).
OtlpExporterProtocolType	exporterType()	Type of OTLP exporter to use for pushing span data.
BUILDER	exporterType(OtlpExporterProtocolType exporterType)	Type of OTLP exporter to use for pushing span data.
BUILDER	from(OpenTelemetryTracerConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(OpenTelemetryTracerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
List<io.opentelemetry.context.propagation.TextMapPropagator>	propagators()	Context propagators.
BUILDER	propagators(List<? extends io.opentelemetry.context.propagation.TextMapPropagator> propagators)	Context propagators.
BUILDER	register(SpanListener spanListener)	Adds a SpanListener to the builder for later registration with the resulting Tracer.
List<SpanListener>	spanListeners()	Span listeners to be notified of span life cycle events.
BUILDER	spanListeners(List<? extends SpanListener> spanListeners)	Span listeners to be notified of span life cycle events.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class ExtendedTracerConfig.BuilderBase

addBooleanTracerTags, addIntTracerTags, addTracerTags, booleanTracerTags, booleanTracerTags, clearClientCertificate, clearCollectorHost, clearCollectorPath, clearCollectorPort, clearCollectorProtocol, clearCollectorUri, clearPrivateKey, clearTrustedCertificate, clientCertificate, clientCertificate, clientCertificate, clientCertificate, clientCertificate, collectorHost, collectorHost, collectorPath, collectorPath, collectorPort, collectorPort, collectorProtocol, collectorProtocol, collectorUri, collectorUri, config, enabled, enabled, exportTimeout, exportTimeout, from, from, intTracerTags, intTracerTags, maxExportBatchSize, maxExportBatchSize, maxQueueSize, maxQueueSize, privateKey, privateKey, privateKey, privateKey, privateKey, putBooleanTracerTag, putIntTracerTag, putTracerTag, registered, registered, registerGlobal, registerGlobal, samplerParam, samplerParam, samplerType, samplerType, scheduleDelay, scheduleDelay, serviceName, serviceName, spanProcessorType, spanProcessorType, tracerTags, tracerTags, trustedCertificate, trustedCertificate, trustedCertificate, trustedCertificate, trustedCertificate

Modifier and Type	Method	Description
BUILDER	addBooleanTracerTags(Map<String,Boolean> booleanTracerTags)	Tracer-level tags with boolean values added to all reported spans.
BUILDER	addIntTracerTags(Map<String,Integer> intTracerTags)	Tracer level tags with integer values added to all reported spans.
BUILDER	addTracerTags(Map<String,String> tracerTags)	Tracer-level tags with String values added to all reported spans.
Map<String,Boolean>	booleanTracerTags()	Tracer-level tags with boolean values added to all reported spans.
BUILDER	booleanTracerTags(Map<String,Boolean> booleanTracerTags)	Tracer-level tags with boolean values added to all reported spans.
BUILDER	clearClientCertificate()	Clear existing value of clientCertificate.
BUILDER	clearCollectorHost()	Clear existing value of collectorHost.
BUILDER	clearCollectorPath()	Clear existing value of collectorPath.
BUILDER	clearCollectorPort()	Clear existing value of collectorPort.
BUILDER	clearCollectorProtocol()	Clear existing value of collectorProtocol.
BUILDER	clearCollectorUri()	Clear existing value of collectorUri.
BUILDER	clearPrivateKey()	Clear existing value of privateKey.
BUILDER	clearTrustedCertificate()	Clear existing value of trustedCertificate.
Optional<Resource>	clientCertificate()	Client certificate for connecting securely to the tracing collector.
BUILDER	clientCertificate(Resource clientCertificate)	Client certificate for connecting securely to the tracing collector.
BUILDER	clientCertificate(ResourceConfig clientCertificate)	Client certificate for connecting securely to the tracing collector.
BUILDER	clientCertificate(Consumer<ResourceConfig.Builder> consumer)	Client certificate for connecting securely to the tracing collector.
BUILDER	clientCertificate(Supplier<? extends Resource> supplier)	Client certificate for connecting securely to the tracing collector.
Optional<String>	collectorHost()	Host used in connecting to the tracing collector.
BUILDER	collectorHost(String collectorHost)	Host used in connecting to the tracing collector.
Optional<String>	collectorPath()	Path at the collector host and port used when sending trace data to the collector.
BUILDER	collectorPath(String collectorPath)	Path at the collector host and port used when sending trace data to the collector.
Optional<Integer>	collectorPort()	Port used in connecting to the tracing collector.
BUILDER	collectorPort(int collectorPort)	Port used in connecting to the tracing collector.
Optional<String>	collectorProtocol()	Protocol (such as http or https) used in connecting to the tracing collector.
BUILDER	collectorProtocol(String collectorProtocol)	Protocol (such as http or https) used in connecting to the tracing collector.
Optional<URI>	collectorUri()	URI for the collector to which to send tracing data.
BUILDER	collectorUri(URI collectorUri)	URI for the collector to which to send tracing data.
protected Optional<Config>	config()	Configuration used to configure this instance.
boolean	enabled()	Whether to enable tracing.
BUILDER	enabled(boolean enabled)	Whether to enable tracing.
Duration	exportTimeout()	Maximum time a transmission can be in progress before being cancelled.
BUILDER	exportTimeout(Duration exportTimeout)	Maximum time a transmission can be in progress before being cancelled.
BUILDER	from(ExtendedTracerConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(ExtendedTracerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Map<String,Integer>	intTracerTags()	Tracer level tags with integer values added to all reported spans.
BUILDER	intTracerTags(Map<String,Integer> intTracerTags)	Tracer level tags with integer values added to all reported spans.
int	maxExportBatchSize()	Maximum number of spans grouped for transmission together; typically does not exceed ExtendedTracerConfig.BuilderBase.maxQueueSize() (batch processing).
BUILDER	maxExportBatchSize(int maxExportBatchSize)	Maximum number of spans grouped for transmission together; typically does not exceed ExtendedTracerConfig.BuilderBase.maxQueueSize() (batch processing).
int	maxQueueSize()	Maximum number of spans retained before discarding any not sent to the tracing collector (batch processing).
BUILDER	maxQueueSize(int maxQueueSize)	Maximum number of spans retained before discarding any not sent to the tracing collector (batch processing).
Optional<Resource>	privateKey()	Private key for connecting securely to the tracing collector.
BUILDER	privateKey(Resource privateKey)	Private key for connecting securely to the tracing collector.
BUILDER	privateKey(ResourceConfig privateKey)	Private key for connecting securely to the tracing collector.
BUILDER	privateKey(Consumer<ResourceConfig.Builder> consumer)	Private key for connecting securely to the tracing collector.
BUILDER	privateKey(Supplier<? extends Resource> supplier)	Private key for connecting securely to the tracing collector.
BUILDER	putBooleanTracerTag(String key, Boolean booleanTracerTag)	Tracer-level tags with boolean values added to all reported spans.
BUILDER	putIntTracerTag(String key, Integer intTracerTag)	Tracer level tags with integer values added to all reported spans.
BUILDER	putTracerTag(String key, String tracerTag)	Tracer-level tags with String values added to all reported spans.
boolean	registered()	Whether this tracer configuration should be treated as an application-wide ownership candidate when it is resolved from the Helidon service registry.
BUILDER	registered(boolean registered)	Whether this tracer configuration should be treated as an application-wide ownership candidate when it is resolved from the Helidon service registry.
boolean	registerGlobal()	Whether the OpenTelemetry instance created from this configuration should be published as the OpenTelemetry global; if an OpenTelemetry global already exists, Helidon leaves it unchanged and uses the existing global as the application OpenTelemetry instance.
BUILDER	registerGlobal(boolean registerGlobal)	Whether the OpenTelemetry instance created from this configuration should be published as the OpenTelemetry global; if an OpenTelemetry global already exists, Helidon leaves it unchanged and uses the existing global as the application OpenTelemetry instance.
double	samplerParam()	Parameter value used by the selected sampler; interpretation depends on the sampler type..
BUILDER	samplerParam(double samplerParam)	Parameter value used by the selected sampler; interpretation depends on the sampler type..
SamplerType	samplerType()	Type of sampler for collecting spans.
BUILDER	samplerType(SamplerType samplerType)	Type of sampler for collecting spans.
Duration	scheduleDelay()	Delay between consecutive transmissions to the tracing collector (batch processing).
BUILDER	scheduleDelay(Duration scheduleDelay)	Delay between consecutive transmissions to the tracing collector (batch processing).
Optional<String>	serviceName()	Service name of the traced service.
BUILDER	serviceName(String serviceName)	Service name of the traced service.
SpanProcessorType	spanProcessorType()	Type of span processor for accumulating spans before transmission to the tracing collector.
BUILDER	spanProcessorType(SpanProcessorType spanProcessorType)	Type of span processor for accumulating spans before transmission to the tracing collector.
Map<String,String>	tracerTags()	Tracer-level tags with String values added to all reported spans.
BUILDER	tracerTags(Map<String,String> tracerTags)	Tracer-level tags with String values added to all reported spans.
Optional<Resource>	trustedCertificate()	Trusted certificates for connecting to the tracing collector.
BUILDER	trustedCertificate(Resource trustedCertificate)	Trusted certificates for connecting to the tracing collector.
BUILDER	trustedCertificate(ResourceConfig trustedCertificate)	Trusted certificates for connecting to the tracing collector.
BUILDER	trustedCertificate(Consumer<ResourceConfig.Builder> consumer)	Trusted certificates for connecting to the tracing collector.
BUILDER	trustedCertificate(Supplier<? extends Resource> supplier)	Trusted certificates for connecting to the tracing collector.

Methods inherited from class Object

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

Methods inherited from interface Prototype.Builder

buildPrototype, self

Modifier and Type	Method	Description
PROTOTYPE	buildPrototype()	Create an instance of the Prototype.
default BUILDER	self()	Instance of this builder as the correct type.

Constructor Details

BuilderBase

protected BuilderBase()

Protected to support extensibility.

Method Details

from

public BUILDER from(OpenTelemetryTracerConfig 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(OpenTelemetryTracerConfig.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

addTracerTag

public BUILDER addTracerTag(String name,
 String value)

Adds a string-valued tag.

Parameters:

name - tag name

value - tag value

Returns:

updated builder instance

addTracerTag

public BUILDER addTracerTag(String name,
 Number value)

Adds a numeric-valued tag.

Parameters:

name - tag name

value - tag value

Returns:

updated builder instance

addTracerTag

public BUILDER addTracerTag(String name,
 boolean value)

Adds a boolean-valued tag.

Parameters:

name - tag name

value - tag value

Returns:

updated builder instance

register

public BUILDER register(SpanListener spanListener)

Adds a SpanListener to the builder for later registration with the resulting Tracer.

Parameters:

spanListener - SpanListener to add to the Tracer built from the 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 OpenTelemetryTracerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenTelemetryTracerConfig>

Overrides:

config in class ExtendedTracerConfig.BuilderBase<BUILDER extends OpenTelemetryTracerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenTelemetryTracerConfig>

Parameters:

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

Returns:

updated builder instance

clearPropagators

public BUILDER clearPropagators()

Clear all propagators.

Returns:

updated builder instance

See Also:

• propagators()

propagators

public BUILDER propagators(List<? extends io.opentelemetry.context.propagation.TextMapPropagator> propagators)

Context propagators.

Parameters:

propagators - context propagators

Returns:

updated builder instance

See Also:

• propagators()

addPropagators

public BUILDER addPropagators(List<? extends io.opentelemetry.context.propagation.TextMapPropagator> propagators)

Context propagators.

Parameters:

propagators - context propagators

Returns:

updated builder instance

See Also:

• propagators()

addPropagator

public BUILDER addPropagator(io.opentelemetry.context.propagation.TextMapPropagator propagator)

Context propagators.

Parameters:

propagator - add single context propagators

Returns:

updated builder instance

See Also:

• propagators()

exporterType

public BUILDER exporterType(OtlpExporterProtocolType exporterType)

Type of OTLP exporter to use for pushing span data.

Parameters:

exporterType - OTLP exporter type

Returns:

updated builder instance

See Also:

• exporterType()

clearSpanListeners

public BUILDER clearSpanListeners()

Clear all spanListeners.

Returns:

updated builder instance

See Also:

• spanListeners()

spanListeners

public BUILDER spanListeners(List<? extends SpanListener> spanListeners)

Span listeners to be notified of span life cycle events.

Parameters:

spanListeners - span listeners

Returns:

updated builder instance

See Also:

• spanListeners()

addSpanListeners

public BUILDER addSpanListeners(List<? extends SpanListener> spanListeners)

Span listeners to be notified of span life cycle events.

Parameters:

spanListeners - span listeners

Returns:

updated builder instance

See Also:

• spanListeners()

addSpanListener

public BUILDER addSpanListener(SpanListener spanListener)

Span listeners to be notified of span life cycle events.

Parameters:

spanListener - add single span listeners

Returns:

updated builder instance

See Also:

• spanListeners()

propagators

public List<io.opentelemetry.context.propagation.TextMapPropagator> propagators()

Context propagators.

Returns:

context propagators

exporterType

public OtlpExporterProtocolType exporterType()

Type of OTLP exporter to use for pushing span data.

Returns:

OTLP exporter type

spanListeners

public List<SpanListener> spanListeners()

Span listeners to be notified of span life cycle events.

Returns:

span listeners

toString

public String toString()

Overrides:

toString in class ExtendedTracerConfig.BuilderBase<BUILDER extends OpenTelemetryTracerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenTelemetryTracerConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class ExtendedTracerConfig.BuilderBase<BUILDER extends OpenTelemetryTracerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenTelemetryTracerConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class ExtendedTracerConfig.BuilderBase<BUILDER extends OpenTelemetryTracerConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OpenTelemetryTracerConfig>