Package io.helidon.telemetry.otelconfig
Interface HelidonOpenTelemetry
- All Superinterfaces:
RuntimeType.Api<OpenTelemetryConfig>
Public access to OpenTelemetry as managed via Helidon config and builders.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringTop-level config key for telemetry settings. -
Method Summary
Modifier and TypeMethodDescriptionstatic OpenTelemetryConfig.Builderbuilder()Creates a new builder forHelidonOpenTelemetry.static HelidonOpenTelemetrycreate(OpenTelemetryConfig config) Creates a newHelidonOpenTelemetryfrom config.static HelidonOpenTelemetrycreate(Consumer<OpenTelemetryConfig.Builder> consumer) Builds a newHelidonOpenTelemetryinstance by revising and then building the supplied builder.static voidglobal(io.opentelemetry.api.OpenTelemetry openTelemetry, String serviceName, Map<String, String> tags) Initializes the specifiedOpenTelemetryinstance as global: Sets it as the global OpenTelemetry instance. Creates a new HelidonTracerusing theOpenTelemetryinstance. Makes the HelidonTracerthe global tracer. Registers theOpenTelemetryinstance in the Helidon service registry.io.opentelemetry.api.OpenTelemetryReturns theOpenTelemetryinstance managed by Helidon.Methods inherited from interface io.helidon.builder.api.RuntimeType.Api
prototype
-
Field Details
-
CONFIG_KEY
Top-level config key for telemetry settings.- See Also:
-
-
Method Details
-
builder
Creates a new builder forHelidonOpenTelemetry.- Returns:
- new builder
-
create
Creates a newHelidonOpenTelemetryfrom config.- Parameters:
config- the config node to use in building the result- Returns:
- new
HelidonOpenTelemetrybased on the supplied config
-
create
Builds a newHelidonOpenTelemetryinstance by revising and then building the supplied builder.- Parameters:
consumer- consumer of a builder forHelidonOpenTelemetry- Returns:
- new instance
-
global
static void global(io.opentelemetry.api.OpenTelemetry openTelemetry, String serviceName, Map<String, String> tags) throws IllegalStateExceptionInitializes the specifiedOpenTelemetryinstance as global:- Sets it as the global OpenTelemetry instance.
- Creates a new Helidon
Tracerusing theOpenTelemetryinstance. - Makes the Helidon
Tracerthe global tracer. - Registers the
OpenTelemetryinstance in the Helidon service registry.
- Parameters:
openTelemetry- theOpenTelemetryinstance to make globalserviceName- service name with which to create the new global tracertags- tags to be applied to every span- Throws:
IllegalStateException- if other code has already established the OpenTelemetry global instance
-
openTelemetry
io.opentelemetry.api.OpenTelemetry openTelemetry()Returns theOpenTelemetryinstance managed by Helidon.- Returns:
- the OpenTelemetry instance
-