Package io.opentelemetry.sdk.autoconfigure

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

Field Summary

Fields

Modifier and Type	Field	Description
private ComponentLoader	componentLoader
private ConfigProperties	config
private Function<ConfigProperties,ConfigProperties>	configPropertiesCustomizer
private boolean	customized
private static final Logger	logger
private BiFunction<SdkLoggerProviderBuilder,ConfigProperties,SdkLoggerProviderBuilder>	loggerProviderCustomizer
private BiFunction<? super LogRecordExporter,ConfigProperties,? extends LogRecordExporter>	logRecordExporterCustomizer
private BiFunction<? super LogRecordProcessor,ConfigProperties,? extends LogRecordProcessor>	logRecordProcessorCustomizer
private BiFunction<SdkMeterProviderBuilder,ConfigProperties,SdkMeterProviderBuilder>	meterProviderCustomizer
private BiFunction<? super MetricExporter,ConfigProperties,? extends MetricExporter>	metricExporterCustomizer
private BiFunction<? super MetricReader,ConfigProperties,? extends MetricReader>	metricReaderCustomizer
private BiFunction<? super TextMapPropagator,ConfigProperties,? extends TextMapPropagator>	propagatorCustomizer
private final List<Function<ConfigProperties,Map<String,String>>>	propertiesCustomizers
private Supplier<Map<String,String>>	propertiesSupplier
private boolean	registerShutdownHook
private BiFunction<? super Resource,ConfigProperties,? extends Resource>	resourceCustomizer
private BiFunction<? super Sampler,ConfigProperties,? extends Sampler>	samplerCustomizer
private boolean	setResultAsGlobal
private BiFunction<? super SpanExporter,ConfigProperties,? extends SpanExporter>	spanExporterCustomizer
private BiFunction<? super SpanProcessor,ConfigProperties,? extends SpanProcessor>	spanProcessorCustomizer
private BiFunction<SdkTracerProviderBuilder,ConfigProperties,SdkTracerProviderBuilder>	tracerProviderCustomizer

Constructor Summary

Constructors

Constructor	Description
AutoConfiguredOpenTelemetrySdkBuilder()

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.
(package private) void	callAutoConfigureListeners(SpiHelper spiHelper, OpenTelemetrySdk openTelemetrySdk)
private ConfigProperties	computeConfigProperties()
AutoConfiguredOpenTelemetrySdkBuilder	disableShutdownHook()	Disable the registration of a shutdown hook to shut down the SDK when appropriate.
private ConfigProperties	getConfig()
private static AutoConfiguredOpenTelemetrySdk	maybeConfigureFromFile(ConfigProperties config, ComponentLoader componentLoader)
private void	maybeRegisterShutdownHook(OpenTelemetrySdk openTelemetrySdk)
private void	maybeSetAsGlobal(OpenTelemetrySdk openTelemetrySdk)
private static <I, O1, O2> BiFunction<I,ConfigProperties,O2>	mergeCustomizer(BiFunction<? super I,ConfigProperties,? extends O1> first, BiFunction<? super O1,ConfigProperties,? extends O2> second)
private static Supplier<Map<String,String>>	mergeProperties(Supplier<Map<String,String>> first, Supplier<Map<String,String>> second)
private void	mergeSdkTracerProviderConfigurer()
(package private) AutoConfiguredOpenTelemetrySdkBuilder	setComponentLoader(ComponentLoader componentLoader)	Sets the ComponentLoader to be used to load SPI implementations.
(package private) AutoConfiguredOpenTelemetrySdkBuilder	setConfig(ConfigProperties config)	Sets the ConfigProperties to use when resolving properties for auto-configuration.
(package private) AutoConfiguredOpenTelemetrySdkBuilder	setConfigPropertiesCustomizer(Function<ConfigProperties,ConfigProperties> configPropertiesCustomizer)	Adds a Function to invoke the with the ConfigProperties to allow customization.
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.
(package private) Thread	shutdownHook(OpenTelemetrySdk sdk)

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final Logger logger

config

@Nullable
private ConfigProperties config

tracerProviderCustomizer

private BiFunction<SdkTracerProviderBuilder,ConfigProperties,SdkTracerProviderBuilder> tracerProviderCustomizer

propagatorCustomizer

private BiFunction<? super TextMapPropagator,ConfigProperties,? extends TextMapPropagator> propagatorCustomizer

spanExporterCustomizer

private BiFunction<? super SpanExporter,ConfigProperties,? extends SpanExporter> spanExporterCustomizer

spanProcessorCustomizer

private BiFunction<? super SpanProcessor,ConfigProperties,? extends SpanProcessor> spanProcessorCustomizer

samplerCustomizer

private BiFunction<? super Sampler,ConfigProperties,? extends Sampler> samplerCustomizer

meterProviderCustomizer

private BiFunction<SdkMeterProviderBuilder,ConfigProperties,SdkMeterProviderBuilder> meterProviderCustomizer

metricExporterCustomizer

private BiFunction<? super MetricExporter,ConfigProperties,? extends MetricExporter> metricExporterCustomizer

metricReaderCustomizer

private BiFunction<? super MetricReader,ConfigProperties,? extends MetricReader> metricReaderCustomizer

loggerProviderCustomizer

private BiFunction<SdkLoggerProviderBuilder,ConfigProperties,SdkLoggerProviderBuilder> loggerProviderCustomizer

logRecordExporterCustomizer

private BiFunction<? super LogRecordExporter,ConfigProperties,? extends LogRecordExporter> logRecordExporterCustomizer

logRecordProcessorCustomizer

private BiFunction<? super LogRecordProcessor,ConfigProperties,? extends LogRecordProcessor> logRecordProcessorCustomizer

resourceCustomizer

private BiFunction<? super Resource,ConfigProperties,? extends Resource> resourceCustomizer

propertiesSupplier

private Supplier<Map<String,String>> propertiesSupplier

propertiesCustomizers

private final List<Function<ConfigProperties,Map<String,String>>> propertiesCustomizers

configPropertiesCustomizer

private Function<ConfigProperties,ConfigProperties> configPropertiesCustomizer

componentLoader

private ComponentLoader componentLoader

registerShutdownHook

private boolean registerShutdownHook

setResultAsGlobal

private boolean setResultAsGlobal

customized

private boolean customized

Constructor Details

AutoConfiguredOpenTelemetrySdkBuilder

AutoConfiguredOpenTelemetrySdkBuilder()

Method Details

setConfig

AutoConfiguredOpenTelemetrySdkBuilder setConfig(ConfigProperties config)

Sets the ConfigProperties to use when resolving properties for auto-configuration. addPropertiesSupplier(Supplier) and addPropertiesCustomizer(Function) will have no effect if this method is used.

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

setConfigPropertiesCustomizer

AutoConfiguredOpenTelemetrySdkBuilder setConfigPropertiesCustomizer(Function<ConfigProperties,ConfigProperties> configPropertiesCustomizer)

Adds a Function to invoke the with the ConfigProperties to allow customization.

The argument to the function is the ConfigProperties, with the addPropertiesCustomizer(Function) already applied.

The return value of the Function replace the ConfigProperties to be used.

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.

setComponentLoader

AutoConfiguredOpenTelemetrySdkBuilder setComponentLoader(ComponentLoader componentLoader)

Sets the ComponentLoader 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.

maybeConfigureFromFile

@Nullable
private static AutoConfiguredOpenTelemetrySdk maybeConfigureFromFile(ConfigProperties config,
 ComponentLoader componentLoader)

maybeRegisterShutdownHook

private void maybeRegisterShutdownHook(OpenTelemetrySdk openTelemetrySdk)

maybeSetAsGlobal

private void maybeSetAsGlobal(OpenTelemetrySdk openTelemetrySdk)

callAutoConfigureListeners

void callAutoConfigureListeners(SpiHelper spiHelper,
 OpenTelemetrySdk openTelemetrySdk)

mergeSdkTracerProviderConfigurer

private void mergeSdkTracerProviderConfigurer()

getConfig

private ConfigProperties getConfig()

computeConfigProperties

private ConfigProperties computeConfigProperties()

shutdownHook

Thread shutdownHook(OpenTelemetrySdk sdk)

mergeCustomizer

private static <I,
O1,
O2>
BiFunction<I,ConfigProperties,O2> mergeCustomizer(BiFunction<? super I,ConfigProperties,? extends O1> first,
 BiFunction<? super O1,ConfigProperties,? extends O2> second)

mergeProperties

private static Supplier<Map<String,String>> mergeProperties(Supplier<Map<String,String>> first,
 Supplier<Map<String,String>> second)