-
Notifications
You must be signed in to change notification settings - Fork 826
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Introduce ConfigProvider API #6549
Open
jack-berg
wants to merge
8
commits into
open-telemetry:main
Choose a base branch
from
jack-berg:config-provider
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c5cdc1c
Introduce ConfigProvider API
jack-berg 6ec7a0a
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg a624c70
partially incorporate pr feedback
jack-berg e986018
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg 0389e1c
Rename to declarative configuration
jack-berg 64df541
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg b184a59
Simplify InstrumentationConfigUtil
jack-berg 81f601c
Cleanup, reduce dependencies to compileOnly
jack-berg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
37 changes: 37 additions & 0 deletions
37
api/incubator/src/main/java/io/opentelemetry/api/incubator/config/ConfigProvider.java
This file contains 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,37 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.api.incubator.config; | ||
|
|
||
| import javax.annotation.Nullable; | ||
| import javax.annotation.concurrent.ThreadSafe; | ||
|
|
||
| /** | ||
| * A registry for accessing configuration. | ||
| * | ||
| * <p>The name <i>Provider</i> is for consistency with other languages and it is <b>NOT</b> loaded | ||
| * using reflection. | ||
| * | ||
| * <p>See {@link InstrumentationConfigUtil} for convenience methods for extracting config from | ||
| * {@link ConfigProvider}. | ||
| */ | ||
| @ThreadSafe | ||
| public interface ConfigProvider { | ||
|
|
||
| /** | ||
| * Returns the {@link StructuredConfigProperties} corresponding to <a | ||
| * href="https://github.com/open-telemetry/opentelemetry-configuration/blob/main/schema/instrumentation.json">instrumentation | ||
| * config</a>, or {@code null} if file configuration is not used. | ||
jack-berg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * | ||
| * @return the instrumentation {@link StructuredConfigProperties} | ||
| */ | ||
| @Nullable | ||
| StructuredConfigProperties getInstrumentationConfig(); | ||
|
|
||
| /** Returns a no-op {@link ConfigProvider}. */ | ||
| static ConfigProvider noop() { | ||
jack-berg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return () -> null; | ||
| } | ||
| } | ||
60 changes: 60 additions & 0 deletions
60
api/incubator/src/main/java/io/opentelemetry/api/incubator/config/GlobalConfigProvider.java
This file contains 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,60 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.api.incubator.config; | ||
|
|
||
| import io.opentelemetry.api.GlobalOpenTelemetry; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * This class provides a temporary global accessor for {@link ConfigProvider} until the config API | ||
| * is marked stable. It will eventually be merged into {@link GlobalOpenTelemetry}. | ||
| */ | ||
| // We intentionally assign to be used for error reporting. | ||
| @SuppressWarnings("StaticAssignmentOfThrowable") | ||
| public final class GlobalConfigProvider { | ||
|
|
||
| private static final AtomicReference<ConfigProvider> instance = | ||
| new AtomicReference<>(ConfigProvider.noop()); | ||
|
|
||
| @SuppressWarnings("NonFinalStaticField") | ||
| @Nullable | ||
| private static volatile Throwable setInstanceCaller; | ||
|
|
||
| private GlobalConfigProvider() {} | ||
|
|
||
| /** Returns the globally registered {@link ConfigProvider}. */ | ||
| // instance cannot be set to null | ||
| @SuppressWarnings("NullAway") | ||
| public static ConfigProvider get() { | ||
| return instance.get(); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the global {@link ConfigProvider}. Future calls to {@link #get()} will return the provided | ||
| * {@link ConfigProvider} instance. This should be called once as early as possible in your | ||
| * application initialization logic. | ||
jack-berg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| */ | ||
| public static void set(ConfigProvider configProvider) { | ||
| boolean changed = instance.compareAndSet(ConfigProvider.noop(), configProvider); | ||
| if (!changed && (configProvider != ConfigProvider.noop())) { | ||
| throw new IllegalStateException( | ||
| "GlobalConfigProvider.set has already been called. GlobalConfigProvider.set " | ||
| + "must be called only once before any calls to GlobalConfigProvider.get. " | ||
| + "Previous invocation set to cause of this exception.", | ||
| setInstanceCaller); | ||
| } | ||
| setInstanceCaller = new Throwable(); | ||
| } | ||
|
|
||
| /** | ||
| * Unsets the global {@link ConfigProvider}. This is only meant to be used from tests which need | ||
| * to reconfigure {@link ConfigProvider}. | ||
| */ | ||
| public static void resetForTest() { | ||
jack-berg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| instance.set(ConfigProvider.noop()); | ||
| } | ||
| } | ||
117 changes: 117 additions & 0 deletions
117
...ubator/src/main/java/io/opentelemetry/api/incubator/config/InstrumentationConfigUtil.java
This file contains 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,117 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.api.incubator.config; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * A collection of convenience methods to extract instrumentation config from {@link | ||
| * ConfigProvider#getInstrumentationConfig()}. | ||
| */ | ||
| public class InstrumentationConfigUtil { | ||
|
|
||
| // TODO (jack-berg): add helper function to access nested structures with dot notation | ||
|
|
||
| /** | ||
| * Return a map representation of the peer service map entries in {@code | ||
| * .instrumentation.general.peer.service_mapping}, or null if none is configured. | ||
| */ | ||
| @Nullable | ||
| public static Map<String, String> peerServiceMapping(ConfigProvider configProvider) { | ||
| Optional<List<StructuredConfigProperties>> optServiceMappingList = | ||
| Optional.ofNullable(configProvider.getInstrumentationConfig()) | ||
| .map(instrumentationConfig -> instrumentationConfig.getStructured("general")) | ||
| .map(generalConfig -> generalConfig.getStructured("peer")) | ||
| .map(httpConfig -> httpConfig.getStructuredList("service_mapping")); | ||
| if (!optServiceMappingList.isPresent()) { | ||
| return null; | ||
| } | ||
| Map<String, String> serviceMapping = new HashMap<>(); | ||
jack-berg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| optServiceMappingList | ||
| .get() | ||
| .forEach( | ||
| entry -> { | ||
| String peer = entry.getString("peer"); | ||
| String service = entry.getString("service"); | ||
| if (peer != null && service != null) { | ||
| serviceMapping.put(peer, service); | ||
| } | ||
| }); | ||
| return serviceMapping; | ||
jack-berg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| /** | ||
| * Return {@code .instrumentation.general.http.client.request_captured_headers}, or null if none | ||
| * is configured. | ||
| */ | ||
| @Nullable | ||
| public static List<String> httpClientRequestCapturedHeaders(ConfigProvider configProvider) { | ||
| return Optional.ofNullable(configProvider.getInstrumentationConfig()) | ||
| .map(instrumentationConfig -> instrumentationConfig.getStructured("general")) | ||
| .map(generalConfig -> generalConfig.getStructured("http")) | ||
| .map(httpConfig -> httpConfig.getStructured("client")) | ||
| .map(clientConfig -> clientConfig.getScalarList("request_captured_headers", String.class)) | ||
jack-berg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| .orElse(null); | ||
| } | ||
|
|
||
| /** | ||
| * Return {@code .instrumentation.general.http.client.response_captured_headers}, or null if none | ||
| * is configured. | ||
| */ | ||
jack-berg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| @Nullable | ||
| public static List<String> httpClientResponseCapturedHeaders(ConfigProvider configProvider) { | ||
| return Optional.ofNullable(configProvider.getInstrumentationConfig()) | ||
| .map(instrumentationConfig -> instrumentationConfig.getStructured("general")) | ||
| .map(generalConfig -> generalConfig.getStructured("http")) | ||
| .map(httpConfig -> httpConfig.getStructured("client")) | ||
| .map(clientConfig -> clientConfig.getScalarList("response_captured_headers", String.class)) | ||
| .orElse(null); | ||
| } | ||
|
|
||
| /** | ||
| * Return {@code .instrumentation.general.http.server.request_captured_headers}, or null if none | ||
| * is configured. | ||
| */ | ||
| @Nullable | ||
| public static List<String> httpServerRequestCapturedHeaders(ConfigProvider configProvider) { | ||
| return Optional.ofNullable(configProvider.getInstrumentationConfig()) | ||
| .map(instrumentationConfig -> instrumentationConfig.getStructured("general")) | ||
| .map(generalConfig -> generalConfig.getStructured("http")) | ||
| .map(httpConfig -> httpConfig.getStructured("server")) | ||
| .map(clientConfig -> clientConfig.getScalarList("request_captured_headers", String.class)) | ||
| .orElse(null); | ||
| } | ||
|
|
||
| /** | ||
| * Return {@code .instrumentation.general.http.server.response_captured_headers}, or null if none | ||
| * is configured. | ||
| */ | ||
| @Nullable | ||
| public static List<String> httpSeverResponseCapturedHeaders(ConfigProvider configProvider) { | ||
| return Optional.ofNullable(configProvider.getInstrumentationConfig()) | ||
| .map(instrumentationConfig -> instrumentationConfig.getStructured("general")) | ||
| .map(generalConfig -> generalConfig.getStructured("http")) | ||
| .map(httpConfig -> httpConfig.getStructured("server")) | ||
| .map(clientConfig -> clientConfig.getScalarList("response_captured_headers", String.class)) | ||
| .orElse(null); | ||
| } | ||
|
|
||
| /** Return {@code .instrumentation.java.<instrumentationName>}, or null if none is configured. */ | ||
| @Nullable | ||
| public static StructuredConfigProperties javaInstrumentationConfig( | ||
| ConfigProvider configProvider, String instrumentationName) { | ||
| return Optional.ofNullable(configProvider.getInstrumentationConfig()) | ||
| .map(instrumentationConfig -> instrumentationConfig.getStructured("java")) | ||
| .map(generalConfig -> generalConfig.getStructured(instrumentationName)) | ||
| .orElse(null); | ||
| } | ||
|
|
||
| private InstrumentationConfigUtil() {} | ||
| } | ||
22 changes: 22 additions & 0 deletions
22
...ubator/src/main/java/io/opentelemetry/api/incubator/config/StructuredConfigException.java
This file contains 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,22 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.api.incubator.config; | ||
|
|
||
| /** An exception that is thrown if the user-provided file configuration is invalid. */ | ||
| public final class StructuredConfigException extends RuntimeException { | ||
|
|
||
| private static final long serialVersionUID = 3036584181551130522L; | ||
|
|
||
| /** Create a new configuration exception with specified {@code message} and without a cause. */ | ||
| public StructuredConfigException(String message) { | ||
| super(message); | ||
| } | ||
|
|
||
| /** Create a new configuration exception with specified {@code message} and {@code cause}. */ | ||
| public StructuredConfigException(String message, Throwable cause) { | ||
| super(message, cause); | ||
| } | ||
| } |
This file contains 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.
do we want to say anything about the return value at all? such as that it can be cached or shouldn't be?
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.
I don't know enough about the domain yet. There are definitely use cases for dynamic configuration, where an SDK would connect to a remote config server via opamp, and periodically receiver commands to update the config. But a lot needs to be built to enable that, including an opamp client implementation in java, and SDK APIs for updating SdkMeterProvider, SdkLoggerProvider, SdkTracerProvder which are currently all statically configured.
Then there's the question of what types of dynamic config scenarios even make sense for instrumentation. If the otel java agent makes decisions to install or omit bytecode instrumentation based on ConfigProvider, it won't always be possible to go install later if the config were to change. Other instrumentation options may be better fits for dynamic config, but then there's the question of how often to check for updates since we probably don't want to be looking for / applying config updates on the hot path.
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.
not to anchor things too much, but certain dynamic elements may be better feature driven anyway. For example, recently in the zipkin java stuff there were requests for the sender (exporter here) to have dynamic endpoints (supplier function), provided by eureka etc. So, this is a code change as basically deferring endpoint resolution isn't default in anything. After that, there's what is the initial value as well. Point being is indeed components need to change to be dynamic, but specifically what they are dynamic about may help flex the api. Meanwhile basic impl that's easy to reason with could be a step forward.