-
Notifications
You must be signed in to change notification settings - Fork 966
Add a ConfigProvider callback for runtime instrumentation option changes #8076
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
Open
jackshirazi
wants to merge
12
commits into
open-telemetry:main
Choose a base branch
from
jackshirazi:config-provider-callback
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 all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
a21685f
Adding a callback to ConfigProvider for runtime instrumentation optio…
jackshirazi 1b4d51b
correct listener interface
jackshirazi 164ea55
spotless
jackshirazi 39b9c63
feedback changes
jackshirazi 6277dd7
tentative mutation of declarative config
jackshirazi 8ed6575
spotless
jackshirazi 1858add
fix failure
jackshirazi 3617b16
test coverage
jackshirazi cb51d1f
spotless
jackshirazi d243825
warning fix
jackshirazi 1a244dc
test coverage
jackshirazi c69e75b
test coverage
jackshirazi 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
26 changes: 26 additions & 0 deletions
26
api/incubator/src/main/java/io/opentelemetry/api/incubator/config/ConfigChangeListener.java
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,26 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.api.incubator.config; | ||
|
|
||
| /** Listener notified when declarative configuration changes. */ | ||
| @FunctionalInterface | ||
| public interface ConfigChangeListener { | ||
|
|
||
| /** | ||
| * Called when the watched path changes. | ||
| * | ||
| * <p>{@code path} is the changed declarative configuration path, for example {@code | ||
| * .instrumentation/development.general.http} or {@code | ||
| * .instrumentation/development.java.methods}. | ||
| * | ||
| * <p>{@code newConfig} is never null. If the watched node is unset or cleared, {@code newConfig} | ||
| * is {@link DeclarativeConfigProperties#empty()}. | ||
| * | ||
| * @param path the declarative configuration path that changed | ||
| * @param newConfig the updated configuration for the changed path | ||
| */ | ||
| void onChange(String path, DeclarativeConfigProperties newConfig); | ||
| } |
18 changes: 18 additions & 0 deletions
18
...cubator/src/main/java/io/opentelemetry/api/incubator/config/ConfigChangeRegistration.java
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,18 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.api.incubator.config; | ||
|
|
||
| /** Registration handle returned by {@link ConfigProvider#addConfigChangeListener}. */ | ||
| @FunctionalInterface | ||
| public interface ConfigChangeRegistration { | ||
|
|
||
| /** | ||
| * Unregister the listener associated with this registration. | ||
| * | ||
| * <p>Subsequent calls have no effect. | ||
| */ | ||
| void close(); | ||
| } |
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
146 changes: 146 additions & 0 deletions
146
...main/java/io/opentelemetry/api/incubator/config/MapBackedDeclarativeConfigProperties.java
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,146 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.api.incubator.config; | ||
|
|
||
| import io.opentelemetry.common.ComponentLoader; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * A {@link DeclarativeConfigProperties} implementation backed by a {@code Map<String, Object>}. | ||
| * | ||
| * <p>This is the inverse of {@link DeclarativeConfigProperties#toMap(DeclarativeConfigProperties)}. | ||
| * Values in the map are expected to follow the same conventions as YAML parsing output: scalars | ||
| * (String, Boolean, Long, Double, Integer), lists of scalars, maps (structured children), and lists | ||
| * of maps (structured lists). | ||
| */ | ||
| final class MapBackedDeclarativeConfigProperties implements DeclarativeConfigProperties { | ||
|
|
||
| private final Map<String, Object> values; | ||
| private final ComponentLoader componentLoader; | ||
|
|
||
| MapBackedDeclarativeConfigProperties( | ||
| Map<String, Object> values, ComponentLoader componentLoader) { | ||
| this.values = values; | ||
| this.componentLoader = componentLoader; | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public String getString(String name) { | ||
| Object value = values.get(name); | ||
| return value instanceof String ? (String) value : null; | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public Boolean getBoolean(String name) { | ||
| Object value = values.get(name); | ||
| return value instanceof Boolean ? (Boolean) value : null; | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public Integer getInt(String name) { | ||
| Object value = values.get(name); | ||
| if (value instanceof Integer) { | ||
| return (Integer) value; | ||
| } | ||
| if (value instanceof Long) { | ||
| return ((Long) value).intValue(); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public Long getLong(String name) { | ||
| Object value = values.get(name); | ||
| if (value instanceof Long) { | ||
| return (Long) value; | ||
| } | ||
| if (value instanceof Integer) { | ||
| return ((Integer) value).longValue(); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public Double getDouble(String name) { | ||
| Object value = values.get(name); | ||
| if (value instanceof Double) { | ||
| return (Double) value; | ||
| } | ||
| if (value instanceof Number) { | ||
| return ((Number) value).doubleValue(); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| @Nullable | ||
| @Override | ||
| public <T> List<T> getScalarList(String name, Class<T> scalarType) { | ||
| Object value = values.get(name); | ||
| if (!(value instanceof List)) { | ||
| return null; | ||
| } | ||
| List<Object> raw = (List<Object>) value; | ||
| List<T> casted = new ArrayList<>(raw.size()); | ||
| for (Object element : raw) { | ||
| if (!scalarType.isInstance(element)) { | ||
| return null; | ||
| } | ||
| casted.add(scalarType.cast(element)); | ||
| } | ||
| return casted; | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| @Nullable | ||
| @Override | ||
| public DeclarativeConfigProperties getStructured(String name) { | ||
| Object value = values.get(name); | ||
| if (!(value instanceof Map)) { | ||
| return null; | ||
| } | ||
| return new MapBackedDeclarativeConfigProperties((Map<String, Object>) value, componentLoader); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| @Nullable | ||
| @Override | ||
| public List<DeclarativeConfigProperties> getStructuredList(String name) { | ||
| Object value = values.get(name); | ||
| if (!(value instanceof List)) { | ||
| return null; | ||
| } | ||
| List<Object> raw = (List<Object>) value; | ||
| List<DeclarativeConfigProperties> result = new ArrayList<>(raw.size()); | ||
| for (Object element : raw) { | ||
| if (!(element instanceof Map)) { | ||
| return null; | ||
| } | ||
| result.add( | ||
| new MapBackedDeclarativeConfigProperties((Map<String, Object>) element, componentLoader)); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| @Override | ||
| public Set<String> getPropertyKeys() { | ||
| return values.keySet(); | ||
| } | ||
|
|
||
| @Override | ||
| public ComponentLoader getComponentLoader() { | ||
| return componentLoader; | ||
| } | ||
| } |
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.
No need for a default implementation. This is still experimental so we can add new methods without worrying about compatibility.
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.
True. But this default is a safe fallback, I added it for that reason rather than for compatibility. I'm not against removing and implementing it in the implementations, but it's a good default