use optional instead of providing default for boolean

zeitlinger · zeitlinger · commit 4d01c8318be6 · 2025-11-25T08:41:54.000+01:00
diff --git a/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/ConfigPropertiesUtil.java b/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/ConfigPropertiesUtil.java
@@ -14,6 +14,7 @@
 import java.util.Arrays;
 import java.util.List;
 import java.util.Locale;
+import java.util.Optional;
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 
@@ -43,25 +44,23 @@ private static boolean supportsDeclarativeConfig() {
    * Returns the boolean value of the given property name from system properties and environment
    * variables.
    *
-   * <p>It's recommended to use {@link #getBoolean(OpenTelemetry, boolean, String...)} instead to
-   * support Declarative Config.
+   * <p>It's recommended to use {@link #getBoolean(OpenTelemetry, String...)} instead to support
+   * Declarative Config.
    */
-  public static boolean getBoolean(String propertyName, boolean defaultValue) {
-    String strValue = getString(propertyName);
-    return strValue == null ? defaultValue : Boolean.parseBoolean(strValue);
+  public static Optional<Boolean> getBoolean(String propertyName) {
+    return Optional.ofNullable(getString(propertyName)).map(Boolean::parseBoolean);
   }
 
   /**
    * Returns the boolean value of the given property name from Declarative Config if available,
    * otherwise falls back to system properties and environment variables.
    */
-  public static boolean getBoolean(
-      OpenTelemetry openTelemetry, boolean defaultValue, String... propertyName) {
+  public static Optional<Boolean> getBoolean(OpenTelemetry openTelemetry, String... propertyName) {
     DeclarativeConfigProperties node = getDeclarativeConfigNode(openTelemetry, propertyName);
     if (node != null) {
-      return node.getBoolean(leaf(propertyName), defaultValue);
+      return Optional.ofNullable(node.getBoolean(leaf(propertyName)));
     }
-    return getBoolean(toSystemProperty(propertyName), defaultValue);
+    return getBoolean(toSystemProperty(propertyName));
   }
 
   /**
diff --git a/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/ContextPropagationDebug.java b/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/ContextPropagationDebug.java
@@ -32,13 +32,16 @@ public final class ContextPropagationDebug {
   private static final boolean FAIL_ON_CONTEXT_LEAK;
 
   static {
-    boolean agentDebugEnabled = ConfigPropertiesUtil.getBoolean("otel.javaagent.debug", false);
+    boolean agentDebugEnabled =
+        ConfigPropertiesUtil.getBoolean("otel.javaagent.debug").orElse(false);
 
     THREAD_PROPAGATION_DEBUGGER =
         ConfigPropertiesUtil.getBoolean(
-            "otel.javaagent.experimental.thread-propagation-debugger.enabled", agentDebugEnabled);
+                "otel.javaagent.experimental.thread-propagation-debugger.enabled")
+            .orElse(agentDebugEnabled);
     FAIL_ON_CONTEXT_LEAK =
-        ConfigPropertiesUtil.getBoolean("otel.javaagent.testing.fail-on-context-leak", false);
+        ConfigPropertiesUtil.getBoolean("otel.javaagent.testing.fail-on-context-leak")
+            .orElse(false);
   }
 
   // context to which debug locations were added
diff --git a/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SupportabilityMetrics.java b/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SupportabilityMetrics.java
@@ -30,7 +30,7 @@ public final class SupportabilityMetrics {
 
   private static final SupportabilityMetrics INSTANCE =
       new SupportabilityMetrics(
-              ConfigPropertiesUtil.getBoolean("otel.javaagent.debug", false), logger::fine)
+              ConfigPropertiesUtil.getBoolean("otel.javaagent.debug").orElse(false), logger::fine)
           .start();
 
   public static SupportabilityMetrics instance() {
diff --git a/instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/internal/ConfigPropertiesUtilTest.java b/instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/internal/ConfigPropertiesUtilTest.java
@@ -132,11 +132,13 @@ void getBoolean_none() {
   }
 
   private static void assertBoolean(boolean expected) {
-    assertThat(ConfigPropertiesUtil.getBoolean("otel.instrumentation.test.property.boolean", false))
+    assertThat(
+            ConfigPropertiesUtil.getBoolean("otel.instrumentation.test.property.boolean")
+                .orElse(false))
         .isEqualTo(expected);
     assertThat(
-            ConfigPropertiesUtil.getBoolean(
-                OpenTelemetry.noop(), false, "test", "property", "boolean"))
+            ConfigPropertiesUtil.getBoolean(OpenTelemetry.noop(), "test", "property", "boolean")
+                .orElse(false))
         .isEqualTo(expected);
   }
 
@@ -154,7 +156,8 @@ public static Stream<Arguments> booleanValuesProvider() {
   void getBoolean_declarativeConfig(Object property, boolean expected) {
     assertThat(
             ConfigPropertiesUtil.getBoolean(
-                DeclarativeConfiguration.create(model(property)), false, "foo", "bar"))
+                    DeclarativeConfiguration.create(model(property)), "foo", "bar")
+                .orElse(false))
         .isEqualTo(expected);
   }
 
diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/autoconfigure/TracingRequestHandler.java b/instrumentation/aws-sdk/aws-sdk-1.11/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/autoconfigure/TracingRequestHandler.java
@@ -27,10 +27,12 @@ private static RequestHandler2 buildDelegate(OpenTelemetry openTelemetry) {
     return AwsSdkTelemetry.builder(openTelemetry)
         .setCaptureExperimentalSpanAttributes(
             ConfigPropertiesUtil.getBoolean(
-                openTelemetry, false, "aws_sdk", "experimental_span_attributes"))
+                    openTelemetry, "aws_sdk", "experimental_span_attributes")
+                .orElse(false))
         .setMessagingReceiveInstrumentationEnabled(
             ConfigPropertiesUtil.getBoolean(
-                openTelemetry, false, "messaging", "experimental", "receive_telemetry", "enabled"))
+                    openTelemetry, "messaging", "experimental", "receive_telemetry", "enabled")
+                .orElse(false))
         .setCapturedHeaders(
             ConfigPropertiesUtil.getList(
                 openTelemetry, emptyList(), "messaging", "experimental", "capture_headers"))
diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/autoconfigure/AwsSdkSingletons.java b/instrumentation/aws-sdk/aws-sdk-2.2/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/autoconfigure/AwsSdkSingletons.java
@@ -32,17 +32,17 @@ protected List<String> getCapturedHeaders() {
     @Override
     protected boolean messagingReceiveInstrumentationEnabled() {
       return ConfigPropertiesUtil.getBoolean(
-          GlobalOpenTelemetry.get(),
-          false,
-          "messaging",
-          "experimental",
-          "receive_telemetry",
-          "enabled");
+              GlobalOpenTelemetry.get(),
+              "messaging",
+              "experimental",
+              "receive_telemetry",
+              "enabled")
+          .orElse(false);
     }
 
     @Override
     protected boolean getBoolean(boolean defaultValue, String... name) {
-      return ConfigPropertiesUtil.getBoolean(GlobalOpenTelemetry.get(), defaultValue, name);
+      return ConfigPropertiesUtil.getBoolean(GlobalOpenTelemetry.get(), name).orElse(defaultValue);
     }
   }
 
diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2ClientCoreTest.java b/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2ClientCoreTest.java
@@ -101,7 +101,8 @@ public abstract class AbstractAws2ClientCoreTest {
   protected static boolean isSqsAttributeInjectionEnabled() {
     // See io.opentelemetry.instrumentation.awssdk.v2_2.autoconfigure.TracingExecutionInterceptor
     return ConfigPropertiesUtil.getBoolean(
-        "otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging", false);
+            "otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging")
+        .orElse(false);
   }
 
   protected void configureSdkClient(SdkClientBuilder<?, ?> builder) {
diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2ClientRecordHttpErrorTest.java b/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2ClientRecordHttpErrorTest.java
@@ -126,7 +126,8 @@ private static void cleanResponses() {
   public boolean isRecordIndividualHttpErrorEnabled() {
     // See io.opentelemetry.instrumentation.awssdk.v2_2.autoconfigure.TracingExecutionInterceptor
     return ConfigPropertiesUtil.getBoolean(
-        "otel.instrumentation.aws-sdk.experimental-record-individual-http-error", false);
+            "otel.instrumentation.aws-sdk.experimental-record-individual-http-error")
+        .orElse(false);
   }
 
   @SuppressWarnings("deprecation") // using deprecated semconv
diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsBaseTest.java b/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsBaseTest.java
@@ -132,7 +132,8 @@ protected void configureSdkClient(SqsAsyncClientBuilder builder) throws URISynta
   protected boolean isSqsAttributeInjectionEnabled() {
     // See io.opentelemetry.instrumentation.awssdk.v2_2.autoconfigure.TracingExecutionInterceptor
     return ConfigPropertiesUtil.getBoolean(
-        "otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging", false);
+            "otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging")
+        .orElse(false);
   }
 
   @BeforeAll
diff --git a/instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/OpenTelemetryDriver.java b/instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/OpenTelemetryDriver.java
@@ -66,11 +66,13 @@ public final class OpenTelemetryDriver implements Driver {
   private static SqlCommenter getSqlCommenter(OpenTelemetry openTelemetry) {
     boolean defaultValue =
         ConfigPropertiesUtil.getBoolean(
-            openTelemetry, false, "common", "experimental", "db_sqlcommenter", "enabled");
+                openTelemetry, "common", "experimental", "db_sqlcommenter", "enabled")
+            .orElse(false);
     return SqlCommenter.builder()
         .setEnabled(
             ConfigPropertiesUtil.getBoolean(
-                openTelemetry, defaultValue, "jdbc", "experimental", "sqlcommenter", "enabled"))
+                    openTelemetry, "jdbc", "experimental", "sqlcommenter", "enabled")
+                .orElse(defaultValue))
         .build();
   }
 
diff --git a/instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/internal/JdbcInstrumenterFactory.java b/instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/internal/JdbcInstrumenterFactory.java
@@ -34,7 +34,8 @@ public final class JdbcInstrumenterFactory {
 
   public static boolean captureQueryParameters(OpenTelemetry openTelemetry) {
     return ConfigPropertiesUtil.getBoolean(
-        openTelemetry, false, "jdbc", "experimental", "capture_query_parameters");
+            openTelemetry, "jdbc", "experimental", "capture_query_parameters")
+        .orElse(false);
   }
 
   public static Instrumenter<DbRequest, Void> createStatementInstrumenter(
@@ -49,7 +50,8 @@ static Instrumenter<DbRequest, Void> createStatementInstrumenter(
         emptyList(),
         true,
         ConfigPropertiesUtil.getBoolean(
-            openTelemetry, true, "common", "db_statement_sanitizer", "enabled"),
+                openTelemetry, "common", "db_statement_sanitizer", "enabled")
+            .orElse(true),
         captureQueryParameters);
   }
 
@@ -100,7 +102,8 @@ public static Instrumenter<DbRequest, Void> createTransactionInstrumenter(
     return createTransactionInstrumenter(
         openTelemetry,
         ConfigPropertiesUtil.getBoolean(
-            openTelemetry, false, "jdbc", "experimental", "transaction", "enabled"));
+                openTelemetry, "jdbc", "experimental", "transaction", "enabled")
+            .orElse(false));
   }
 
   public static Instrumenter<DbRequest, Void> createTransactionInstrumenter(
diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/TracingConsumerInterceptor.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/TracingConsumerInterceptor.java
@@ -41,12 +41,8 @@ public class TracingConsumerInterceptor<K, V> implements ConsumerInterceptor<K,
         KafkaTelemetry.builder(openTelemetry)
             .setMessagingReceiveInstrumentationEnabled(
                 ConfigPropertiesUtil.getBoolean(
-                    openTelemetry,
-                    false,
-                    "messaging",
-                    "experimental",
-                    "receive_telemetry",
-                    "enabled"))
+                        openTelemetry, "messaging", "experimental", "receive_telemetry", "enabled")
+                    .orElse(false))
             .setCapturedHeaders(
                 ConfigPropertiesUtil.getList(
                     openTelemetry, emptyList(), "messaging", "experimental", "capture_headers"))
diff --git a/instrumentation/log4j/log4j-context-data/log4j-context-data-2.17/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/log4j/contextdata/v2_17/OpenTelemetryContextDataProvider.java b/instrumentation/log4j/log4j-context-data/log4j-context-data-2.17/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/log4j/contextdata/v2_17/OpenTelemetryContextDataProvider.java
@@ -27,7 +27,9 @@
 public class OpenTelemetryContextDataProvider implements ContextDataProvider {
   private static final boolean BAGGAGE_ENABLED =
       ConfigPropertiesUtil.getBoolean(
-          GlobalOpenTelemetry.get(), false, "log4j_context_data", "add_baggage");
+              GlobalOpenTelemetry.get(), "log4j_context_data", "add_baggage")
+          .orElse(false);
+
   private static final boolean configuredResourceAttributeAccessible =
       isConfiguredResourceAttributeAccessible();
   private static final Map<String, String> staticContextData = getStaticContextData();
diff --git a/javaagent-bootstrap/src/main/java/io/opentelemetry/javaagent/bootstrap/AgentInitializer.java b/javaagent-bootstrap/src/main/java/io/opentelemetry/javaagent/bootstrap/AgentInitializer.java
@@ -94,7 +94,7 @@ private static boolean getBoolean(String property, boolean defaultValue) {
         new PrivilegedAction<Boolean>() {
           @Override
           public Boolean run() {
-            return ConfigPropertiesUtil.getBoolean(property, defaultValue);
+            return ConfigPropertiesUtil.getBoolean(property).orElse(defaultValue);
           }
         });
   }
diff --git a/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java b/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/SpanLoggingCustomizerProvider.java
@@ -32,7 +32,7 @@ public void customize(DeclarativeConfigurationCustomizer customizer) {
   private static void maybeEnableLoggingExporter(OpenTelemetryConfigurationModel model) {
     // read from system properties as it's an early init property and the config bridge is not
     // available here
-    if (!ConfigPropertiesUtil.getBoolean("otel.javaagent.debug", false)) {
+    if (!ConfigPropertiesUtil.getBoolean("otel.javaagent.debug").orElse(false)) {
       return;
     }
     // don't install another instance if the user has already explicitly requested it.
diff --git a/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/config/EarlyInitAgentConfig.java b/javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/config/EarlyInitAgentConfig.java
@@ -38,7 +38,7 @@ public boolean getBoolean(String propertyName, boolean defaultValue) {
     String configFileValueStr = configFileContents.get(propertyName);
     boolean configFileValue =
         configFileValueStr == null ? defaultValue : Boolean.parseBoolean(configFileValueStr);
-    return ConfigPropertiesUtil.getBoolean(propertyName, configFileValue);
+    return ConfigPropertiesUtil.getBoolean(propertyName).orElse(configFileValue);
   }
 
   public int getInt(String propertyName, int defaultValue) {

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,8 @@ public abstract class AbstractAws2ClientCoreTest {`
`101`	`101`	`protected static boolean isSqsAttributeInjectionEnabled() {`
`102`	`102`	`// See io.opentelemetry.instrumentation.awssdk.v2_2.autoconfigure.TracingExecutionInterceptor`
`103`	`103`	`return ConfigPropertiesUtil.getBoolean(`
`104`		`- "otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging", false);`
	`104`	`+ "otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging")`
	`105`	`+ .orElse(false);`
`105`	`106`	`}`
`106`	`107`
`107`	`108`	`protected void configureSdkClient(SdkClientBuilder<?, ?> builder) {`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,8 @@ private static void cleanResponses() {`
`126`	`126`	`public boolean isRecordIndividualHttpErrorEnabled() {`
`127`	`127`	`// See io.opentelemetry.instrumentation.awssdk.v2_2.autoconfigure.TracingExecutionInterceptor`
`128`	`128`	`return ConfigPropertiesUtil.getBoolean(`
`129`		`- "otel.instrumentation.aws-sdk.experimental-record-individual-http-error", false);`
	`129`	`+ "otel.instrumentation.aws-sdk.experimental-record-individual-http-error")`
	`130`	`+ .orElse(false);`
`130`	`131`	`}`
`131`	`132`
`132`	`133`	`@SuppressWarnings("deprecation") // using deprecated semconv`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,8 @@ protected void configureSdkClient(SqsAsyncClientBuilder builder) throws URISynta`
`132`	`132`	`protected boolean isSqsAttributeInjectionEnabled() {`
`133`	`133`	`// See io.opentelemetry.instrumentation.awssdk.v2_2.autoconfigure.TracingExecutionInterceptor`
`134`	`134`	`return ConfigPropertiesUtil.getBoolean(`
`135`		`- "otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging", false);`
	`135`	`+ "otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging")`
	`136`	`+ .orElse(false);`
`136`	`137`	`}`
`137`	`138`
`138`	`139`	`@BeforeAll`