Use constant span name when using Spring AMQP AnonymousQueues (#11141)

open-telemetry · Apr 22, 2024 · 84d0511 · 84d0511
1 parent bc5e032
commit 84d0511
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 3 deletions.
diff --git a/...nt/src/main/java/io/opentelemetry/javaagent/instrumentation/rabbitmq/DeliveryRequest.java b/...nt/src/main/java/io/opentelemetry/javaagent/instrumentation/rabbitmq/DeliveryRequest.java
@@ -37,7 +37,8 @@ String spanName() {
     String queue = getQueue();
     if (queue == null || queue.isEmpty()) {
       return "<default> process";
-    } else if (queue.startsWith("amq.gen-")) {
+    } else if (queue.startsWith("amq.gen-") || queue.startsWith("spring.gen-")) {
+      // The spring.gen-<random uid> name comes from AnonymousQueue in the Spring AMQP library
       return "<generated> process";
     } else {
       return queue + " process";

diff --git a/...g/rabbit/v1_0/ContextPropagationTest.java → ...pring/rabbit/v1_0/SpringRabbitMqTest.java b/...g/rabbit/v1_0/ContextPropagationTest.java → ...pring/rabbit/v1_0/SpringRabbitMqTest.java
@@ -31,10 +31,12 @@
 import org.assertj.core.api.AbstractStringAssert;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 import org.springframework.amqp.core.AmqpTemplate;
+import org.springframework.amqp.core.AnonymousQueue;
 import org.springframework.amqp.core.Queue;
 import org.springframework.amqp.rabbit.annotation.RabbitListener;
 import org.springframework.boot.SpringApplication;
@@ -45,7 +47,7 @@
 import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.containers.wait.strategy.Wait;
 
-public class ContextPropagationTest {
+public class SpringRabbitMqTest {
 
   @RegisterExtension
   private static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
@@ -128,7 +130,7 @@ private static List<AttributeAssertion> getAssertions(
 
   @ParameterizedTest
   @ValueSource(booleans = {true, false})
-  public void test(boolean testHeaders) throws Exception {
+  public void testContextPropagation(boolean testHeaders) throws Exception {
     try (Connection connection = connectionFactory.newConnection()) {
       try (Channel ignored = connection.createChannel()) {
         testing.runWithSpan(
@@ -218,6 +220,35 @@ public void test(boolean testHeaders) throws Exception {
     }
   }
 
+  @Test
+  public void testAnonymousQueueSpanName() throws Exception {
+    try (Connection connection = connectionFactory.newConnection()) {
+      try (Channel ignored = connection.createChannel()) {
+        String anonymousQueueName = applicationContext.getBean(AnonymousQueue.class).getName();
+        applicationContext.getBean(AmqpTemplate.class).convertAndSend(anonymousQueueName, "test");
+        applicationContext.getBean(AmqpTemplate.class).receive(anonymousQueueName, 5000);
+
+        testing.waitAndAssertTraces(
+            trace ->
+                trace.hasSpansSatisfyingExactly(
+                    span -> span.hasName("<default> publish"),
+                    // Verify that a constant span name is used instead of the randomly generated
+                    // anonymous queue name
+                    span ->
+                        span.hasName("<generated> process")
+                            .hasAttribute(
+                                equalTo(
+                                    MessagingIncubatingAttributes
+                                        .MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY,
+                                    anonymousQueueName))),
+            trace -> trace.hasSpansSatisfyingExactly(span -> span.hasName("basic.qos")),
+            trace -> trace.hasSpansSatisfyingExactly(span -> span.hasName("basic.consume")),
+            trace -> trace.hasSpansSatisfyingExactly(span -> span.hasName("basic.cancel")),
+            trace -> trace.hasSpansSatisfyingExactly(span -> span.hasName("basic.ack")));
+      }
+    }
+  }
+
   @SpringBootConfiguration
   @EnableAutoConfiguration
   static class ConsumerConfig {
@@ -229,6 +260,11 @@ Queue testQueue() {
       return new Queue(TEST_QUEUE);
     }
 
+    @Bean
+    AnonymousQueue anonymousQueue() {
+      return new AnonymousQueue();
+    }
+
     @RabbitListener(queues = TEST_QUEUE)
     void consume(String ignored) {
       GlobalTraceUtil.runWithSpan("consumer", () -> {});