add system properties bridge

Author: zeitlinger

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

@@ -5,23 +5,63 @@
 
 package io.opentelemetry.instrumentation.api.internal;
 
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
+import io.opentelemetry.api.incubator.config.ConfigProvider;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Locale;
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 
+import static io.opentelemetry.api.incubator.config.DeclarativeConfigProperties.empty;
+
 /**
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
  * any time.
  */
 public final class ConfigPropertiesUtil {
 
+  private static final boolean isIncubator = isIncubator();
+
+  private static boolean isIncubator() {
+    try {
+      Class.forName("io.opentelemetry.api.incubator.ExtendedOpenTelemetry");
+      return true;
+    } catch (ClassNotFoundException e) {
+      // The incubator module is not available.
+      // This only happens in OpenTelemetry API instrumentation tests, where an older version of
+      // OpenTelemetry API is used that does not have ExtendedOpenTelemetry.
+      // Having the incubator module without ExtendedOpenTelemetry class should still return false
+      // for those tests to avoid a ClassNotFoundException.
+      return false;
+    }
+  }
+
+  /**
+   * @deprecated use {@link #getBoolean(OpenTelemetry, boolean, String...)} instead
+   */
+  @Deprecated
   public static boolean getBoolean(String propertyName, boolean defaultValue) {
     String strValue = getString(propertyName);
     return strValue == null ? defaultValue : Boolean.parseBoolean(strValue);
   }
 
+  /**
+   * 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) {
+
+    DeclarativeConfigProperties node = getDeclarativeConfigNode(openTelemetry, propertyName);
+    if (node != null) {
+      return node.getBoolean(propertyName[propertyName.length - 1], defaultValue);
+    }
+    return getBoolean(toSystemProperty(propertyName), defaultValue);
+  }
+
   public static int getInt(String propertyName, int defaultValue) {
     String strValue = getString(propertyName);
     if (strValue == null) {
@@ -67,5 +107,29 @@ private static String toEnvVarName(String propertyName) {
     return propertyName.toUpperCase(Locale.ROOT).replace('-', '_').replace('.', '_');
   }
 
+  @Nullable
+  private static DeclarativeConfigProperties getDeclarativeConfigNode(
+      OpenTelemetry openTelemetry, String... propertyName) {
+    if (isIncubator && openTelemetry instanceof ExtendedOpenTelemetry) {
+      ExtendedOpenTelemetry extendedOpenTelemetry = (ExtendedOpenTelemetry) openTelemetry;
+      ConfigProvider configProvider = extendedOpenTelemetry.getConfigProvider();
+      DeclarativeConfigProperties instrumentationConfig = configProvider.getInstrumentationConfig();
+      if (instrumentationConfig == null) {
+        return empty();
+      }
+      DeclarativeConfigProperties node = instrumentationConfig.getStructured("java", empty());
+      // last part is the leaf property
+      for (int i = 0; i < propertyName.length - 1; i++) {
+        node = node.getStructured(propertyName[i], empty());
+      }
+      return node;
+    }
+    return null;
+  }
+
+  private static String toSystemProperty(String[] propertyName) {
+    return String.join(".", propertyName).replace('_', '-');
+  }
+
   private ConfigPropertiesUtil() {}
 }

instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/OpenTelemetryDriver.java

@@ -63,14 +63,16 @@ public final class OpenTelemetryDriver implements Driver {
   private static final AtomicBoolean REGISTERED = new AtomicBoolean();
   private static final List<Driver> DRIVER_CANDIDATES = new CopyOnWriteArrayList<>();
 
-  private static final SqlCommenter sqlCommenter =
-      SqlCommenter.builder()
-          .setEnabled(
-              ConfigPropertiesUtil.getBoolean(
-                  "otel.instrumentation.jdbc.experimental.sqlcommenter.enabled",
-                  ConfigPropertiesUtil.getBoolean(
-                      "otel.instrumentation.common.experimental.db-sqlcommenter.enabled", false)))
-          .build();
+  private static SqlCommenter getSqlCommenter(OpenTelemetry openTelemetry) {
+    boolean defaultValue =
+        ConfigPropertiesUtil.getBoolean(
+            openTelemetry, false, "common", "experimental", "db_sqlcommenter", "enabled");
+    return SqlCommenter.builder()
+        .setEnabled(
+            ConfigPropertiesUtil.getBoolean(
+                openTelemetry, defaultValue, "jdbc", "experimental", "sqlcommenter", "enabled"))
+        .build();
+  }
 
   static {
     try {
@@ -256,7 +258,7 @@ public Connection connect(String url, Properties info) throws SQLException {
     Instrumenter<DbRequest, Void> statementInstrumenter =
         JdbcInstrumenterFactory.createStatementInstrumenter(openTelemetry);
 
-    boolean captureQueryParameters = JdbcInstrumenterFactory.captureQueryParameters();
+    boolean captureQueryParameters = JdbcInstrumenterFactory.captureQueryParameters(openTelemetry);
     Instrumenter<DbRequest, Void> transactionInstrumenter =
         JdbcInstrumenterFactory.createTransactionInstrumenter(openTelemetry);
 
@@ -266,7 +268,7 @@ public Connection connect(String url, Properties info) throws SQLException {
         statementInstrumenter,
         transactionInstrumenter,
         captureQueryParameters,
-        sqlCommenter);
+        getSqlCommenter(openTelemetry));
   }
 
   @Override

instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/internal/JdbcInstrumenterFactory.java

@@ -32,14 +32,14 @@ public final class JdbcInstrumenterFactory {
   private static final JdbcNetworkAttributesGetter netAttributesGetter =
       new JdbcNetworkAttributesGetter();
 
-  public static boolean captureQueryParameters() {
+  public static boolean captureQueryParameters(OpenTelemetry openTelemetry) {
     return ConfigPropertiesUtil.getBoolean(
-        "otel.instrumentation.jdbc.experimental.capture-query-parameters", false);
+        openTelemetry, false, "jdbc", "experimental", "capture_query_parameters");
   }
 
   public static Instrumenter<DbRequest, Void> createStatementInstrumenter(
       OpenTelemetry openTelemetry) {
-    return createStatementInstrumenter(openTelemetry, captureQueryParameters());
+    return createStatementInstrumenter(openTelemetry, captureQueryParameters(openTelemetry));
   }
 
   static Instrumenter<DbRequest, Void> createStatementInstrumenter(
@@ -49,7 +49,7 @@ static Instrumenter<DbRequest, Void> createStatementInstrumenter(
         emptyList(),
         true,
         ConfigPropertiesUtil.getBoolean(
-            "otel.instrumentation.common.db-statement-sanitizer.enabled", true),
+            openTelemetry, true, "common", "db_statement_sanitizer", "enabled"),
         captureQueryParameters);
   }
 
@@ -100,7 +100,7 @@ public static Instrumenter<DbRequest, Void> createTransactionInstrumenter(
     return createTransactionInstrumenter(
         openTelemetry,
         ConfigPropertiesUtil.getBoolean(
-            "otel.instrumentation.jdbc.experimental.transaction.enabled", false));
+            openTelemetry, false, "jdbc", "experimental", "transaction", "enabled"));
   }
 
   public static Instrumenter<DbRequest, Void> createTransactionInstrumenter(