Package io.opentelemetry.sdk.autoconfigure.spi

Interface AutoConfigurationCustomizer

All Known Implementing Classes:

AutoConfiguredOpenTelemetrySdkBuilder

public interface AutoConfigurationCustomizer

A builder for customizing OpenTelemetry auto-configuration.

Method Summary

Modifier and Type	Method	Description
default AutoConfigurationCustomizer	addLoggerProviderCustomizer(java.util.function.BiFunction<SdkLoggerProviderBuilder,ConfigProperties,SdkLoggerProviderBuilder> loggerProviderCustomizer)	Adds a BiFunction to invoke the with the SdkLoggerProviderBuilder to allow customization.
default AutoConfigurationCustomizer	addLogRecordExporterCustomizer(java.util.function.BiFunction<? super LogRecordExporter,ConfigProperties,? extends LogRecordExporter> exporterCustomizer)	Adds a BiFunction to invoke with the default autoconfigured LogRecordExporter to allow customization.
default AutoConfigurationCustomizer	addLogRecordProcessorCustomizer(java.util.function.BiFunction<? super LogRecordProcessor,ConfigProperties,? extends LogRecordProcessor> logRecordProcessorCustomizer)	Adds a BiFunction to invoke for all autoconfigured LogRecordProcessors.
default AutoConfigurationCustomizer	addMeterProviderCustomizer(java.util.function.BiFunction<SdkMeterProviderBuilder,ConfigProperties,SdkMeterProviderBuilder> meterProviderCustomizer)	Adds a BiFunction to invoke the with the SdkMeterProviderBuilder to allow customization.
default AutoConfigurationCustomizer	addMetricExporterCustomizer(java.util.function.BiFunction<? super MetricExporter,ConfigProperties,? extends MetricExporter> exporterCustomizer)	Adds a BiFunction to invoke with the default autoconfigured MetricExporter to allow customization.
default AutoConfigurationCustomizer	addMetricReaderCustomizer(java.util.function.BiFunction<? super MetricReader,ConfigProperties,? extends MetricReader> readerCustomizer)	Adds a BiFunction to invoke with the autoconfigured MetricReader to allow customization.
AutoConfigurationCustomizer	addPropagatorCustomizer(java.util.function.BiFunction<? super TextMapPropagator,ConfigProperties,? extends TextMapPropagator> propagatorCustomizer)	Adds a BiFunction to invoke with the default autoconfigured TextMapPropagator to allow customization.
default AutoConfigurationCustomizer	addPropertiesCustomizer(java.util.function.Function<ConfigProperties,java.util.Map<java.lang.String,java.lang.String>> propertiesCustomizer)	Adds a Function to invoke the with the ConfigProperties to allow customization.
AutoConfigurationCustomizer	addPropertiesSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> propertiesSupplier)	Adds a Supplier of a map of property names and values to use as defaults for the ConfigProperties used during auto-configuration.
AutoConfigurationCustomizer	addResourceCustomizer(java.util.function.BiFunction<? super Resource,ConfigProperties,? extends Resource> resourceCustomizer)	Adds a BiFunction to invoke with the default autoconfigured Resource to allow customization.
AutoConfigurationCustomizer	addSamplerCustomizer(java.util.function.BiFunction<? super Sampler,ConfigProperties,? extends Sampler> samplerCustomizer)	Adds a BiFunction to invoke with the default autoconfigured Sampler to allow customization.
AutoConfigurationCustomizer	addSpanExporterCustomizer(java.util.function.BiFunction<? super SpanExporter,ConfigProperties,? extends SpanExporter> exporterCustomizer)	Adds a BiFunction to invoke with the default autoconfigured SpanExporter to allow customization.
default AutoConfigurationCustomizer	addSpanProcessorCustomizer(java.util.function.BiFunction<? super SpanProcessor,ConfigProperties,? extends SpanProcessor> spanProcessorCustomizer)	Adds a BiFunction to invoke for all autoconfigured SpanProcessor.
default AutoConfigurationCustomizer	addTracerProviderCustomizer(java.util.function.BiFunction<SdkTracerProviderBuilder,ConfigProperties,SdkTracerProviderBuilder> tracerProviderCustomizer)	Adds a BiFunction to invoke the with the SdkTracerProviderBuilder to allow customization.

Method Detail

addPropagatorCustomizer

AutoConfigurationCustomizer addPropagatorCustomizer(java.util.function.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.

addResourceCustomizer

AutoConfigurationCustomizer addResourceCustomizer(java.util.function.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.

addSamplerCustomizer

AutoConfigurationCustomizer addSamplerCustomizer(java.util.function.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.

addSpanExporterCustomizer

AutoConfigurationCustomizer addSpanExporterCustomizer(java.util.function.BiFunction<? super SpanExporter,ConfigProperties,? extends SpanExporter> exporterCustomizer)

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.

addSpanProcessorCustomizer

default AutoConfigurationCustomizer addSpanProcessorCustomizer(java.util.function.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.

Since:

1.33.0

addPropertiesSupplier

AutoConfigurationCustomizer addPropertiesSupplier(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.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.

addPropertiesCustomizer

default AutoConfigurationCustomizer addPropertiesCustomizer(java.util.function.Function<ConfigProperties,java.util.Map<java.lang.String,java.lang.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.

Since:

1.17.0

addTracerProviderCustomizer

default AutoConfigurationCustomizer addTracerProviderCustomizer(java.util.function.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.

Note: calling SdkTracerProviderBuilder.setSampler(Sampler) inside of your configuration function will cause any sampler customizers to be ignored that were configured via addSamplerCustomizer(BiFunction). If you want to replace the default sampler, check out ConfigurableSamplerProvider and use addPropertiesSupplier(Supplier) to set `otel.traces.sampler` to your named sampler.

Similarly, calling SdkTracerProviderBuilder.setResource(Resource) inside of your configuration function will cause any resource customizers to be ignored that were configured via addResourceCustomizer(BiFunction).

addMeterProviderCustomizer

default AutoConfigurationCustomizer addMeterProviderCustomizer(java.util.function.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.

addMetricExporterCustomizer

default AutoConfigurationCustomizer addMetricExporterCustomizer(java.util.function.BiFunction<? super MetricExporter,ConfigProperties,? extends MetricExporter> exporterCustomizer)

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

Multiple calls will execute the customizers in order.

addMetricReaderCustomizer

default AutoConfigurationCustomizer addMetricReaderCustomizer(java.util.function.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.

Since:

1.36.0

addLoggerProviderCustomizer

default AutoConfigurationCustomizer addLoggerProviderCustomizer(java.util.function.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.

Since:

1.19.0

addLogRecordExporterCustomizer

default AutoConfigurationCustomizer addLogRecordExporterCustomizer(java.util.function.BiFunction<? super LogRecordExporter,ConfigProperties,? extends LogRecordExporter> exporterCustomizer)

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.

Since:

1.19.0

addLogRecordProcessorCustomizer

default AutoConfigurationCustomizer addLogRecordProcessorCustomizer(java.util.function.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.

Since:

1.33.0