Module io.helidon.telemetry.otelconfig

Package io.helidon.telemetry.otelconfig

Class OpenTelemetryConfig.BuilderBase.OpenTelemetryConfigImpl

java.lang.Object

io.helidon.telemetry.otelconfig.OpenTelemetryConfig.BuilderBase.OpenTelemetryConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<HelidonOpenTelemetry>, OpenTelemetryConfig, Supplier<HelidonOpenTelemetry>

Enclosing class:

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

protected static class OpenTelemetryConfig.BuilderBase.OpenTelemetryConfigImpl
extends Object
implements OpenTelemetryConfig, Supplier<HelidonOpenTelemetry>

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

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.telemetry.otelconfig.OpenTelemetryConfig

OpenTelemetryConfig.Builder, OpenTelemetryConfig.BuilderBase<BUILDER extends OpenTelemetryConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenTelemetryConfig>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
HelidonOpenTelemetry	build()	Create a new instance of the runtime type from this config object.
boolean	enabled()	Whether the OpenTelemetry support is enabled.
boolean	equals(Object o)
HelidonOpenTelemetry	get()
boolean	global()	Whether the OpenTelemetry instance created from this configuration should be made the global one.
int	hashCode()
Optional<OpenTelemetryLoggingConfig>	logging()	OpenTelemetry logging settings.
Optional<OpenTelemetryMetricsConfig>	metrics()	OpenTelemetry metrics settings.
io.opentelemetry.api.OpenTelemetry	openTelemetry()	The OpenTelemetry instance to use for telemetry.
io.opentelemetry.sdk.OpenTelemetrySdk	openTelemetrySdk()	Share the prepared OpenTelemetry SDK.
List<io.opentelemetry.context.propagation.TextMapPropagator>	propagators()	OpenTelemetry TextMapPropagator instances added explicitly by the app.
String	service()	Service name used in sending telemetry data to the collector.
String	toString()
Optional<OpenTelemetryTracingConfig>	tracing()	OpenTelemetry tracing settings.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenTelemetryConfigImpl

protected OpenTelemetryConfigImpl(OpenTelemetryConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public HelidonOpenTelemetry build()

Description copied from interface: Prototype.Factory

Create a new instance of the runtime type from this config object.

Specified by:

build in interface Prototype.Factory<HelidonOpenTelemetry>

Returns:

new configured runtime instance

get

public HelidonOpenTelemetry get()

Specified by:

get in interface Supplier<HelidonOpenTelemetry>

service

public String service()

Description copied from interface: OpenTelemetryConfig

Service name used in sending telemetry data to the collector.

Specified by:

service in interface OpenTelemetryConfig

Returns:

service name

enabled

public boolean enabled()

Description copied from interface: OpenTelemetryConfig

Whether the OpenTelemetry support is enabled.

Specified by:

enabled in interface OpenTelemetryConfig

Returns:

true if enabled; false otherwise

global

public boolean global()

Description copied from interface: OpenTelemetryConfig

Whether the OpenTelemetry instance created from this configuration should be made the global one.

Specified by:

global in interface OpenTelemetryConfig

Returns:

true if the configured instance should be made global; false otherwise

propagators

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

Description copied from interface: OpenTelemetryConfig

OpenTelemetry TextMapPropagator instances added explicitly by the app.

Default: "tracecontext,baggage".

Specified by:

propagators in interface OpenTelemetryConfig

Returns:

propagators

See Also:

• ContextPropagationType

tracing

public Optional<OpenTelemetryTracingConfig> tracing()

Description copied from interface: OpenTelemetryConfig

OpenTelemetry tracing settings.

Specified by:

tracing in interface OpenTelemetryConfig

Returns:

tracing settings

metrics

public Optional<OpenTelemetryMetricsConfig> metrics()

Description copied from interface: OpenTelemetryConfig

OpenTelemetry metrics settings.

Specified by:

metrics in interface OpenTelemetryConfig

Returns:

metrics settings

logging

public Optional<OpenTelemetryLoggingConfig> logging()

Description copied from interface: OpenTelemetryConfig

OpenTelemetry logging settings.

Specified by:

logging in interface OpenTelemetryConfig

Returns:

logging settings

openTelemetry

public io.opentelemetry.api.OpenTelemetry openTelemetry()

Description copied from interface: OpenTelemetryConfig

The OpenTelemetry 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.

Specified by:

openTelemetry in interface OpenTelemetryConfig

Returns:

the OpenTelemetry instance

openTelemetrySdk

public io.opentelemetry.sdk.OpenTelemetrySdk openTelemetrySdk()

Share the prepared OpenTelemetry SDK.

The OpenTelemetrySdk to use (restricted visibility).

Specified by:

openTelemetrySdk in interface OpenTelemetryConfig

Returns:

the SDK

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object