RabbitMQ metadata (#15748)

Author: jaydeluca

docs/instrumentation-list.yaml

@@ -10538,12 +10538,142 @@ libraries:
       - io.r2dbc:r2dbc-spi:1.0.0.RELEASE
   rabbitmq:
   - name: rabbitmq-2.7
+    display_name: RabbitMQ
+    description: This instrumentation enables messaging spans for RabbitMQ message
+      producers and consumers.
+    semantic_conventions:
+    - MESSAGING_SPANS
+    library_link: https://www.rabbitmq.com/client-libraries/java-api-guide
     source_path: instrumentation/rabbitmq-2.7
     scope:
       name: io.opentelemetry.rabbitmq-2.7
     target_versions:
       javaagent:
       - com.rabbitmq:amqp-client:[2.7.0,)
+    configurations:
+    - name: otel.instrumentation.rabbitmq.experimental-span-attributes
+      description: |
+        Enables experimental span attributes `rabbitmq.command`, `rabbitmq.delivery_mode`, `rabbitmq.queue`, and `rabbitmq.record.queue_time_ms`.
+      type: boolean
+      default: false
+    - name: otel.instrumentation.common.messaging.experimental.receive-telemetry.enabled
+      description: |
+        Enables the creation of consumer spans on messaging receive operations. These spans will measure the time between receiving a message and the consumer processing that message.
+      type: boolean
+      default: false
+    - name: otel.instrumentation.common.messaging.capture-headers
+      description: List of messaging headers to capture.
+      type: list
+      default: ''
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: messaging.system
+          type: STRING
+        - name: network.peer.address
+          type: STRING
+        - name: network.peer.port
+          type: LONG
+        - name: network.type
+          type: STRING
+      - span_kind: CONSUMER
+        attributes:
+        - name: messaging.destination.name
+          type: STRING
+        - name: messaging.message.body.size
+          type: LONG
+        - name: messaging.operation
+          type: STRING
+        - name: messaging.rabbitmq.destination.routing_key
+          type: STRING
+        - name: messaging.system
+          type: STRING
+        - name: network.peer.address
+          type: STRING
+        - name: network.peer.port
+          type: LONG
+        - name: network.type
+          type: STRING
+      - span_kind: PRODUCER
+        attributes:
+        - name: messaging.destination.name
+          type: STRING
+        - name: messaging.message.body.size
+          type: LONG
+        - name: messaging.operation
+          type: STRING
+        - name: messaging.rabbitmq.destination.routing_key
+          type: STRING
+        - name: messaging.system
+          type: STRING
+        - name: network.peer.address
+          type: STRING
+        - name: network.peer.port
+          type: LONG
+        - name: network.type
+          type: STRING
+    - when: otel.instrumentation.rabbitmq.experimental-span-attributes=true
+      spans:
+      - span_kind: CLIENT
+        attributes:
+        - name: messaging.system
+          type: STRING
+        - name: network.peer.address
+          type: STRING
+        - name: network.peer.port
+          type: LONG
+        - name: network.type
+          type: STRING
+        - name: rabbitmq.command
+          type: STRING
+      - span_kind: CONSUMER
+        attributes:
+        - name: messaging.destination.name
+          type: STRING
+        - name: messaging.message.body.size
+          type: LONG
+        - name: messaging.operation
+          type: STRING
+        - name: messaging.rabbitmq.destination.routing_key
+          type: STRING
+        - name: messaging.system
+          type: STRING
+        - name: network.peer.address
+          type: STRING
+        - name: network.peer.port
+          type: LONG
+        - name: network.type
+          type: STRING
+        - name: rabbitmq.command
+          type: STRING
+        - name: rabbitmq.queue
+          type: STRING
+        - name: rabbitmq.record.queue_time_ms
+          type: LONG
+      - span_kind: PRODUCER
+        attributes:
+        - name: messaging.destination.name
+          type: STRING
+        - name: messaging.message.body.size
+          type: LONG
+        - name: messaging.operation
+          type: STRING
+        - name: messaging.rabbitmq.destination.routing_key
+          type: STRING
+        - name: messaging.system
+          type: STRING
+        - name: network.peer.address
+          type: STRING
+        - name: network.peer.port
+          type: LONG
+        - name: network.type
+          type: STRING
+        - name: rabbitmq.command
+          type: STRING
+        - name: rabbitmq.delivery_mode
+          type: LONG
   ratpack:
   - name: ratpack-1.4
     source_path: instrumentation/ratpack/ratpack-1.4

instrumentation-docs/instrumentations.sh

@@ -202,6 +202,8 @@ readonly INSTRUMENTATIONS=(
   "powerjob-4.0:javaagent:testExperimental"
   "pulsar:pulsar-2.8:javaagent:test"
   "pulsar:pulsar-2.8:javaagent:testExperimental"
+  "rabbitmq-2.7:javaagent:test"
+  "rabbitmq-2.7:javaagent:testExperimental"
   "reactor:reactor-netty:reactor-netty-0.9:javaagent:test"
   "reactor:reactor-netty:reactor-netty-1.0:javaagent:test"
   "spring:spring-batch-3.0:javaagent:test"

instrumentation/rabbitmq-2.7/javaagent/build.gradle.kts

@@ -26,12 +26,25 @@ dependencies {
   testLibrary("io.projectreactor.rabbitmq:reactor-rabbitmq:1.0.0.RELEASE")
 }
 
-tasks.withType<Test>().configureEach {
-  // TODO run tests both with and without experimental span attributes
-  jvmArgs("-Dotel.instrumentation.rabbitmq.experimental-span-attributes=true")
-  jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true")
+tasks {
+  withType<Test>().configureEach {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+    systemProperty("testLatestDeps", findProperty("testLatestDeps") ?: "false")
 
-  systemProperty("testLatestDeps", findProperty("testLatestDeps") ?: "false")
+    jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true")
 
-  usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+    usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+  }
+
+  val testExperimental by registering(Test::class) {
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+
+    jvmArgs("-Dotel.instrumentation.rabbitmq.experimental-span-attributes=true")
+    systemProperty("metadataConfig", "otel.instrumentation.rabbitmq.experimental-span-attributes=true")
+  }
+
+  check {
+    dependsOn(testExperimental)
+  }
 }

instrumentation/rabbitmq-2.7/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/rabbitmq/AbstractRabbitMqTest.java

@@ -9,6 +9,7 @@
 import java.net.InetAddress;
 import java.net.UnknownHostException;
 import java.time.Duration;
+import javax.annotation.Nullable;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.slf4j.Logger;
@@ -17,7 +18,15 @@
 import org.testcontainers.containers.output.Slf4jLogConsumer;
 import org.testcontainers.containers.wait.strategy.Wait;
 
-public abstract class AbstractRabbitMqTest {
+abstract class AbstractRabbitMqTest {
+  protected static final boolean EXPERIMENTAL_ATTRIBUTES_ENABLED =
+      Boolean.getBoolean("otel.instrumentation.rabbitmq.experimental-span-attributes");
+
+  @Nullable
+  static <T> T experimental(T value) {
+    return EXPERIMENTAL_ATTRIBUTES_ENABLED ? value : null;
+  }
+
   private static final Logger logger =
       LoggerFactory.getLogger("io.opentelemetry.testing.rabbitmq-container");