Extended opentelemetry #7496
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.api.incubator; | ||
|
|
||
| import io.opentelemetry.api.OpenTelemetry; | ||
| import io.opentelemetry.api.incubator.config.ConfigProvider; | ||
|
|
||
| /** Extension to {@link OpenTelemetry} that supports getting {@link ConfigProvider}. */ | ||
| public interface ExtendedOpenTelemetry extends OpenTelemetry { | ||
| /** Returns the {@link ConfigProvider} for this {@link OpenTelemetry}. */ | ||
| default ConfigProvider getConfigProvider() { | ||
| return ConfigProvider.noop(); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| Comparing source compatibility of opentelemetry-sdk-1.53.0-SNAPSHOT.jar against opentelemetry-sdk-1.52.0.jar | ||
| *** MODIFIED CLASS: PUBLIC NON_FINAL (<- FINAL) io.opentelemetry.sdk.OpenTelemetrySdk (not serializable) | ||
| === CLASS FILE FORMAT VERSION: 52.0 <- 52.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.sdk.extension.incubator; | ||
|
|
||
| import io.opentelemetry.api.incubator.ExtendedOpenTelemetry; | ||
| import io.opentelemetry.api.incubator.config.ConfigProvider; | ||
| import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties; | ||
| import io.opentelemetry.context.propagation.ContextPropagators; | ||
| import io.opentelemetry.sdk.OpenTelemetrySdk; | ||
| import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider; | ||
| import io.opentelemetry.sdk.logs.SdkLoggerProvider; | ||
| import io.opentelemetry.sdk.metrics.SdkMeterProvider; | ||
| import io.opentelemetry.sdk.trace.SdkTracerProvider; | ||
| import java.io.Closeable; | ||
| import javax.annotation.Nullable; | ||
| import javax.annotation.concurrent.ThreadSafe; | ||
|
|
||
| /** A new interface for creating OpenTelemetrySdk that supports getting {@link ConfigProvider}. */ | ||
| public class ExtendedOpenTelemetrySdk extends OpenTelemetrySdk | ||
|
There was a problem hiding this comment. Alternatively, we could skip extending OpenTelemetrySdk and avoid awkwardness of trying to figure mesh together builder and constructors. OpenTelemetrySdk doesn't do much anyway so not much to repeat. Maybe do something like have There was a problem hiding this comment. The goal (IMO) is to have |
||
| implements ExtendedOpenTelemetry, Closeable { | ||
|
|
||
| private final ObfuscatedConfigProvider configProvider; | ||
|
|
||
| public ExtendedOpenTelemetrySdk( | ||
| SdkTracerProvider tracerProvider, | ||
| SdkMeterProvider meterProvider, | ||
| SdkLoggerProvider loggerProvider, | ||
| ContextPropagators propagators, | ||
| SdkConfigProvider configProvider) { | ||
| super(tracerProvider, meterProvider, loggerProvider, propagators); | ||
| this.configProvider = new ObfuscatedConfigProvider(configProvider); | ||
| } | ||
|
|
||
| @Override | ||
| public ConfigProvider getConfigProvider() { | ||
| return configProvider.unobfuscate(); | ||
| } | ||
|
|
||
| /** | ||
| * This class allows the SDK to unobfuscate an obfuscated static global provider. | ||
| * | ||
| * <p>Static global providers are obfuscated when they are returned from the API to prevent users | ||
| * from casting them to their SDK specific implementation. For example, we do not want users to | ||
| * use patterns like {@code (SdkMeterProvider) openTelemetry.getMeterProvider()}. | ||
| */ | ||
| @ThreadSafe | ||
| // Visible for testing | ||
| static class ObfuscatedConfigProvider implements ConfigProvider { | ||
|
|
||
| private final SdkConfigProvider delegate; | ||
|
|
||
| ObfuscatedConfigProvider(SdkConfigProvider delegate) { | ||
| this.delegate = delegate; | ||
| } | ||
|
|
||
| @Override | ||
| @Nullable | ||
| public DeclarativeConfigProperties getInstrumentationConfig() { | ||
| if (delegate == null) { | ||
| return null; | ||
| } | ||
| return delegate.getInstrumentationConfig(); | ||
| } | ||
|
|
||
| public SdkConfigProvider unobfuscate() { | ||
| return delegate; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.sdk.extension.incubator; | ||
|
|
||
| import io.opentelemetry.api.GlobalOpenTelemetry; | ||
| import io.opentelemetry.api.incubator.config.ConfigProvider; | ||
| import io.opentelemetry.context.propagation.ContextPropagators; | ||
| import io.opentelemetry.sdk.OpenTelemetrySdk; | ||
| import io.opentelemetry.sdk.OpenTelemetrySdkBuilder; | ||
| import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider; | ||
| import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel; | ||
| import io.opentelemetry.sdk.logs.SdkLoggerProvider; | ||
| import io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder; | ||
| import io.opentelemetry.sdk.metrics.SdkMeterProvider; | ||
| import io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder; | ||
| import io.opentelemetry.sdk.trace.SdkTracerProvider; | ||
| import io.opentelemetry.sdk.trace.SdkTracerProviderBuilder; | ||
| import java.io.Closeable; | ||
| import java.util.Objects; | ||
| import java.util.function.Consumer; | ||
|
|
||
| /** An builder for creating an {@link ExtendedOpenTelemetrySdk} instance. */ | ||
| public final class ExtendedOpenTelemetrySdkBuilder { | ||
| private final SdkTracerProviderBuilder tracerProviderBuilder = SdkTracerProvider.builder(); | ||
| private final SdkMeterProviderBuilder meterProviderBuilder = SdkMeterProvider.builder(); | ||
| private final SdkLoggerProviderBuilder loggerProviderBuilder = SdkLoggerProvider.builder(); | ||
| private ContextPropagators propagators = ContextPropagators.noop(); | ||
| private SdkConfigProvider configProvider = | ||
| SdkConfigProvider.create(new OpenTelemetryConfigurationModel()); | ||
| private Consumer<Closeable> closeableConsumer = | ||
| closeable -> { | ||
| // Default no-op closeable consumer | ||
| }; | ||
|
|
||
| /** Sets the {@link ContextPropagators} to use. */ | ||
| public ExtendedOpenTelemetrySdkBuilder setPropagators(ContextPropagators propagators) { | ||
| this.propagators = Objects.requireNonNull(propagators, "propagators must not be null"); | ||
| return this; | ||
| } | ||
|
|
||
| /** Sets the {@link ConfigProvider} to use. */ | ||
| public ExtendedOpenTelemetrySdkBuilder setConfigProvider(SdkConfigProvider configProvider) { | ||
| this.configProvider = Objects.requireNonNull(configProvider, "configProvider must not be null"); | ||
| return this; | ||
| } | ||
|
|
||
| public ExtendedOpenTelemetrySdkBuilder setCloseableConsumer(Consumer<Closeable> configurator) { | ||
| this.closeableConsumer = Objects.requireNonNull(configurator, "configurator must not be null"); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Applies a consumer callback to configure the TracerProvider being built for this OpenTelemetry. | ||
| * | ||
| * @param configurator A callback fleshing out tracers. | ||
| * @return this | ||
| */ | ||
| public ExtendedOpenTelemetrySdkBuilder withTracerProvider( | ||
|
There was a problem hiding this comment. What do we get from these withers? There was a problem hiding this comment. This is from the entity PR where it's actually needed |
||
| Consumer<SdkTracerProviderBuilder> configurator) { | ||
| configurator.accept(this.tracerProviderBuilder); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Applies a consumer callback to configure the MeterProvider being built for this OpenTelemetry. | ||
| * | ||
| * @param configurator A callback fleshing out meters. | ||
| * @return this | ||
| */ | ||
| public ExtendedOpenTelemetrySdkBuilder withMeterProvider( | ||
| Consumer<SdkMeterProviderBuilder> configurator) { | ||
| configurator.accept(this.meterProviderBuilder); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Applies a consumer callback to configure the LoggerProvider being built for this OpenTelemetry. | ||
| * | ||
| * @param configurator A callback fleshing out meters. | ||
| * @return this | ||
| */ | ||
| public ExtendedOpenTelemetrySdkBuilder withLoggerProvider( | ||
| Consumer<SdkLoggerProviderBuilder> configurator) { | ||
| configurator.accept(this.loggerProviderBuilder); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new {@link OpenTelemetrySdk} built with the configuration of this {@link | ||
| * OpenTelemetrySdkBuilder}. This SDK is not registered as the global {@link | ||
| * io.opentelemetry.api.OpenTelemetry}. It is recommended that you register one SDK using {@link | ||
| * OpenTelemetrySdkBuilder#buildAndRegisterGlobal()} for use by instrumentation that requires | ||
| * access to a global instance of {@link io.opentelemetry.api.OpenTelemetry}. | ||
| * | ||
| * @see GlobalOpenTelemetry | ||
| */ | ||
| public ExtendedOpenTelemetrySdk build() { | ||
| SdkTracerProvider tracerProvider = tracerProviderBuilder.build(); | ||
| SdkMeterProvider meterProvider = meterProviderBuilder.build(); | ||
| SdkLoggerProvider loggerProvider = loggerProviderBuilder.build(); | ||
| closeableConsumer.accept(tracerProvider); | ||
| closeableConsumer.accept(meterProvider); | ||
| closeableConsumer.accept(loggerProvider); | ||
| ExtendedOpenTelemetrySdk sdk = | ||
| new ExtendedOpenTelemetrySdk( | ||
| tracerProvider, meterProvider, loggerProvider, propagators, configProvider); | ||
| closeableConsumer.accept(sdk); | ||
| return sdk; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new {@link OpenTelemetrySdk} built with the configuration of this {@link | ||
| * OpenTelemetrySdkBuilder} and registers it as the global {@link | ||
| * io.opentelemetry.api.OpenTelemetry}. An exception will be thrown if this method is attempted to | ||
| * be called multiple times in the lifecycle of an application - ensure you have only one SDK for | ||
| * use as the global instance. If you need to configure multiple SDKs for tests, use {@link | ||
| * GlobalOpenTelemetry#resetForTest()} between them. | ||
| * | ||
| * @see GlobalOpenTelemetry | ||
| */ | ||
| public ExtendedOpenTelemetrySdk buildAndRegisterGlobal() { | ||
| ExtendedOpenTelemetrySdk sdk = build(); | ||
| GlobalOpenTelemetry.set(sdk); | ||
| return sdk; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's keep the language generic enough to support evolving use cases.