Package io.helidon.telemetry.otelconfig
Interface OpenTelemetryConfig
- All Superinterfaces:
Prototype.Api
,Prototype.Factory<HelidonOpenTelemetry>
- All Known Implementing Classes:
OpenTelemetryConfig.BuilderBase.OpenTelemetryConfigImpl
OpenTelemetry settings.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
Fluent API builder forHelidonOpenTelemetry
.static class
OpenTelemetryConfig.BuilderBase<BUILDER extends OpenTelemetryConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends OpenTelemetryConfig> Fluent API builder base forHelidonOpenTelemetry
. -
Method Summary
Modifier and TypeMethodDescriptionstatic OpenTelemetryConfig.Builder
builder()
Create a new fluent API builder to customize configuration.static OpenTelemetryConfig.Builder
builder
(OpenTelemetryConfig instance) Create a new fluent API builder from an existing instance.static OpenTelemetryConfig
Deprecated.static OpenTelemetryConfig
Create a new instance from configuration.boolean
enabled()
Whether the OpenTelemetry support is enabled.boolean
global()
Whether theOpenTelemetry
instance created from this configuration should be made the global one.io.opentelemetry.api.OpenTelemetry
TheOpenTelemetry
instance to use for telemetry.List
<io.opentelemetry.context.propagation.TextMapPropagator> OpenTelemetryTextMapPropagator
instances added explicitly by the app.service()
Service name used in sending telemetry data to the collector.Optional
<io.opentelemetry.api.trace.TracerProvider> Sets the tracer provider that OpenTelemetry should use.OpenTelemetry tracing settings.Methods inherited from interface io.helidon.builder.api.Prototype.Factory
build
-
Method Details
-
builder
Create a new fluent API builder to customize configuration.- Returns:
- a new builder
-
builder
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
Create a new instance from configuration.- Parameters:
config
- used to configure the new instance- Returns:
- a new instance configured from configuration
-
create
Deprecated.Create a new instance from configuration.- Parameters:
config
- used to configure the new instance- Returns:
- a new instance configured from configuration
-
service
String service()Service name used in sending telemetry data to the collector.- Returns:
- service name
-
enabled
boolean enabled()Whether the OpenTelemetry support is enabled.- Returns:
- true if enabled; false otherwise
-
global
boolean global()Whether theOpenTelemetry
instance created from this configuration should be made the global one.- Returns:
- true if the configured instance should be made global; false otherwise
-
propagators
List<io.opentelemetry.context.propagation.TextMapPropagator> propagators()OpenTelemetryTextMapPropagator
instances added explicitly by the app.Default: "tracecontext,baggage".
- Returns:
- propagators
- See Also:
-
tracingConfig
Optional<OpenTelemetryTracingConfig> tracingConfig()OpenTelemetry tracing settings.- Returns:
- tracing settings
-
tracerProvider
Optional<io.opentelemetry.api.trace.TracerProvider> tracerProvider()Sets the tracer provider that OpenTelemetry should use.- Returns:
- OpenTelemetry tracer provider
-
openTelemetry
io.opentelemetry.api.OpenTelemetry openTelemetry()TheOpenTelemetry
instance to use for telemetry.Typically, this value will be the OpenTelemetry SDK instance created using this configuration, but if some other code (such as the OpenTelemetry agent) has already set the OTel global instance, this value will be that global instance.
- Returns:
- the OpenTelemetry instance
-
create(io.helidon.config.Config)