pr review

Author: zeitlinger

…r/config/internal/LibraryConfigUtil.java …ig/internal/LegacyLibraryConfigUtil.javainstrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/LibraryConfigUtil.java renamed to instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/LegacyLibraryConfigUtil.java instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/LibraryConfigUtil.java renamed to instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/LegacyLibraryConfigUtil.java

@@ -12,10 +12,17 @@
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 
 /**
- * This class is internal and is hence not for public use. Its APIs are unstable and can change at
- * any time.
+ * Configuration utility methods for library instrumentations that support both declarative
+ * configuration and system properties / environment variables.
+ *
+ * <p>This class is only intended to be used for existing library instrumentations to not break
+ * backwards compatibility. New library instrumentations should directly use declarative
+ * configuration APIs via {@link DeclarativeConfigUtil}.
+ *
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
  */
-public final class LibraryConfigUtil {
+public final class LegacyLibraryConfigUtil {
 
   /**
    * Retrieves structured configuration for the given instrumentation name. If no configuration is
@@ -26,8 +33,9 @@ public final class LibraryConfigUtil {
    * provider. Otherwise, the configuration is obtained from system properties or environment
    * variables.
    *
-   * <p>This method is only intended to be used for library instrumentation. For agent
-   * instrumentation, use {}
+   * <p>This method is only intended to be used for existing library instrumentations to not break
+   * backwards compatibility. New library instrumentations should directly use declarative
+   * configuration APIs via {@link DeclarativeConfigUtil}.
    *
    * @param openTelemetry the OpenTelemetry instance
    * @param name the name of the instrumentation
@@ -46,5 +54,5 @@ public static ExtendedDeclarativeConfigProperties getJavaInstrumentationConfig(
     return new ExtendedDeclarativeConfigProperties(instrumentationConfig).get("java").get(name);
   }
 
-  private LibraryConfigUtil() {}
+  private LegacyLibraryConfigUtil() {}
 }

instrumentation/aws-sdk/aws-sdk-1.11/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/autoconfigure/TracingRequestHandler.java

@@ -14,7 +14,7 @@
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.ExtendedDeclarativeConfigProperties;
-import io.opentelemetry.instrumentation.api.incubator.config.internal.LibraryConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.LegacyLibraryConfigUtil;
 import io.opentelemetry.instrumentation.awssdk.v1_11.AwsSdkTelemetry;
 import java.util.Optional;
 
@@ -27,10 +27,10 @@ public class TracingRequestHandler extends RequestHandler2 {
 
   private static RequestHandler2 buildDelegate(OpenTelemetry openTelemetry) {
     ExtendedDeclarativeConfigProperties messaging =
-        LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "messaging");
+        LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "messaging");
     return AwsSdkTelemetry.builder(openTelemetry)
         .setCaptureExperimentalSpanAttributes(
-            LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "aws_sdk")
+            LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "aws_sdk")
                 .getBoolean("span_attributes/development", false))
         .setMessagingReceiveTelemetryEnabled(
             messaging.get("receive_telemetry/development").getBoolean("enabled", false))

instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/AwsSdkTelemetryFactory.java

@@ -10,7 +10,7 @@
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.ExtendedDeclarativeConfigProperties;
-import io.opentelemetry.instrumentation.api.incubator.config.internal.LibraryConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.LegacyLibraryConfigUtil;
 import io.opentelemetry.instrumentation.awssdk.v2_2.AwsSdkTelemetry;
 
 /**
@@ -22,9 +22,9 @@ public final class AwsSdkTelemetryFactory {
   public static AwsSdkTelemetry telemetry() {
     OpenTelemetry openTelemetry = GlobalOpenTelemetry.get();
     ExtendedDeclarativeConfigProperties awsSdk =
-        LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "aws_sdk");
+        LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "aws_sdk");
     ExtendedDeclarativeConfigProperties messaging =
-        LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "messaging");
+        LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "messaging");
 
     return AwsSdkTelemetry.builder(openTelemetry)
         .setCapturedHeaders(
@@ -38,7 +38,7 @@ public static AwsSdkTelemetry telemetry() {
         .setRecordIndividualHttpError(
             awsSdk.getBoolean("record_individual_http_error/development", false))
         .setGenaiCaptureMessageContent(
-            LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "genai")
+            LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "genai")
                 .getBoolean("capture_message_content", false))
         .build();
   }

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

@@ -23,7 +23,7 @@
 import static io.opentelemetry.instrumentation.jdbc.internal.JdbcInstrumenterFactory.INSTRUMENTATION_NAME;
 
 import io.opentelemetry.api.OpenTelemetry;
-import io.opentelemetry.instrumentation.api.incubator.config.internal.LibraryConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.LegacyLibraryConfigUtil;
 import io.opentelemetry.instrumentation.api.incubator.semconv.db.internal.SqlCommenter;
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 import io.opentelemetry.instrumentation.api.internal.EmbeddedInstrumentationProperties;
@@ -65,13 +65,13 @@ public final class OpenTelemetryDriver implements Driver {
 
   private static SqlCommenter getSqlCommenter(OpenTelemetry openTelemetry) {
     boolean defaultValue =
-        LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "common")
+        LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "common")
             .get("db_sqlcommenter/development")
             .getBoolean("enabled", false);
 
     return SqlCommenter.builder()
         .setEnabled(
-            LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "jdbc")
+            LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "jdbc")
                 .get("sqlcommenter/development")
                 .getBoolean("enabled", defaultValue))
         .build();

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

@@ -8,7 +8,7 @@
 import static java.util.Collections.emptyList;
 
 import io.opentelemetry.api.OpenTelemetry;
-import io.opentelemetry.instrumentation.api.incubator.config.internal.LibraryConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.LegacyLibraryConfigUtil;
 import io.opentelemetry.instrumentation.api.incubator.semconv.code.CodeAttributesExtractor;
 import io.opentelemetry.instrumentation.api.incubator.semconv.code.CodeSpanNameExtractor;
 import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientMetrics;
@@ -29,7 +29,7 @@ public final class JdbcInstrumenterFactory {
   public static final String INSTRUMENTATION_NAME = "io.opentelemetry.jdbc";
 
   public static boolean captureQueryParameters(OpenTelemetry openTelemetry) {
-    return LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "jdbc")
+    return LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "jdbc")
         .getBoolean("capture_query_parameters/development", false);
   }
 
@@ -41,7 +41,7 @@ public static Instrumenter<DbRequest, Void> createStatementInstrumenter(
   static Instrumenter<DbRequest, Void> createStatementInstrumenter(
       OpenTelemetry openTelemetry, boolean captureQueryParameters) {
     boolean statementSanitizationEnabled =
-        LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "common")
+        LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "common")
             .get("db_statement_sanitizer")
             .getBoolean("enabled", true);
     return createStatementInstrumenter(
@@ -92,7 +92,7 @@ public static Instrumenter<DataSource, DbInfo> createDataSourceInstrumenter(
   public static Instrumenter<DbRequest, Void> createTransactionInstrumenter(
       OpenTelemetry openTelemetry) {
     boolean enabled =
-        LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "jdbc")
+        LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "jdbc")
             .getBoolean("transaction/development", false);
     return createTransactionInstrumenter(openTelemetry, enabled);
   }

instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/TracingConsumerInterceptor.java

@@ -12,7 +12,7 @@
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.ExtendedDeclarativeConfigProperties;
-import io.opentelemetry.instrumentation.api.incubator.config.internal.LibraryConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.LegacyLibraryConfigUtil;
 import io.opentelemetry.instrumentation.api.internal.Timer;
 import io.opentelemetry.instrumentation.kafkaclients.common.v0_11.internal.KafkaConsumerContext;
 import io.opentelemetry.instrumentation.kafkaclients.common.v0_11.internal.KafkaConsumerContextUtil;
@@ -40,7 +40,7 @@ public class TracingConsumerInterceptor<K, V> implements ConsumerInterceptor<K,
   static {
     OpenTelemetry openTelemetry = GlobalOpenTelemetry.get();
     ExtendedDeclarativeConfigProperties messaging =
-        LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "messaging");
+        LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "messaging");
 
     telemetry =
         KafkaTelemetry.builder(openTelemetry)

instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/TracingProducerInterceptor.java

@@ -10,7 +10,7 @@
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
-import io.opentelemetry.instrumentation.api.incubator.config.internal.LibraryConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.LegacyLibraryConfigUtil;
 import java.util.Map;
 import java.util.Objects;
 import javax.annotation.Nullable;
@@ -37,7 +37,7 @@ public class TracingProducerInterceptor<K, V> implements ProducerInterceptor<K,
     telemetry =
         KafkaTelemetry.builder(openTelemetry)
             .setCapturedHeaders(
-                LibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "messaging")
+                LegacyLibraryConfigUtil.getJavaInstrumentationConfig(openTelemetry, "messaging")
                     .getScalarList("capture_headers/development", String.class, emptyList()))
             .build();
   }

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

@@ -11,7 +11,7 @@
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.api.trace.SpanContext;
 import io.opentelemetry.context.Context;
-import io.opentelemetry.instrumentation.api.incubator.config.internal.LibraryConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.LegacyLibraryConfigUtil;
 import io.opentelemetry.instrumentation.log4j.contextdata.v2_17.internal.ContextDataKeys;
 import io.opentelemetry.javaagent.bootstrap.internal.ConfiguredResourceAttributesHolder;
 import java.util.Collections;
@@ -26,7 +26,7 @@
  */
 public class OpenTelemetryContextDataProvider implements ContextDataProvider {
   private static final boolean BAGGAGE_ENABLED =
-      LibraryConfigUtil.getJavaInstrumentationConfig(
+      LegacyLibraryConfigUtil.getJavaInstrumentationConfig(
               GlobalOpenTelemetry.get(), "log4j_context_data")
           .getBoolean("add_baggage", false);
 

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

@@ -7,7 +7,7 @@
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
-import io.opentelemetry.instrumentation.api.incubator.config.internal.LibraryConfigUtil;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.LegacyLibraryConfigUtil;
 import io.opentelemetry.instrumentation.api.incubator.log.LoggingContextConstants;
 
 /**
@@ -25,7 +25,7 @@ public final class ContextDataKeys {
       getLogging().getString("trace_flags", LoggingContextConstants.TRACE_FLAGS);
 
   private static DeclarativeConfigProperties getLogging() {
-    return LibraryConfigUtil.getJavaInstrumentationConfig(GlobalOpenTelemetry.get(), "common")
+    return LegacyLibraryConfigUtil.getJavaInstrumentationConfig(GlobalOpenTelemetry.get(), "common")
         .get("logging");
   }