Class OpenTelemetryTracerConfig.BuilderBase.OpenTelemetryTracerConfigImpl

java.lang.Object

io.helidon.tracing.ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl

io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracerConfig.BuilderBase.OpenTelemetryTracerConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracer>, ExtendedTracerConfig, OpenTelemetryTracerConfig, Supplier<io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracer>

Enclosing class:

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

protected static class OpenTelemetryTracerConfig.BuilderBase.OpenTelemetryTracerConfigImpl
extends ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl
implements OpenTelemetryTracerConfig, Supplier<io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracer>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface ExtendedTracerConfig

ExtendedTracerConfig.Builder, ExtendedTracerConfig.BuilderBase<BUILDER, PROTOTYPE>

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

Nested classes/interfaces inherited from interface OpenTelemetryTracerConfig

OpenTelemetryTracerConfig.Builder, OpenTelemetryTracerConfig.BuilderBase<BUILDER, PROTOTYPE>

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TRACING_CONFIG_KEY	Config key for tracing settings.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenTelemetryTracerConfigImpl(OpenTelemetryTracerConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracer	build()	Create a new runtime instance from this prototype.
io.opentelemetry.api.trace.Tracer	delegate()	Tracer instance to use instead of constructing one from other config settings.
boolean	equals(Object o)
OtlpExporterProtocolType	exporterType()	Type of OTLP exporter to use for pushing span data.
io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracer	get()
int	hashCode()
io.opentelemetry.api.OpenTelemetry	openTelemetry()	OpenTelemetry instance to use instead of constructing one from other config settings.
io.opentelemetry.context.propagation.TextMapPropagator	propagator()	Typically a composite propagator gathering the propagators assigned.
List<io.opentelemetry.context.propagation.TextMapPropagator>	propagators()	Context propagators.
List<SpanListener>	spanListeners()	Span listeners to be notified of span life cycle events.
List<io.opentelemetry.sdk.trace.SpanProcessor>	spanProcessors()	Span processors added to the implicit one automatically created.
String	toString()

Methods inherited from class ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl

booleanTracerTags, clientCertificate, collectorHost, collectorPath, collectorPort, collectorProtocol, collectorUri, enabled, exportTimeout, intTracerTags, maxExportBatchSize, maxQueueSize, privateKey, registered, registerGlobal, samplerParam, samplerType, scheduleDelay, serviceName, spanProcessorType, tracerTags, trustedCertificate

Modifier and Type	Method	Description
Map<String,Boolean>	booleanTracerTags()	Tracer-level tags with boolean values added to all reported spans.
Optional<Resource>	clientCertificate()	Client certificate for connecting securely to the tracing collector.
Optional<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.
Optional<Integer>	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.
Optional<URI>	collectorUri()	URI for the collector to which to send tracing data.
boolean	enabled()	Whether to enable tracing.
Duration	exportTimeout()	Maximum time a transmission can be in progress before being cancelled.
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.maxQueueSize() (batch processing).
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.
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.
double	samplerParam()	Parameter value used by the selected sampler; interpretation depends on the sampler type..
SamplerType	samplerType()	Type of sampler for collecting spans.
Duration	scheduleDelay()	Delay between consecutive transmissions to the tracing collector (batch processing).
String	serviceName()	Service name of the traced service.
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.
Optional<Resource>	trustedCertificate()	Trusted certificates for connecting to the tracing collector.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TRACING_CONFIG_KEY

static final String TRACING_CONFIG_KEY

Config key for tracing settings.

See Also:

• Constant Field Values

Constructor Details

OpenTelemetryTracerConfigImpl

protected OpenTelemetryTracerConfigImpl(OpenTelemetryTracerConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracer build()

Create a new runtime instance from this prototype.

Specified by:

build in interface Prototype.Factory<io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracer>

Returns:

new configured runtime instance

get

public io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracer get()

Specified by:

get in interface Supplier<io.helidon.tracing.providers.opentelemetry.OpenTelemetryTracer>

propagators

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

Description copied from interface: OpenTelemetryTracerConfig

Context propagators.

Specified by:

propagators in interface OpenTelemetryTracerConfig

Returns:

context propagators

exporterType

public OtlpExporterProtocolType exporterType()

Description copied from interface: OpenTelemetryTracerConfig

Type of OTLP exporter to use for pushing span data.

Specified by:

exporterType in interface OpenTelemetryTracerConfig

Returns:

OTLP exporter type

spanListeners

public List<SpanListener> spanListeners()

Description copied from interface: OpenTelemetryTracerConfig

Span listeners to be notified of span life cycle events.

Specified by:

spanListeners in interface OpenTelemetryTracerConfig

Returns:

span listeners

openTelemetry

public io.opentelemetry.api.OpenTelemetry openTelemetry()

Description copied from interface: OpenTelemetryTracerConfig

OpenTelemetry instance to use instead of constructing one from other config settings.

Specified by:

openTelemetry in interface OpenTelemetryTracerConfig

Returns:

OpenTelemetry instance

delegate

public io.opentelemetry.api.trace.Tracer delegate()

Description copied from interface: OpenTelemetryTracerConfig

Tracer instance to use instead of constructing one from other config settings.

Specified by:

delegate in interface OpenTelemetryTracerConfig

Returns:

Tracer instance

propagator

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

Description copied from interface: OpenTelemetryTracerConfig

Typically a composite propagator gathering the propagators assigned.

Specified by:

propagator in interface OpenTelemetryTracerConfig

Returns:

propagator

spanProcessors

public List<io.opentelemetry.sdk.trace.SpanProcessor> spanProcessors()

Description copied from interface: OpenTelemetryTracerConfig

Span processors added to the implicit one automatically created.

Primarily for testing to enroll a span processor with an in-memory span exporter.

Specified by:

spanProcessors in interface OpenTelemetryTracerConfig

Returns:

span processors

toString

public String toString()

Overrides:

toString in class ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl

equals

public boolean equals(Object o)

Overrides:

equals in class ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl

hashCode

public int hashCode()

Overrides:

hashCode in class ExtendedTracerConfig.BuilderBase.ExtendedTracerConfigImpl