Module io.helidon.tracing.providers.opentelemetry

Package io.helidon.tracing.providers.opentelemetry

Interface OpenTelemetryTracerConfig

All Superinterfaces:

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

All Known Implementing Classes:

OpenTelemetryTracerConfig.BuilderBase.OpenTelemetryTracerConfigImpl

public interface OpenTelemetryTracerConfig
extends Prototype.Api, ExtendedTracerConfig

Settings for OpenTelemetry tracer configuration under the "tracing" config key.

See Also:

• builder()

Nested Class Summary

Nested Classes

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.

Method Summary

Modifier and Type	Method	Description
static OpenTelemetryTracerConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static OpenTelemetryTracerConfig.Builder	builder(OpenTelemetryTracerConfig instance)	Create a new fluent API builder from an existing instance.
static OpenTelemetryTracerConfig	create()	Create a new instance with default values.
static OpenTelemetryTracerConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static OpenTelemetryTracerConfig	create(Config config)	Create a new instance from configuration.
io.opentelemetry.api.trace.Tracer	delegate()	Tracer instance to use instead of constructing one from other config settings.
OtlpExporterProtocolType	exporterType()	Type of OTLP exporter to use for pushing span data.
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.

Methods inherited from interface io.helidon.tracing.ExtendedTracerConfig

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

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

build

Field Details

TRACING_CONFIG_KEY

static final String TRACING_CONFIG_KEY

Config key for tracing settings.

See Also:

• Constant Field Values

Method Details

builder

static OpenTelemetryTracerConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static OpenTelemetryTracerConfig.Builder builder(OpenTelemetryTracerConfig 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 OpenTelemetryTracerConfig 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 OpenTelemetryTracerConfig 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 OpenTelemetryTracerConfig create()

Create a new instance with default values.

Returns:

a new instance

propagators

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

Context propagators.

Returns:

context propagators

exporterType

OtlpExporterProtocolType exporterType()

Type of OTLP exporter to use for pushing span data.

Returns:

OTLP exporter type

spanListeners

List<SpanListener> spanListeners()

Span listeners to be notified of span life cycle events.

Returns:

span listeners

openTelemetry

io.opentelemetry.api.OpenTelemetry openTelemetry()

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

Returns:

OpenTelemetry instance

delegate

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

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

Returns:

Tracer instance

propagator

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

Typically a composite propagator gathering the propagators assigned.

Returns:

propagator

spanProcessors

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

Span processors added to the implicit one automatically created.

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

Returns:

span processors