Merge branch 'main' of github.com:open-telemetry/opentelemetry-java-instrumentation into capture-code-attributes-spring-webflux

Author: cuichenli

benchmark-overhead/build.gradle.kts

@@ -16,7 +16,7 @@ repositories {
 }
 
 dependencies {
-  implementation(enforcedPlatform("org.junit:junit-bom:5.11.3"))
+  implementation(enforcedPlatform("org.junit:junit-bom:5.11.4"))
 
   testImplementation("org.testcontainers:testcontainers:1.20.4")
   testImplementation("org.testcontainers:postgresql:1.20.4")

conventions/build.gradle.kts

@@ -71,7 +71,7 @@ dependencies {
   implementation("net.ltgt.gradle:gradle-nullaway-plugin:2.1.0")
   implementation("me.champeau.gradle:japicmp-gradle-plugin:0.4.5")
 
-  testImplementation(enforcedPlatform("org.junit:junit-bom:5.11.3"))
+  testImplementation(enforcedPlatform("org.junit:junit-bom:5.11.4"))
   testImplementation("org.junit.jupiter:junit-jupiter-api")
   testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
   testImplementation("org.assertj:assertj-core:3.26.3")

dependencyManagement/build.gradle.kts

@@ -33,7 +33,7 @@ val DEPENDENCY_BOMS = listOf(
   "org.apache.groovy:groovy-bom:${groovyVersion}",
   "io.opentelemetry:opentelemetry-bom:${otelSdkVersion}",
   "io.opentelemetry:opentelemetry-bom-alpha:${otelSdkAlphaVersion}",
-  "org.junit:junit-bom:5.11.3",
+  "org.junit:junit-bom:5.11.4",
   "org.testcontainers:testcontainers-bom:1.20.4",
   "org.spockframework:spock-bom:2.4-M4-groovy-4.0"
 )

docs/contributing/writing-instrumentation.md

@@ -68,6 +68,47 @@ include("instrumentation:yarpc-1.0:library")
 include("instrumentation:yarpc-1.0:testing")
 ```
 
+### Instrumentation Submodules
+
+When writing instrumentation that requires submodules for different versions, the name of each
+submodule must be prefixed with the name of the parent directory (typically the library or
+framework name).
+
+As an example, if `yarpc` has instrumentation for two different versions, each version submodule
+must include the `yarpc` prefix before the version:
+
+```
+instrumentation ->
+    ...
+    yarpc ->
+      yarpc-1.0 ->
+        javaagent
+            build.gradle.kts
+        library
+            build.gradle.kts
+        testing
+            build.gradle.kts
+      yarpc-2.0 ->
+        javaagent
+            build.gradle.kts
+        library
+            build.gradle.kts
+        testing
+            build.gradle.kts
+```
+
+After creating the submodules, they must be registered in the settings.gradle.kts file. Include each
+submodule explicitly to ensure it is recognized and built as part of the project. For example:
+
+```kotlin
+include(":instrumentation:yarpc:yarpc-1.0:javaagent")
+include(":instrumentation:yarpc:yarpc-1.0:library")
+include(":instrumentation:yarpc:yarpc-1.0:testing")
+include(":instrumentation:yarpc:yarpc-2.0:javaagent")
+include(":instrumentation:yarpc:yarpc-2.0:library")
+include(":instrumentation:yarpc:yarpc-2.0:testing")
+```
+
 ## Writing library instrumentation
 
 Start by creating the `build.gradle.kts` file in the `library`

examples/distro/build.gradle

@@ -34,7 +34,7 @@ subprojects {
       opentelemetryJavaagentAlpha: "2.11.0-alpha-SNAPSHOT",
 
       autoservice                : "1.1.1",
-      junit                      : "5.11.3"
+      junit                      : "5.11.4"
     ]
 
     deps = [

examples/extension/build.gradle

@@ -29,7 +29,7 @@ ext {
     opentelemetryJavaagent     : "2.11.0-SNAPSHOT",
     opentelemetryJavaagentAlpha: "2.11.0-alpha-SNAPSHOT",
 
-    junit                      : "5.11.3"
+    junit                      : "5.11.4"
   ]
 
   deps = [

gradle-plugins/build.gradle.kts

@@ -43,7 +43,7 @@ dependencies {
 
   testImplementation("org.assertj:assertj-core:3.26.3")
 
-  testImplementation(enforcedPlatform("org.junit:junit-bom:5.11.3"))
+  testImplementation(enforcedPlatform("org.junit:junit-bom:5.11.4"))
   testImplementation("org.junit.jupiter:junit-jupiter-api")
   testImplementation("org.junit.jupiter:junit-jupiter-params")
   testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")

instrumentation/apache-httpclient/apache-httpclient-4.3/library/src/main/java/io/opentelemetry/instrumentation/apachehttpclient/v4_3/ApacheHttpClientTelemetryBuilder.java

@@ -7,6 +7,7 @@
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.instrumentation.apachehttpclient.v4_3.internal.Experimental;
 import io.opentelemetry.instrumentation.api.incubator.builder.internal.DefaultHttpClientInstrumenterBuilder;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
@@ -23,6 +24,11 @@ public final class ApacheHttpClientTelemetryBuilder {
   private final DefaultHttpClientInstrumenterBuilder<ApacheHttpClientRequest, HttpResponse> builder;
   private final OpenTelemetry openTelemetry;
 
+  static {
+    Experimental.setSetEmitExperimentalTelemetry(
+        (builder, emit) -> builder.builder.setEmitExperimentalHttpClientMetrics(emit));
+  }
+
   ApacheHttpClientTelemetryBuilder(OpenTelemetry openTelemetry) {
     builder =
         DefaultHttpClientInstrumenterBuilder.create(
@@ -103,7 +109,11 @@ public ApacheHttpClientTelemetryBuilder setKnownMethods(Set<String> knownMethods
    *
    * @param emitExperimentalHttpClientMetrics {@code true} if the experimental HTTP client metrics
    *     are to be emitted.
+   * @deprecated Use {@link
+   *     Experimental#setEmitExperimentalTelemetry(ApacheHttpClientTelemetryBuilder, boolean)}
+   *     instead.
    */
+  @Deprecated
   @CanIgnoreReturnValue
   public ApacheHttpClientTelemetryBuilder setEmitExperimentalHttpClientMetrics(
       boolean emitExperimentalHttpClientMetrics) {

instrumentation/apache-httpclient/apache-httpclient-4.3/library/src/main/java/io/opentelemetry/instrumentation/apachehttpclient/v4_3/internal/Experimental.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.apachehttpclient.v4_3.internal;
+
+import io.opentelemetry.instrumentation.apachehttpclient.v4_3.ApacheHttpClientTelemetryBuilder;
+import java.util.function.BiConsumer;
+import javax.annotation.Nullable;
+
+/**
+ * This class is internal and experimental. Its APIs are unstable and can change at any time. Its
+ * APIs (or a version of them) may be promoted to the public stable API in the future, but no
+ * guarantees are made.
+ */
+public final class Experimental {
+
+  @Nullable
+  private static volatile BiConsumer<ApacheHttpClientTelemetryBuilder, Boolean>
+      setEmitExperimentalTelemetry;
+
+  public static void setEmitExperimentalTelemetry(
+      ApacheHttpClientTelemetryBuilder builder, boolean emitExperimentalTelemetry) {
+    if (setEmitExperimentalTelemetry != null) {
+      setEmitExperimentalTelemetry.accept(builder, emitExperimentalTelemetry);
+    }
+  }
+
+  public static void setSetEmitExperimentalTelemetry(
+      BiConsumer<ApacheHttpClientTelemetryBuilder, Boolean> setEmitExperimentalTelemetry) {
+    Experimental.setEmitExperimentalTelemetry = setEmitExperimentalTelemetry;
+  }
+
+  private Experimental() {}
+}

instrumentation/java-http-client/library/src/main/java/io/opentelemetry/instrumentation/httpclient/JavaHttpClientTelemetryBuilder.java

@@ -11,6 +11,7 @@
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
 import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractorBuilder;
+import io.opentelemetry.instrumentation.httpclient.internal.Experimental;
 import io.opentelemetry.instrumentation.httpclient.internal.HttpHeadersSetter;
 import io.opentelemetry.instrumentation.httpclient.internal.JavaHttpClientInstrumenterBuilderFactory;
 import java.net.http.HttpRequest;
@@ -24,6 +25,11 @@ public final class JavaHttpClientTelemetryBuilder {
   private final DefaultHttpClientInstrumenterBuilder<HttpRequest, HttpResponse<?>> builder;
   private final OpenTelemetry openTelemetry;
 
+  static {
+    Experimental.setSetEmitExperimentalTelemetry(
+        (builder, emit) -> builder.builder.setEmitExperimentalHttpClientMetrics(emit));
+  }
+
   JavaHttpClientTelemetryBuilder(OpenTelemetry openTelemetry) {
     builder = JavaHttpClientInstrumenterBuilderFactory.create(openTelemetry);
     this.openTelemetry = openTelemetry;
@@ -100,7 +106,11 @@ public JavaHttpClientTelemetryBuilder setKnownMethods(Set<String> knownMethods)
    *
    * @param emitExperimentalHttpClientMetrics {@code true} if the experimental HTTP client metrics
    *     are to be emitted.
+   * @deprecated Use {@link
+   *     Experimental#setEmitExperimentalTelemetry(JavaHttpClientTelemetryBuilder, boolean)}
+   *     instead.
    */
+  @Deprecated
   @CanIgnoreReturnValue
   public JavaHttpClientTelemetryBuilder setEmitExperimentalHttpClientMetrics(
       boolean emitExperimentalHttpClientMetrics) {