JMS instrumentation: do not create spans if no messages are received (#2091)

* #1989 JMS instrumentation: do not create spans if no messages are received

Signed-off-by: Sergei Malafeev <sergei@malafeev.org>

* remove the redundant else

Signed-off-by: Sergei Malafeev <sergei@malafeev.org>

* remove JmsSessionInstrumentation

Signed-off-by: Sergei Malafeev <sergei@malafeev.org>

Co-authored-by: Anuraag Agrawal <aanuraag@amazon.co.jp>

instrumentation/jms-1.1/javaagent/src/jms2Test/groovy/Jms2Test.groovy

@@ -161,22 +161,8 @@ class Jms2Test extends AgentTestRunner {
 
     expect:
     receivedMessage == null
-    assertTraces(1) {
+    // span is not created if no message is received
-      trace(0, 1) { // Consumer trace
+    assertTraces(0,{})
-        span(0) {
-          hasNoParent()
-          name destinationName + " receive"
-          kind CONSUMER
-          errored false
-          attributes {
-            "${SemanticAttributes.MESSAGING_SYSTEM.key}" "jms"
-            "${SemanticAttributes.MESSAGING_DESTINATION_KIND.key}" destinationType
-            "${SemanticAttributes.MESSAGING_DESTINATION.key}" destinationName
-            "${SemanticAttributes.MESSAGING_OPERATION.key}" "receive"
-          }
-        }
-      }
-    }
 
     cleanup:
     consumer.close()
@@ -196,23 +182,8 @@ class Jms2Test extends AgentTestRunner {
 
     expect:
     receivedMessage == null
-    assertTraces(1) {
+    // span is not created if no message is received
-      trace(0, 1) { // Consumer trace
+    assertTraces(0, {})
-        span(0) {
-          hasNoParent()
-          name destinationName + " receive"
-          kind CONSUMER
-          errored false
-          attributes {
-            "${SemanticAttributes.MESSAGING_SYSTEM.key}" "jms"
-            "${SemanticAttributes.MESSAGING_DESTINATION_KIND.key}" destinationType
-            "${SemanticAttributes.MESSAGING_DESTINATION.key}" destinationName
-            "${SemanticAttributes.MESSAGING_OPERATION.key}" "receive"
-
-          }
-        }
-      }
-    }
 
     cleanup:
     consumer.close()

instrumentation/jms-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jms/JmsInstrumentationModule.java

@@ -25,8 +25,7 @@ public class JmsInstrumentationModule extends InstrumentationModule {
     return asList(
         new JmsMessageConsumerInstrumentation(),
         new JmsMessageListenerInstrumentation(),
-        new JmsMessageProducerInstrumentation(),
+        new JmsMessageProducerInstrumentation());
-        new JmsSessionInstrumentation());
   }
 
   @Override

instrumentation/jms-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jms/JmsMessageConsumerInstrumentation.java

@@ -13,12 +13,10 @@ import static net.bytebuddy.matcher.ElementMatchers.named;
 import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
 
 import io.opentelemetry.api.trace.Span;
-import io.opentelemetry.javaagent.instrumentation.api.InstrumentationContext;
 import io.opentelemetry.javaagent.tooling.TypeInstrumentation;
 import java.util.HashMap;
 import java.util.Map;
 import javax.jms.Message;
-import javax.jms.MessageConsumer;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.method.MethodDescription;
 import net.bytebuddy.description.type.TypeDescription;
@@ -57,21 +55,15 @@ public class JmsMessageConsumerInstrumentation implements TypeInstrumentation {
 
     @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
     public static void stopSpan(
-        @Advice.This MessageConsumer consumer,
         @Advice.Enter long startTime,
         @Advice.Return Message message,
         @Advice.Thrown Throwable throwable) {
       MessageDestination destination;
       if (message == null) {
-        destination =
+        // Do not create span when no message is received
-            InstrumentationContext.get(MessageConsumer.class, MessageDestination.class)
+        return;
-                .get(consumer);
-        if (destination == null) {
-          destination = MessageDestination.UNKNOWN;
       }
-      } else {
       destination = tracer().extractDestination(message, null);
-      }
 
       Span span = tracer().startConsumerSpan(destination, "receive", message, startTime);
 

instrumentation/jms-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jms/JmsSessionInstrumentation.java

@@ -1,56 +0,0 @@
-/*
- * Copyright The OpenTelemetry Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-
-package io.opentelemetry.javaagent.instrumentation.jms;
-
-import static io.opentelemetry.javaagent.tooling.bytebuddy.matcher.AgentElementMatchers.implementsInterface;
-import static io.opentelemetry.javaagent.tooling.bytebuddy.matcher.ClassLoaderMatcher.hasClassesNamed;
-import static java.util.Collections.singletonMap;
-import static net.bytebuddy.matcher.ElementMatchers.isPublic;
-import static net.bytebuddy.matcher.ElementMatchers.named;
-import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
-
-import io.opentelemetry.javaagent.instrumentation.api.InstrumentationContext;
-import io.opentelemetry.javaagent.tooling.TypeInstrumentation;
-import java.util.Map;
-import javax.jms.Destination;
-import javax.jms.MessageConsumer;
-import net.bytebuddy.asm.Advice;
-import net.bytebuddy.description.method.MethodDescription;
-import net.bytebuddy.description.type.TypeDescription;
-import net.bytebuddy.matcher.ElementMatcher;
-
-public class JmsSessionInstrumentation implements TypeInstrumentation {
-
-  @Override
-  public ElementMatcher<ClassLoader> classLoaderOptimization() {
-    return hasClassesNamed("javax.jms.Session");
-  }
-
-  @Override
-  public ElementMatcher<TypeDescription> typeMatcher() {
-    return implementsInterface(named("javax.jms.Session"));
-  }
-
-  @Override
-  public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() {
-    return singletonMap(
-        named("createConsumer")
-            .and(takesArgument(0, named("javax.jms.Destination")))
-            .and(isPublic()),
-        JmsSessionInstrumentation.class.getName() + "$ConsumerAdvice");
-  }
-
-  public static class ConsumerAdvice {
-
-    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
-    public static void onExit(
-        @Advice.Argument(0) Destination destination, @Advice.Return MessageConsumer consumer) {
-      MessageDestination messageDestination = JmsTracer.extractMessageDestination(destination);
-      InstrumentationContext.get(MessageConsumer.class, MessageDestination.class)
-          .put(consumer, messageDestination);
-    }
-  }
-}

instrumentation/jms-1.1/javaagent/src/test/groovy/Jms1Test.groovy

@@ -134,22 +134,8 @@ class Jms1Test extends AgentTestRunner {
 
     expect:
     receivedMessage == null
-    assertTraces(1) {
+    // span is not created if no message is received
-      trace(0, 1) { // Consumer trace
+    assertTraces(0, {})
-        span(0) {
-          hasNoParent()
-          name destinationName + " receive"
-          kind CONSUMER
-          errored false
-          attributes {
-            "${SemanticAttributes.MESSAGING_SYSTEM.key}" "jms"
-            "${SemanticAttributes.MESSAGING_DESTINATION.key}" destinationName
-            "${SemanticAttributes.MESSAGING_DESTINATION_KIND.key}" destinationType
-            "${SemanticAttributes.MESSAGING_OPERATION.key}" "receive"
-          }
-        }
-      }
-    }
 
     cleanup:
     consumer.close()
@@ -169,22 +155,8 @@ class Jms1Test extends AgentTestRunner {
 
     expect:
     receivedMessage == null
-    assertTraces(1) {
+    // span is not created if no message is received
-      trace(0, 1) { // Consumer trace
+    assertTraces(0, {})
-        span(0) {
-          hasNoParent()
-          name destinationName + " receive"
-          kind CONSUMER
-          errored false
-          attributes {
-            "${SemanticAttributes.MESSAGING_SYSTEM.key}" "jms"
-            "${SemanticAttributes.MESSAGING_DESTINATION.key}" destinationName
-            "${SemanticAttributes.MESSAGING_DESTINATION_KIND.key}" destinationType
-            "${SemanticAttributes.MESSAGING_OPERATION.key}" "receive"
-          }
-        }
-      }
-    }
 
     cleanup:
     consumer.close()