Skip to content

Commit a657fe3

Browse files
committed
pr review
1 parent 76a6453 commit a657fe3

File tree

4 files changed

+22
-10
lines changed

4 files changed

+22
-10
lines changed

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/internal/DeclarativeConfigPropertiesBridgeBuilder.java

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ public DeclarativeConfigPropertiesBridgeBuilder addOverride(String propertyName,
5959
return this;
6060
}
6161

62-
/** Resolve {@link ConfigProperties} from the {@code autoConfiguredOpenTelemetrySdk}. */
63-
public ConfigProperties resolveConfigProperties(
62+
/** Build {@link ConfigProperties} from the {@code autoConfiguredOpenTelemetrySdk}. */
63+
public ConfigProperties build(
6464
AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
6565
ConfigProperties sdkConfigProperties =
6666
AutoConfigureUtil.getConfig(autoConfiguredOpenTelemetrySdk);
@@ -70,15 +70,27 @@ public ConfigProperties resolveConfigProperties(
7070
ConfigProvider configProvider =
7171
AutoConfigureUtil.getConfigProvider(autoConfiguredOpenTelemetrySdk);
7272
if (configProvider != null) {
73-
return resolveInstrumentationConfig(configProvider.getInstrumentationConfig());
73+
return buildFromInstrumentationConfig(configProvider.getInstrumentationConfig());
7474
}
7575
// Should never happen
7676
throw new IllegalStateException(
7777
"AutoConfiguredOpenTelemetrySdk does not have ConfigProperties or DeclarativeConfigProperties. This is likely a programming error in opentelemetry-java");
7878
}
7979

80-
public ConfigProperties resolveInstrumentationConfig(
80+
/**
81+
* Build {@link ConfigProperties} from the {@link DeclarativeConfigProperties} provided by the
82+
* instrumentation configuration.
83+
*
84+
* <p>If the provided {@code instrumentationConfig} is null, an empty {@link
85+
* DeclarativeConfigProperties} will be used.
86+
*
87+
* @param instrumentationConfig the instrumentation configuration to build from
88+
* @return a new instance of {@link ConfigProperties}
89+
*/
90+
public ConfigProperties buildFromInstrumentationConfig(
8191
@Nullable DeclarativeConfigProperties instrumentationConfig) {
92+
// leave the name "build" for a future method that builds from a DeclarativeConfigProperties
93+
// instance that doesn't come from the top-level instrumentation config
8294
if (instrumentationConfig == null) {
8395
instrumentationConfig = DeclarativeConfigProperties.empty();
8496
}

javaagent-extension-api/src/test/java/io/opentelemetry/javaagent/extension/internal/DeclarativeConfigPropertiesBridgeBuilderTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ void shouldUseConfigPropertiesForAutoConfiguration() {
3333
.thenReturn(configPropertiesMock);
3434

3535
ConfigProperties configProperties =
36-
new DeclarativeConfigPropertiesBridgeBuilder().resolveConfigProperties(sdkMock);
36+
new DeclarativeConfigPropertiesBridgeBuilder().build(sdkMock);
3737

3838
assertThat(configProperties).isSameAs(configPropertiesMock);
3939
}
@@ -62,7 +62,7 @@ void shouldUseConfigProviderForDeclarativeConfiguration() {
6262
.thenReturn(configProviderMock);
6363

6464
ConfigProperties configProperties =
65-
new DeclarativeConfigPropertiesBridgeBuilder().resolveConfigProperties(sdkMock);
65+
new DeclarativeConfigPropertiesBridgeBuilder().build(sdkMock);
6666

6767
assertThat(configProperties.getString(propertyName)).isEqualTo(expectedValue);
6868
}
@@ -82,7 +82,7 @@ void shouldUseConfigProviderForDeclarativeConfiguration_noInstrumentationConfig(
8282
.thenReturn(configProviderMock);
8383

8484
ConfigProperties configProperties =
85-
new DeclarativeConfigPropertiesBridgeBuilder().resolveConfigProperties(sdkMock);
85+
new DeclarativeConfigPropertiesBridgeBuilder().build(sdkMock);
8686

8787
assertThat(configProperties.getString("testProperty")).isNull();
8888
}

javaagent-extension-api/src/test/java/io/opentelemetry/javaagent/extension/internal/DeclarativeConfigPropertiesBridgeTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ void setup() {
3535
SdkConfigProvider emptyConfigProvider = SdkConfigProvider.create(emptyModel);
3636
emptyBridge =
3737
new DeclarativeConfigPropertiesBridgeBuilder()
38-
.resolveInstrumentationConfig(
38+
.buildFromInstrumentationConfig(
3939
Objects.requireNonNull(emptyConfigProvider.getInstrumentationConfig()));
4040
}
4141

@@ -45,7 +45,7 @@ private static ConfigProperties create(DeclarativeConfigPropertiesBridgeBuilder
4545
DeclarativeConfigPropertiesBridgeTest.class
4646
.getClassLoader()
4747
.getResourceAsStream("config.yaml"));
48-
return builder.resolveInstrumentationConfig(
48+
return builder.buildFromInstrumentationConfig(
4949
SdkConfigProvider.create(model).getInstrumentationConfig());
5050
}
5151

javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/OpenTelemetryInstaller.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public static AutoConfiguredOpenTelemetrySdk installOpenTelemetrySdk(
5858
"otel.javaagent.debug", earlyConfig.getBoolean("otel.javaagent.debug", false))
5959
.addOverride(
6060
"otel.javaagent.logging", earlyConfig.getString("otel.javaagent.logging"))
61-
.resolveInstrumentationConfig(configProvider.getInstrumentationConfig()),
61+
.buildFromInstrumentationConfig(configProvider.getInstrumentationConfig()),
6262
configProvider);
6363
}
6464

0 commit comments

Comments
 (0)