Skip to content

Match environment variables for config keys containing underscores #8933

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.

Sign up for GitHub

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

Merged
jack-berg merged 2 commits into from
Oct 15, 2026
Merged

Match environment variables for config keys containing underscores #8933

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95ac981
Match environment variables for config keys containing underscores
thswlsqls Oct 12, 2026
52cb353
Add an environment variable example to ConfigUtil.getString Javadoc
thswlsqls Oct 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions common/src/main/java/io/opentelemetry/common/impl/ConfigUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,13 @@ public static Properties safeSystemProperties() {
* Return the system property or environment variable for the {@code key}.
*
* <p>Normalize the {@code key} using {@link #normalizePropertyKey(String)}. Match to system
* property keys also normalized with {@link #normalizePropertyKey(String)}. Match to environment
* variable keys normalized with {@link #normalizeEnvironmentVariableKey(String)}. System
* properties take priority over environment variables.
* property keys also normalized with {@link #normalizePropertyKey(String)}. Further normalize the
* {@code key} using {@link #normalizeEnvironmentVariableKey(String)} and match to environment
Comment thread
psx95 marked this conversation as resolved.
Resolved
* variable keys normalized the same way. System properties take priority over environment
* variables.
*
* <p>For example, {@code otel.experimental.sdk.jvm_stacktrace} matches the environment variable
* {@code OTEL_EXPERIMENTAL_SDK_JVM_STACKTRACE}.
*
* @param key the property key
* @param defaultValue the fallback value if neither system property nor environment variable is
Expand All @@ -61,8 +65,10 @@ public static String getString(String key, String defaultValue) {
if (systemProperty != null) {
return systemProperty;
}
String environmentVariableKey = normalizeEnvironmentVariableKey(normalizedKey);
return System.getenv().entrySet().stream()
.filter(entry -> normalizedKey.equals(normalizeEnvironmentVariableKey(entry.getKey())))
.filter(
entry -> environmentVariableKey.equals(normalizeEnvironmentVariableKey(entry.getKey())))
.map(Map.Entry::getValue)
.findFirst()
.orElse(defaultValue);
Expand Down
1 change: 1 addition & 0 deletions common/src/test/java/io/opentelemetry/common/impl/ConfigUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ void getString_SystemPropertyNormalized() {
@Test
void getString_EnvironmentVariable() {
assertThat(ConfigUtil.getString("config.key", "default")).isEqualTo("environment");
assertThat(ConfigUtil.getString("config_key", "default")).isEqualTo("environment");
assertThat(ConfigUtil.getString("other.config.key", "default")).isEqualTo("default");
}

Expand Down
Loading