Code review sweep (run 25092961388) (#18402)

otelbot[bot] · trask · web-flow · commit 0989282e5a1e · 2026-04-29T14:41:18.000Z
Co-authored-by: otelbot &lt;197425009+otelbot@users.noreply.github.com&gt;
Co-authored-by: Trask Stalnaker &lt;trask.stalnaker@gmail.com&gt;
diff --git a/instrumentation/undertow-1.4/javaagent/build.gradle.kts b/instrumentation/undertow-1.4/javaagent/build.gradle.kts
@@ -19,7 +19,7 @@ dependencies {
   bootstrap(project(":instrumentation:undertow-1.4:bootstrap"))
 }
 
-tasks.withType<Test>().configureEach {
+tasks.test {
   systemProperty("collectMetadata", otelProps.collectMetadata)
 }
 
diff --git a/instrumentation/vertx/vertx-http-client/vertx-http-client-3.0/metadata.yaml b/instrumentation/vertx/vertx-http-client/vertx-http-client-3.0/metadata.yaml
@@ -8,31 +8,37 @@ semantic_conventions:
 library_link: https://vertx.io/docs/vertx-core/java/
 configurations:
   - name: otel.instrumentation.http.known-methods
+    declarative_name: java.common.http.known_methods
     description: >
       Configures the instrumentation to recognize an alternative set of HTTP request methods. All
       other methods will be treated as `_OTHER`.
     type: list
     default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
   - name: otel.instrumentation.http.client.capture-request-headers
+    declarative_name: general.http.client.request_captured_headers
     description: List of HTTP request headers to capture in HTTP client telemetry.
     type: list
     default: ""
   - name: otel.instrumentation.http.client.capture-response-headers
+    declarative_name: general.http.client.response_captured_headers
     description: List of HTTP response headers to capture in HTTP client telemetry.
     type: list
     default: ""
   - name: otel.instrumentation.common.peer-service-mapping
+    declarative_name: java.common.peer_service_mapping
     description: Used to specify a mapping from host names or IP addresses to peer services.
     type: map
     default: ""
   - name: otel.instrumentation.http.client.emit-experimental-telemetry
+    declarative_name: java.common.http.client.emit_experimental_telemetry/development
     description: >
       Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
       and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
       `http.client.response.size` metrics.
     type: boolean
     default: false
   - name: otel.instrumentation.sanitization.url.experimental.sensitive-query-parameters
+    declarative_name: general.sanitization.url.sensitive_query_parameters/development
     description: List of URL query parameter names whose values are redacted in URL attributes. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
     type: list
     default: "AWSAccessKeyId,Signature,sig,X-Goog-Signature"
diff --git a/instrumentation/vertx/vertx-http-client/vertx-http-client-4.0/metadata.yaml b/instrumentation/vertx/vertx-http-client/vertx-http-client-4.0/metadata.yaml
@@ -6,31 +6,37 @@ semantic_conventions:
 library_link: https://vertx.io/
 configurations:
   - name: otel.instrumentation.http.known-methods
+    declarative_name: java.common.http.known_methods
     description: >
       Configures the instrumentation to recognize an alternative set of HTTP request methods. All
       other methods will be treated as `_OTHER`.
     type: list
     default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
   - name: otel.instrumentation.http.client.capture-request-headers
+    declarative_name: general.http.client.request_captured_headers
     description: List of HTTP request headers to capture in HTTP client telemetry.
     type: list
     default: ""
   - name: otel.instrumentation.http.client.capture-response-headers
+    declarative_name: general.http.client.response_captured_headers
     description: List of HTTP response headers to capture in HTTP client telemetry.
     type: list
     default: ""
   - name: otel.instrumentation.common.peer-service-mapping
+    declarative_name: java.common.peer_service_mapping
     description: Used to specify a mapping from host names or IP addresses to peer services.
     type: map
     default: ""
   - name: otel.instrumentation.http.client.emit-experimental-telemetry
+    declarative_name: java.common.http.client.emit_experimental_telemetry/development
     description: >
       Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
       and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
       `http.client.response.size` metrics.
     type: boolean
     default: false
   - name: otel.instrumentation.sanitization.url.experimental.sensitive-query-parameters
+    declarative_name: general.sanitization.url.sensitive_query_parameters/development
     description: List of URL query parameter names whose values are redacted in URL attributes. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
     type: list
     default: "AWSAccessKeyId,Signature,sig,X-Goog-Signature"
diff --git a/instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/httpclient/v5_0/HttpRequestInstrumentation.java b/instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/httpclient/v5_0/HttpRequestInstrumentation.java
@@ -87,20 +87,20 @@ public static class AdviceScope {
       private final Context context;
       private final Scope scope;
 
-      private AdviceScope(Context context, Scope scope) {
+      private AdviceScope(Context context) {
         this.context = context;
-        this.scope = scope;
+        this.scope = context.makeCurrent();
       }
 
       @Nullable
-      public static AdviceScope startAndAttachContext(HttpClientRequest request) {
+      public static AdviceScope start(HttpClientRequest request) {
         Context parentContext = Context.current();
         if (!instrumenter().shouldStart(parentContext, request)) {
           return null;
         }
         Context context = instrumenter().start(parentContext, request);
         CONTEXTS.set(request, new Contexts(parentContext, context));
-        return new AdviceScope(context, context.makeCurrent());
+        return new AdviceScope(context);
       }
 
       public void end(HttpClientRequest request, @Nullable Throwable throwable) {
@@ -114,7 +114,7 @@ public void end(HttpClientRequest request, @Nullable Throwable throwable) {
     @Nullable
     @Advice.OnMethodEnter(suppress = Throwable.class, inline = false)
     public static AdviceScope attachContext(@Advice.This HttpClientRequest request) {
-      return AdviceScope.startAndAttachContext(request);
+      return AdviceScope.start(request);
     }
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class, inline = false)
diff --git a/instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/metadata.yaml b/instrumentation/vertx/vertx-http-client/vertx-http-client-5.0/metadata.yaml
@@ -7,31 +7,37 @@ semantic_conventions:
 library_link: https://vertx.io/docs/vertx-core/java/
 configurations:
   - name: otel.instrumentation.http.known-methods
+    declarative_name: java.common.http.known_methods
     description: >
       Configures the instrumentation to recognize an alternative set of HTTP request methods. All
       other methods will be treated as `_OTHER`.
     type: list
     default: "CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE"
   - name: otel.instrumentation.http.client.capture-request-headers
+    declarative_name: general.http.client.request_captured_headers
     description: List of HTTP request headers to capture in HTTP client telemetry.
     type: list
     default: ""
   - name: otel.instrumentation.http.client.capture-response-headers
+    declarative_name: general.http.client.response_captured_headers
     description: List of HTTP response headers to capture in HTTP client telemetry.
     type: list
     default: ""
   - name: otel.instrumentation.common.peer-service-mapping
+    declarative_name: java.common.peer_service_mapping
     description: Used to specify a mapping from host names or IP addresses to peer services.
     type: map
     default: ""
   - name: otel.instrumentation.http.client.emit-experimental-telemetry
+    declarative_name: java.common.http.client.emit_experimental_telemetry/development
     description: >
       Enable the capture of experimental HTTP client telemetry. Adds the `http.request.body.size`
       and `http.response.body.size` attributes to spans, and records `http.client.request.size` and
       `http.client.response.size` metrics.
     type: boolean
     default: false
   - name: otel.instrumentation.sanitization.url.experimental.sensitive-query-parameters
+    declarative_name: general.sanitization.url.sensitive_query_parameters/development
     description: List of URL query parameter names whose values are redacted in URL attributes. See https://opentelemetry.io/docs/specs/semconv/http/http-spans.
     type: list
     default: "AWSAccessKeyId,Signature,sig,X-Goog-Signature"
diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafkaclient/v3_6/KafkaReadStreamImplInstrumentation.java b/instrumentation/vertx/vertx-kafka-client-3.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafkaclient/v3_6/KafkaReadStreamImplInstrumentation.java
@@ -14,6 +14,7 @@
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
 import io.vertx.core.Handler;
+import javax.annotation.Nullable;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.asm.Advice.AssignReturned;
 import net.bytebuddy.asm.Advice.AssignReturned.ToArguments.ToArgument;
@@ -50,9 +51,13 @@ public static class HandlerAdvice {
 
     @AssignReturned.ToArguments(@ToArgument(0))
     @Advice.OnMethodEnter(suppress = Throwable.class, inline = false)
+    @Nullable
     public static <K, V> Handler<ConsumerRecord<K, V>> onEnter(
-        @Advice.Argument(0) Handler<ConsumerRecord<K, V>> handler) {
+        @Advice.Argument(0) @Nullable Handler<ConsumerRecord<K, V>> handler) {
 
+      if (handler == null) {
+        return null;
+      }
       return new InstrumentedSingleRecordHandler<>(handler);
     }
   }
@@ -62,9 +67,13 @@ public static class BatchHandlerAdvice {
 
     @AssignReturned.ToArguments(@ToArgument(0))
     @Advice.OnMethodEnter(suppress = Throwable.class, inline = false)
+    @Nullable
     public static <K, V> Handler<ConsumerRecords<K, V>> onEnter(
-        @Advice.Argument(0) Handler<ConsumerRecords<K, V>> handler) {
+        @Advice.Argument(0) @Nullable Handler<ConsumerRecords<K, V>> handler) {
 
+      if (handler == null) {
+        return null;
+      }
       return new InstrumentedBatchRecordsHandler<>(handler);
     }
   }
diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractVertxKafkaTest.java b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractVertxKafkaTest.java
@@ -24,6 +24,7 @@
 import static java.util.concurrent.TimeUnit.SECONDS;
 import static org.assertj.core.api.Assertions.assertThat;
 
+import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import io.opentelemetry.sdk.testing.assertj.AttributeAssertion;
 import io.vertx.core.AsyncResult;
@@ -42,9 +43,9 @@
 import org.apache.kafka.common.serialization.StringSerializer;
 import org.assertj.core.api.AbstractLongAssert;
 import org.assertj.core.api.AbstractStringAssert;
-import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.TestInstance;
+import org.junit.jupiter.api.extension.RegisterExtension;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.output.Slf4jLogConsumer;
@@ -56,6 +57,10 @@
 public abstract class AbstractVertxKafkaTest {
 
   private static final Logger logger = LoggerFactory.getLogger(AbstractVertxKafkaTest.class);
+  private static final boolean EXPERIMENTAL_ATTRIBUTES =
+      Boolean.getBoolean("otel.instrumentation.kafka.experimental-span-attributes");
+
+  @RegisterExtension final AutoCleanupExtension cleanup = AutoCleanupExtension.create();
 
   KafkaContainer kafka;
   Vertx vertx;
@@ -82,25 +87,15 @@ void setUpAll() {
             .withLogConsumer(new Slf4jLogConsumer(logger))
             .waitingFor(Wait.forLogMessage(".*started \\(kafka.server.Kafka.*Server\\).*", 1))
             .withStartupTimeout(Duration.ofMinutes(1));
+    cleanup.deferAfterAll(kafka::stop);
     kafka.start();
 
     vertx = Vertx.vertx();
+    cleanup.deferAfterAll(() -> closeVertx(vertx));
     kafkaProducer = KafkaProducer.create(vertx, producerProps());
+    cleanup.deferAfterAll(() -> closeKafkaProducer(kafkaProducer));
     kafkaConsumer = KafkaConsumer.create(vertx, consumerProps());
-  }
-
-  @AfterAll
-  void tearDownAll() {
-    if (kafkaConsumer != null) {
-      closeKafkaConsumer(kafkaConsumer);
-    }
-    if (kafkaProducer != null) {
-      closeKafkaProducer(kafkaProducer);
-    }
-    if (vertx != null) {
-      closeVertx(vertx);
-    }
-    kafka.stop();
+    cleanup.deferAfterAll(() -> closeKafkaConsumer(kafkaConsumer));
   }
 
   private Properties producerProps() {
@@ -180,7 +175,7 @@ protected static List<AttributeAssertion> sendAttributes(
                 satisfies(stringKey("messaging.client_id"), val -> val.startsWith("producer")),
                 satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty),
                 satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)));
-    if (Boolean.getBoolean("otel.instrumentation.kafka.experimental-span-attributes")) {
+    if (EXPERIMENTAL_ATTRIBUTES) {
       assertions.add(
           satisfies(
               stringKey("messaging.kafka.bootstrap.servers"),
@@ -228,7 +223,7 @@ protected List<AttributeAssertion> processAttributes(KafkaProducerRecord<String,
                 satisfies(stringKey("messaging.client_id"), val -> val.startsWith("consumer")),
                 satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty),
                 satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)));
-    if (Boolean.getBoolean("otel.instrumentation.kafka.experimental-span-attributes")) {
+    if (EXPERIMENTAL_ATTRIBUTES) {
       assertions.add(
           satisfies(longKey("kafka.record.queue_time_ms"), AbstractLongAssert::isNotNegative));
     }
diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/BatchRecordsHandler.java b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/BatchRecordsHandler.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.javaagent.instrumentation.vertx.kafka;
 
 import static java.util.concurrent.TimeUnit.SECONDS;
+import static org.assertj.core.api.Assertions.assertThat;
 
 import io.opentelemetry.instrumentation.testing.GlobalTraceUtil;
 import io.vertx.core.Handler;
@@ -44,7 +45,7 @@ public static void reset(int expectedBatchSize) {
   }
 
   public static void waitForMessages() throws InterruptedException {
-    messageReceived.await(30, SECONDS);
+    assertThat(messageReceived.await(30, SECONDS)).isTrue();
   }
 
   public static int getLastBatchSize() {
diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-3.6-testing/build.gradle.kts b/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-3.6-testing/build.gradle.kts
@@ -26,19 +26,6 @@ testing {
         implementation("io.vertx:vertx-kafka-client:$version")
         implementation("io.vertx:vertx-codegen:$version")
       }
-
-      targets {
-        all {
-          testTask.configure {
-            systemProperty(
-              "metadataConfig",
-              "otel.instrumentation.messaging.experimental.receive-telemetry.enabled=false",
-            )
-            jvmArgs("-Dotel.instrumentation.kafka.experimental-span-attributes=false")
-            jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=false")
-          }
-        }
-      }
     }
   }
 }
@@ -52,6 +39,10 @@ tasks {
 
   test {
     jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true")
+    systemProperty(
+      "metadataConfig",
+      "otel.instrumentation.messaging.experimental.receive-telemetry.enabled=true",
+    )
   }
 
   val testExperimental by registering(Test::class) {
@@ -60,7 +51,10 @@ tasks {
 
     jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true")
     jvmArgs("-Dotel.instrumentation.kafka.experimental-span-attributes=true")
-    systemProperty("metadataConfig", "otel.instrumentation.kafka.experimental-span-attributes=true")
+    systemProperty(
+      "metadataConfig",
+      "otel.instrumentation.messaging.experimental.receive-telemetry.enabled=true,otel.instrumentation.kafka.experimental-span-attributes=true",
+    )
   }
 
   check {
diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-4-testing/build.gradle.kts b/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-4-testing/build.gradle.kts
@@ -46,11 +46,26 @@ tasks {
   }
 
   test {
-    jvmArgs("-Dotel.instrumentation.kafka.experimental-span-attributes=true")
     jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true")
+    systemProperty(
+      "metadataConfig",
+      "otel.instrumentation.messaging.experimental.receive-telemetry.enabled=true",
+    )
+  }
+
+  val testExperimental by registering(Test::class) {
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+
+    jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true")
+    jvmArgs("-Dotel.instrumentation.kafka.experimental-span-attributes=true")
+    systemProperty(
+      "metadataConfig",
+      "otel.instrumentation.messaging.experimental.receive-telemetry.enabled=true,otel.instrumentation.kafka.experimental-span-attributes=true",
+    )
   }
 
   check {
-    dependsOn(testing.suites)
+    dependsOn(testing.suites, testExperimental)
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ dependencies {`
`19`	`19`	`bootstrap(project(":instrumentation:undertow-1.4:bootstrap"))`
`20`	`20`	`}`
`21`	`21`
`22`		`-tasks.withType<Test>().configureEach {`
	`22`	`+tasks.test {`
`23`	`23`	`systemProperty("collectMetadata", otelProps.collectMetadata)`
`24`	`24`	`}`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`package io.opentelemetry.javaagent.instrumentation.vertx.kafka;`
`7`	`7`
`8`	`8`	`import static java.util.concurrent.TimeUnit.SECONDS;`
	`9`	`+import static org.assertj.core.api.Assertions.assertThat;`
`9`	`10`
`10`	`11`	`import io.opentelemetry.instrumentation.testing.GlobalTraceUtil;`
`11`	`12`	`import io.vertx.core.Handler;`
`@@ -44,7 +45,7 @@ public static void reset(int expectedBatchSize) {`
`44`	`45`	`}`
`45`	`46`
`46`	`47`	`public static void waitForMessages() throws InterruptedException {`
`47`		`- messageReceived.await(30, SECONDS);`
	`48`	`+ assertThat(messageReceived.await(30, SECONDS)).isTrue();`
`48`	`49`	`}`
`49`	`50`
`50`	`51`	`public static int getLastBatchSize() {`