Class AutoConfiguredOpenTelemetrySdkBuilder

java.lang.Object

io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdkBuilder

All Implemented Interfaces:

AutoConfigurationCustomizer

public final class AutoConfiguredOpenTelemetrySdkBuilder
extends Object
implements AutoConfigurationCustomizer

A builder for configuring auto-configuration of the OpenTelemetry SDK. Notably, auto-configured components can be customized, for example by delegating to them from a wrapper that tweaks behavior such as filtering out telemetry attributes.

Since:

1.28.0

Method Summary

Modifier and Type	Method	Description
AutoConfiguredOpenTelemetrySdkBuilder	addLoggerProviderCustomizer(BiFunction<SdkLoggerProviderBuilder, ConfigProperties, SdkLoggerProviderBuilder> loggerProviderCustomizer)	Adds a BiFunction to invoke the with the SdkLoggerProviderBuilder to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addLogRecordExporterCustomizer(BiFunction<? super LogRecordExporter, ConfigProperties, ? extends LogRecordExporter> logRecordExporterCustomizer)	Adds a BiFunction to invoke with the default autoconfigured LogRecordExporter to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addLogRecordProcessorCustomizer(BiFunction<? super LogRecordProcessor, ConfigProperties, ? extends LogRecordProcessor> logRecordProcessorCustomizer)	Adds a BiFunction to invoke for all autoconfigured LogRecordProcessors.
AutoConfiguredOpenTelemetrySdkBuilder	addMeterProviderCustomizer(BiFunction<SdkMeterProviderBuilder, ConfigProperties, SdkMeterProviderBuilder> meterProviderCustomizer)	Adds a BiFunction to invoke the with the SdkMeterProviderBuilder to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addMetricExporterCustomizer(BiFunction<? super MetricExporter, ConfigProperties, ? extends MetricExporter> metricExporterCustomizer)	Adds a BiFunction to invoke with the default autoconfigured SpanExporter to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addMetricReaderCustomizer(BiFunction<? super MetricReader, ConfigProperties, ? extends MetricReader> readerCustomizer)	Adds a BiFunction to invoke with the autoconfigured MetricReader to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addPropagatorCustomizer(BiFunction<? super TextMapPropagator, ConfigProperties, ? extends TextMapPropagator> propagatorCustomizer)	Adds a BiFunction to invoke with the default autoconfigured TextMapPropagator to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addPropertiesCustomizer(Function<ConfigProperties, Map<String,String>> propertiesCustomizer)	Adds a Function to invoke the with the ConfigProperties to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addPropertiesSupplier(Supplier<Map<String,String>> propertiesSupplier)	Adds a Supplier of a map of property names and values to use as defaults for the ConfigProperties used during auto-configuration.
AutoConfiguredOpenTelemetrySdkBuilder	addResourceCustomizer(BiFunction<? super Resource, ConfigProperties, ? extends Resource> resourceCustomizer)	Adds a BiFunction to invoke with the default autoconfigured Resource to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addSamplerCustomizer(BiFunction<? super Sampler, ConfigProperties, ? extends Sampler> samplerCustomizer)	Adds a BiFunction to invoke with the default autoconfigured Sampler to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addSpanExporterCustomizer(BiFunction<? super SpanExporter, ConfigProperties, ? extends SpanExporter> spanExporterCustomizer)	Adds a BiFunction to invoke with the default autoconfigured SpanExporter to allow customization.
AutoConfiguredOpenTelemetrySdkBuilder	addSpanProcessorCustomizer(BiFunction<? super SpanProcessor, ConfigProperties, ? extends SpanProcessor> spanProcessorCustomizer)	Adds a BiFunction to invoke for all autoconfigured SpanProcessor.
AutoConfiguredOpenTelemetrySdkBuilder	addTracerProviderCustomizer(BiFunction<SdkTracerProviderBuilder, ConfigProperties, SdkTracerProviderBuilder> tracerProviderCustomizer)	Adds a BiFunction to invoke the with the SdkTracerProviderBuilder to allow customization.
AutoConfiguredOpenTelemetrySdk	build()	Returns a new AutoConfiguredOpenTelemetrySdk holding components auto-configured using the settings of this AutoConfiguredOpenTelemetrySdkBuilder.
AutoConfiguredOpenTelemetrySdkBuilder	disableShutdownHook()	Disable the registration of a shutdown hook to shut down the SDK when appropriate.
AutoConfiguredOpenTelemetrySdkBuilder	setResultAsGlobal()	Sets whether the configured OpenTelemetrySdk should be set as the application's global instance.
AutoConfiguredOpenTelemetrySdkBuilder	setServiceClassLoader(ClassLoader serviceClassLoader)	Sets the ClassLoader to be used to load SPI implementations.

Methods inherited from class Object

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

Method Details

addTracerProviderCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addTracerProviderCustomizer(BiFunction<SdkTracerProviderBuilder, ConfigProperties, SdkTracerProviderBuilder> tracerProviderCustomizer)

Adds a BiFunction to invoke the with the SdkTracerProviderBuilder to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addTracerProviderCustomizer in interface AutoConfigurationCustomizer

addPropagatorCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addPropagatorCustomizer(BiFunction<? super TextMapPropagator, ConfigProperties, ? extends TextMapPropagator> propagatorCustomizer)

Adds a BiFunction to invoke with the default autoconfigured TextMapPropagator to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addPropagatorCustomizer in interface AutoConfigurationCustomizer

addResourceCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addResourceCustomizer(BiFunction<? super Resource, ConfigProperties, ? extends Resource> resourceCustomizer)

Adds a BiFunction to invoke with the default autoconfigured Resource to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addResourceCustomizer in interface AutoConfigurationCustomizer

addSamplerCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addSamplerCustomizer(BiFunction<? super Sampler, ConfigProperties, ? extends Sampler> samplerCustomizer)

Adds a BiFunction to invoke with the default autoconfigured Sampler to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addSamplerCustomizer in interface AutoConfigurationCustomizer

addSpanExporterCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addSpanExporterCustomizer(BiFunction<? super SpanExporter, ConfigProperties, ? extends SpanExporter> spanExporterCustomizer)

Adds a BiFunction to invoke with the default autoconfigured SpanExporter to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addSpanExporterCustomizer in interface AutoConfigurationCustomizer

addSpanProcessorCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addSpanProcessorCustomizer(BiFunction<? super SpanProcessor, ConfigProperties, ? extends SpanProcessor> spanProcessorCustomizer)

Adds a BiFunction to invoke for all autoconfigured SpanProcessor. The return value of the BiFunction will replace the passed-in argument. In contrast to addSpanExporterCustomizer(BiFunction) this allows modifications to happen before batching occurs. As a result, it is possible to efficiently filter spans, add artificial spans or delay spans for enhancing them with external, delayed data.

Multiple calls will execute the customizers in order.

Specified by:

addSpanProcessorCustomizer in interface AutoConfigurationCustomizer

addPropertiesSupplier

public AutoConfiguredOpenTelemetrySdkBuilder addPropertiesSupplier(Supplier<Map<String,String>> propertiesSupplier)

Adds a Supplier of a map of property names and values to use as defaults for the ConfigProperties used during auto-configuration. The order of precedence of properties is system properties > environment variables > the suppliers registered with this method.

Multiple calls will cause properties to be merged in order, with later ones overwriting duplicate keys in earlier ones.

Specified by:

addPropertiesSupplier in interface AutoConfigurationCustomizer

addPropertiesCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addPropertiesCustomizer(Function<ConfigProperties, Map<String,String>> propertiesCustomizer)

Adds a Function to invoke the with the ConfigProperties to allow customization. The return value of the Function will be merged into the ConfigProperties before it is used for auto-configuration, overwriting the properties that are already there.

Multiple calls will cause properties to be merged in order, with later ones overwriting duplicate keys in earlier ones.

Specified by:

addPropertiesCustomizer in interface AutoConfigurationCustomizer

addMeterProviderCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addMeterProviderCustomizer(BiFunction<SdkMeterProviderBuilder, ConfigProperties, SdkMeterProviderBuilder> meterProviderCustomizer)

Adds a BiFunction to invoke the with the SdkMeterProviderBuilder to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addMeterProviderCustomizer in interface AutoConfigurationCustomizer

addMetricExporterCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addMetricExporterCustomizer(BiFunction<? super MetricExporter, ConfigProperties, ? extends MetricExporter> metricExporterCustomizer)

Adds a BiFunction to invoke with the default autoconfigured SpanExporter to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addMetricExporterCustomizer in interface AutoConfigurationCustomizer

addMetricReaderCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addMetricReaderCustomizer(BiFunction<? super MetricReader, ConfigProperties, ? extends MetricReader> readerCustomizer)

Adds a BiFunction to invoke with the autoconfigured MetricReader to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addMetricReaderCustomizer in interface AutoConfigurationCustomizer

addLoggerProviderCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addLoggerProviderCustomizer(BiFunction<SdkLoggerProviderBuilder, ConfigProperties, SdkLoggerProviderBuilder> loggerProviderCustomizer)

Adds a BiFunction to invoke the with the SdkLoggerProviderBuilder to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addLoggerProviderCustomizer in interface AutoConfigurationCustomizer

addLogRecordExporterCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addLogRecordExporterCustomizer(BiFunction<? super LogRecordExporter, ConfigProperties, ? extends LogRecordExporter> logRecordExporterCustomizer)

Adds a BiFunction to invoke with the default autoconfigured LogRecordExporter to allow customization. The return value of the BiFunction will replace the passed-in argument.

Multiple calls will execute the customizers in order.

Specified by:

addLogRecordExporterCustomizer in interface AutoConfigurationCustomizer

addLogRecordProcessorCustomizer

public AutoConfiguredOpenTelemetrySdkBuilder addLogRecordProcessorCustomizer(BiFunction<? super LogRecordProcessor, ConfigProperties, ? extends LogRecordProcessor> logRecordProcessorCustomizer)

Adds a BiFunction to invoke for all autoconfigured LogRecordProcessors. The return value of the BiFunction will replace the passed-in argument. In contrast to addLogRecordExporterCustomizer(BiFunction) (BiFunction)} this allows modifications to happen before batching occurs. As a result, it is possible to efficiently filter logs, add artificial logs or delay logs for enhancing them with external, delayed data.

Multiple calls will execute the customizers in order.

Specified by:

addLogRecordProcessorCustomizer in interface AutoConfigurationCustomizer

disableShutdownHook

public AutoConfiguredOpenTelemetrySdkBuilder disableShutdownHook()

Disable the registration of a shutdown hook to shut down the SDK when appropriate. By default, the shutdown hook is registered.

Skipping the registration of the shutdown hook may cause unexpected behavior. This configuration is for SDK consumers that require control over the SDK lifecycle. In this case, alternatives must be provided by the SDK consumer to shut down the SDK.

setResultAsGlobal

public AutoConfiguredOpenTelemetrySdkBuilder setResultAsGlobal()

Sets whether the configured OpenTelemetrySdk should be set as the application's global instance.

By default, GlobalOpenTelemetry is not set.

setServiceClassLoader

public AutoConfiguredOpenTelemetrySdkBuilder setServiceClassLoader(ClassLoader serviceClassLoader)

Sets the ClassLoader to be used to load SPI implementations.

build

public AutoConfiguredOpenTelemetrySdk build()

Returns a new AutoConfiguredOpenTelemetrySdk holding components auto-configured using the settings of this AutoConfiguredOpenTelemetrySdkBuilder.