Interface HelidonOpenTelemetry

All Superinterfaces:

RuntimeType.Api<OpenTelemetryConfig>

public interface HelidonOpenTelemetry
extends RuntimeType.Api<OpenTelemetryConfig>

Public access to OpenTelemetry as managed via Helidon config and builders.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY	Top-level config key for telemetry settings.

Method Summary

Modifier and Type	Method	Description
static OpenTelemetryConfig.Builder	builder()	Creates a new builder for HelidonOpenTelemetry.
static HelidonOpenTelemetry	create(OpenTelemetryConfig config)	Creates a new HelidonOpenTelemetry from config.
static HelidonOpenTelemetry	create(Consumer<OpenTelemetryConfig.Builder> consumer)	Builds a new HelidonOpenTelemetry instance by revising and then building the supplied builder.
static void	global(io.opentelemetry.api.OpenTelemetry openTelemetry, String serviceName, Map<String,String> tags)	Deprecated, for removal: This API element is subject to removal in a future version. Use Services.set(Class, Object[]) to configure a custom telemetry instance, or let Helidon resolve the correct instance.
io.opentelemetry.api.OpenTelemetry	openTelemetry()	Returns the OpenTelemetry instance managed by Helidon.

Methods inherited from interface RuntimeType.Api

prototype

Modifier and Type	Method	Description
OpenTelemetryConfig	prototype()	The prototype as it was received when creating this runtime object instance.

Field Details

CONFIG_KEY

static final String CONFIG_KEY

Top-level config key for telemetry settings.

See Also:

• Constant Field Values

Method Details

builder

static OpenTelemetryConfig.Builder builder()

Creates a new builder for HelidonOpenTelemetry.

Returns:

new builder

create

static HelidonOpenTelemetry create(OpenTelemetryConfig config)

Creates a new HelidonOpenTelemetry from config.

Parameters:

config - the config node to use in building the result

Returns:

new HelidonOpenTelemetry based on the supplied config

create

static HelidonOpenTelemetry create(Consumer<OpenTelemetryConfig.Builder> consumer)

Builds a new HelidonOpenTelemetry instance by revising and then building the supplied builder.

Parameters:

consumer - consumer of a builder for HelidonOpenTelemetry

Returns:

new instance

global

@Deprecated(forRemoval=true,
            since="27.0.0")
static void global(io.opentelemetry.api.OpenTelemetry openTelemetry,
 String serviceName,
 Map<String,String> tags)

Deprecated, for removal: This API element is subject to removal in a future version.

Use Services.set(Class, Object[]) to configure a custom telemetry instance, or let Helidon resolve the correct instance.

This method is now a no-op.

Parameters:

openTelemetry - ignored OpenTelemetry instance

serviceName - ignored service name

tags - ignored tracer tags

openTelemetry

io.opentelemetry.api.OpenTelemetry openTelemetry()

Returns the OpenTelemetry instance managed by Helidon.

Returns:

the OpenTelemetry instance