Skip to content

Commit 72bb6e5

Browse files
committed
remove contract
1 parent 1b58336 commit 72bb6e5

File tree

6 files changed

+23
-19
lines changed

6 files changed

+23
-19
lines changed

instrumentation-api/build.gradle.kts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ dependencies {
1717
implementation("io.opentelemetry.semconv:opentelemetry-semconv")
1818

1919
compileOnly("com.google.auto.value:auto-value-annotations")
20-
compileOnly("org.jetbrains:annotations:26.0.2")
2120
annotationProcessor("com.google.auto.value:auto-value")
2221

2322
testImplementation("io.opentelemetry.javaagent:opentelemetry-testing-common")

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/InstrumenterBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ SpanSuppressor buildSpanSuppressor() {
373373
String value =
374374
ConfigPropertiesUtil.isDeclarativeConfig(openTelemetry)
375375
? ConfigPropertiesUtil.getString(
376-
openTelemetry, null, "common", "experimental", "span_suppression_strategy")
376+
openTelemetry, "common", "experimental", "span_suppression_strategy")
377377
: ConfigPropertiesUtil.getString(
378378
"otel.instrumentation.experimental.span-suppression-strategy");
379379
return new SpanSuppressors.ByContextKey(

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/ConfigPropertiesUtil.java

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
import java.util.function.Function;
1919
import java.util.stream.Collectors;
2020
import javax.annotation.Nullable;
21-
import org.jetbrains.annotations.Contract;
2221

2322
/**
2423
* This class is internal and is hence not for public use. Its APIs are unstable and can change at
@@ -103,17 +102,23 @@ public static String getString(String propertyName) {
103102
* Returns the string value of the given property name from Declarative Config if available,
104103
* otherwise falls back to system properties and environment variables.
105104
*/
106-
@Contract("_, !null, _ -> !null")
107-
public static String getString(
108-
OpenTelemetry openTelemetry, @Nullable String defaultValue, String... propertyName) {
105+
@Nullable
106+
public static String getString(OpenTelemetry openTelemetry, String... propertyName) {
109107
return getDeclarativeConfigOrFallback(
110-
openTelemetry,
111-
propertyName,
112-
(node, key) -> node.getString(key, defaultValue),
113-
(key) -> {
114-
String strValue = getString(key);
115-
return strValue == null ? defaultValue : strValue;
116-
});
108+
openTelemetry, propertyName, (node, key) -> node.getString(key), (key) -> getString(key));
109+
}
110+
111+
/**
112+
* Returns the string value of the given property name from Declarative Config if available,
113+
* otherwise falls back to system properties and environment variables.
114+
*/
115+
public static String getStringOrFallback(
116+
OpenTelemetry openTelemetry, String defaultValue, String... propertyName) {
117+
String value = getString(openTelemetry, propertyName);
118+
if (value == null) {
119+
return defaultValue;
120+
}
121+
return value;
117122
}
118123

119124
/**

instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/internal/ConfigPropertiesUtilTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ void getString_withOpenTelemetry_none() {
6666

6767
private static void assertString(String expected) {
6868
assertThat(
69-
ConfigPropertiesUtil.getString(
69+
ConfigPropertiesUtil.getStringOrFallback(
7070
OpenTelemetry.noop(), "default_value", "test", "property", "string"))
7171
.isEqualTo(expected);
7272
}
@@ -84,7 +84,7 @@ public static Stream<Arguments> stringValuesProvider() {
8484
@MethodSource("stringValuesProvider")
8585
void getString_declarativeConfig(Object property, String expected) {
8686
assertThat(
87-
ConfigPropertiesUtil.getString(
87+
ConfigPropertiesUtil.getStringOrFallback(
8888
DeclarativeConfiguration.create(model(property)), "default_value", "foo", "bar"))
8989
.isEqualTo(expected);
9090
}

instrumentation/log4j/log4j-context-data/log4j-context-data-2.17/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/log4j/contextdata/v2_17/internal/ContextDataKeys.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@
1515
*/
1616
public final class ContextDataKeys {
1717
public static final String TRACE_ID_KEY =
18-
ConfigPropertiesUtil.getString(
18+
ConfigPropertiesUtil.getStringOrFallback(
1919
GlobalOpenTelemetry.get(),
2020
LoggingContextConstants.TRACE_ID,
2121
"common",
2222
"logging",
2323
"trace_id");
2424
public static final String SPAN_ID_KEY =
25-
ConfigPropertiesUtil.getString(
25+
ConfigPropertiesUtil.getStringOrFallback(
2626
GlobalOpenTelemetry.get(),
2727
LoggingContextConstants.SPAN_ID,
2828
"common",
2929
"logging",
3030
"span_id");
3131
public static final String TRACE_FLAGS_KEY =
32-
ConfigPropertiesUtil.getString(
32+
ConfigPropertiesUtil.getStringOrFallback(
3333
GlobalOpenTelemetry.get(),
3434
LoggingContextConstants.TRACE_FLAGS,
3535
"common",

instrumentation/servlet/servlet-common/bootstrap/src/main/java/io/opentelemetry/javaagent/bootstrap/servlet/ExperimentalSnippetHolder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ private static String getSnippetSetting() {
2020
// instrumentations, so we need to handle both declarative and non-declarative configs here
2121
ConfigPropertiesUtil.isDeclarativeConfig(openTelemetry)
2222
? ConfigPropertiesUtil.getString(
23-
openTelemetry, null, "servlet", "experimental", "javascript-snippet")
23+
openTelemetry, "servlet", "experimental", "javascript-snippet")
2424
: ConfigPropertiesUtil.getString("otel.experimental.javascript-snippet");
2525
return result == null ? "" : result;
2626
}

0 commit comments

Comments
 (0)