open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add javadoc about autoconfigure pitfall (#4558) 

* Add javadoc about autoconfigure pitfall

* more
This commit is contained in:
Trask Stalnaker 2022-06-30 07:40:34 -07:00 committed by GitHub
parent 4c0cbba5d3
commit 6034c12650
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
sdk-extensions/autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi/AutoConfigurationCustomizer.java
View File

@ -77,6 +77,17 @@ public interface AutoConfigurationCustomizer {
* customization. The return value of the {@link BiFunction} will replace the passed-in argument.
*
* <p>Multiple calls will execute the customizers in order.
*
* <p>Note: calling {@link SdkTracerProviderBuilder#setSampler(Sampler)} inside of your
* configuration function will cause any sampler customizers to be ignored that were configured
* via {@link #addSamplerCustomizer(BiFunction)}. If you want to replace the default sampler,
* check out {@link io.opentelemetry.sdk.autoconfigure.spi.traces.ConfigurableSamplerProvider} and
* use {@link #addPropertiesSupplier(Supplier)} to set `otel.traces.sampler` to your named
* sampler.
*
* <p>Similarly, calling {@link SdkTracerProviderBuilder#setResource(Resource)} inside of your
* configuration function will cause any resource customizers to be ignored that were configured
* via {@link #addResourceCustomizer(BiFunction)}.
*/
default AutoConfigurationCustomizer addTracerProviderCustomizer(
BiFunction<SdkTracerProviderBuilder, ConfigProperties, SdkTracerProviderBuilder>