Class OpenTelemetryConfig.Builder

java.lang.Object

io.helidon.telemetry.otelconfig.OpenTelemetryConfig.BuilderBase<OpenTelemetryConfig.Builder, OpenTelemetryConfig>

io.helidon.telemetry.otelconfig.OpenTelemetryConfig.Builder

All Implemented Interfaces:

Prototype.Builder<OpenTelemetryConfig.Builder, OpenTelemetryConfig>, Builder<OpenTelemetryConfig.Builder, HelidonOpenTelemetry>, ConfigBuilderSupport.ConfiguredBuilder<OpenTelemetryConfig.Builder, OpenTelemetryConfig>, Supplier<HelidonOpenTelemetry>

Enclosing interface:

OpenTelemetryConfig

public static class OpenTelemetryConfig.Builder
extends OpenTelemetryConfig.BuilderBase<OpenTelemetryConfig.Builder, OpenTelemetryConfig>
implements Builder<OpenTelemetryConfig.Builder, HelidonOpenTelemetry>

Fluent API builder for HelidonOpenTelemetry.

Nested Class Summary

Nested classes/interfaces inherited from class OpenTelemetryConfig.BuilderBase

OpenTelemetryConfig.BuilderBase.OpenTelemetryConfigImpl

Modifier and Type	Class	Description
protected static class	OpenTelemetryConfig.BuilderBase.OpenTelemetryConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
HelidonOpenTelemetry	build()	Create an instance from this builder.
OpenTelemetryConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class OpenTelemetryConfig.BuilderBase

addPropagator, addPropagators, clearLogging, clearMetrics, clearPropagators, clearResource, clearTracing, config, config, enabled, enabled, from, from, global, global, logging, logging, logging, logging, metrics, metrics, metrics, metrics, openTelemetry, openTelemetry, preBuildPrototype, propagators, propagators, registered, registered, resource, resource, resource, resource, service, service, toString, tracing, tracing, tracing, tracing, validatePrototype

Modifier and Type	Method	Description
OpenTelemetryConfig.Builder	addPropagator(io.opentelemetry.context.propagation.TextMapPropagator propagator)	OpenTelemetry TextMapPropagator instances added explicitly by the app.
OpenTelemetryConfig.Builder	addPropagators(List<? extends io.opentelemetry.context.propagation.TextMapPropagator> propagators)	OpenTelemetry TextMapPropagator instances added explicitly by the app.
OpenTelemetryConfig.Builder	clearLogging()	Clear existing value of logging.
OpenTelemetryConfig.Builder	clearMetrics()	Clear existing value of metrics.
OpenTelemetryConfig.Builder	clearPropagators()	Clear all propagators.
OpenTelemetryConfig.Builder	clearResource()	Clear existing value of resource.
OpenTelemetryConfig.Builder	clearTracing()	Clear existing value of tracing.
protected Optional<Config>	config()	Configuration used to configure this instance.
OpenTelemetryConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
boolean	enabled()	Whether the OpenTelemetry support is enabled.
OpenTelemetryConfig.Builder	enabled(boolean enabled)	Whether the OpenTelemetry support is enabled.
OpenTelemetryConfig.Builder	from(OpenTelemetryConfig prototype)	Update this builder from an existing prototype instance.
OpenTelemetryConfig.Builder	from(OpenTelemetryConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
boolean	global()	Whether the OpenTelemetry instance created from this configuration should be published as the OpenTelemetry global instance before any other code initializes GlobalOpenTelemetry, because OpenTelemetry globals are JVM-wide and can be assigned only once; if an OpenTelemetry global already exists, Helidon leaves it unchanged and uses the existing global as the application OpenTelemetry instance.
OpenTelemetryConfig.Builder	global(boolean global)	Whether the OpenTelemetry instance created from this configuration should be published as the OpenTelemetry global instance before any other code initializes GlobalOpenTelemetry, because OpenTelemetry globals are JVM-wide and can be assigned only once; if an OpenTelemetry global already exists, Helidon leaves it unchanged and uses the existing global as the application OpenTelemetry instance.
Optional<OpenTelemetryLoggingConfig>	logging()	OpenTelemetry logging settings.
OpenTelemetryConfig.Builder	logging(OpenTelemetryLoggingConfig logging)	OpenTelemetry logging settings.
OpenTelemetryConfig.Builder	logging(Consumer<OpenTelemetryLoggingConfig.Builder> consumer)	OpenTelemetry logging settings.
OpenTelemetryConfig.Builder	logging(Supplier<? extends OpenTelemetryLoggingConfig> supplier)	OpenTelemetry logging settings.
Optional<OpenTelemetryMetricsConfig>	metrics()	OpenTelemetry metrics settings.
OpenTelemetryConfig.Builder	metrics(OpenTelemetryMetricsConfig metrics)	OpenTelemetry metrics settings.
OpenTelemetryConfig.Builder	metrics(Consumer<OpenTelemetryMetricsConfig.Builder> consumer)	OpenTelemetry metrics settings.
OpenTelemetryConfig.Builder	metrics(Supplier<? extends OpenTelemetryMetricsConfig> supplier)	OpenTelemetry metrics settings.
Optional<io.opentelemetry.api.OpenTelemetry>	openTelemetry()	The OpenTelemetry instance to use for telemetry.
OpenTelemetryConfig.Builder	openTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)	The OpenTelemetry instance to use for telemetry.
protected void	preBuildPrototype()	Handles providers and decorators.
List<io.opentelemetry.context.propagation.TextMapPropagator>	propagators()	OpenTelemetry TextMapPropagator instances added explicitly by the app.
OpenTelemetryConfig.Builder	propagators(List<? extends io.opentelemetry.context.propagation.TextMapPropagator> propagators)	OpenTelemetry TextMapPropagator instances added explicitly by the app.
boolean	registered()	Whether this configuration should contribute the application-wide OpenTelemetry instance through Helidon's service registry ownership path.
OpenTelemetryConfig.Builder	registered(boolean registered)	Whether this configuration should contribute the application-wide OpenTelemetry instance through Helidon's service registry ownership path.
Optional<OpenTelemetryResourceConfig>	resource()	Resource settings shared by all configured signals.
OpenTelemetryConfig.Builder	resource(OpenTelemetryResourceConfig resource)	Resource settings shared by all configured signals.
OpenTelemetryConfig.Builder	resource(Consumer<OpenTelemetryResourceConfig.Builder> consumer)	Resource settings shared by all configured signals.
OpenTelemetryConfig.Builder	resource(Supplier<? extends OpenTelemetryResourceConfig> supplier)	Resource settings shared by all configured signals.
Optional<String>	service()	Service name used in sending telemetry data to the collector.
OpenTelemetryConfig.Builder	service(String service)	Service name used in sending telemetry data to the collector.
String	toString()
Optional<OpenTelemetryTracingConfig>	tracing()	OpenTelemetry tracing settings.
OpenTelemetryConfig.Builder	tracing(OpenTelemetryTracingConfig tracing)	OpenTelemetry tracing settings.
OpenTelemetryConfig.Builder	tracing(Consumer<OpenTelemetryTracingConfig.Builder> consumer)	OpenTelemetry tracing settings.
OpenTelemetryConfig.Builder	tracing(Supplier<? extends OpenTelemetryTracingConfig> supplier)	OpenTelemetry tracing settings.
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default HelidonOpenTelemetry	get()
default OpenTelemetryConfig.Builder	identity()	Instance of this builder as the correct type.
default OpenTelemetryConfig.Builder	update(Consumer<OpenTelemetryConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default OpenTelemetryConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public OpenTelemetryConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<OpenTelemetryConfig.Builder, OpenTelemetryConfig>

Returns:

an instance of the setup object created from this builder

build

public HelidonOpenTelemetry build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<OpenTelemetryConfig.Builder, HelidonOpenTelemetry>

Returns:

instance of the built type