Module io.helidon.tracing.providers.opentelemetry

Package io.helidon.tracing.providers.opentelemetry

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>, 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 io.helidon.tracing.ExtendedTracerConfig.BuilderBase

ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl

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)	Deprecated. use config(io.helidon.config.Config)
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 io.helidon.tracing.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, registerGlobal, registerGlobal, samplerParam, samplerParam, samplerType, samplerType, scheduleDelay, scheduleDelay, serviceName, serviceName, spanProcessorType, spanProcessorType, tracerTags, tracerTags, trustedCertificate, trustedCertificate, trustedCertificate, trustedCertificate, trustedCertificate

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(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

@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 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

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>