Adding Logging for JMS ITERATION Scope (#10632)

adding logging

adding wrapper to avoid bytebuddy issues

PR comments

Merge branch 'master' into mhlidd/add_jms_logging

Merge branch 'master' into mhlidd/add_jms_logging

adding log helper to helper class names

moving logger out of nested class

Co-authored-by: matthew.li <matthew.li@datadoghq.com>

Author: mhlidd

dd-java-agent/instrumentation/jms/javax-jms-1.1/src/main/java/datadog/trace/instrumentation/jms/JMSLogger.java

@@ -0,0 +1,13 @@
+package datadog.trace.instrumentation.jms;
+
+import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class JMSLogger {
+  private static final Logger log = LoggerFactory.getLogger(JMSLogger.class);
+
+  public static void logIterationSpan(AgentSpan span) {
+    log.debug("Expecting the following `ITERATION` span to be finished {}", span);
+  }
+}

dd-java-agent/instrumentation/jms/javax-jms-1.1/src/main/java/datadog/trace/instrumentation/jms/JMSMessageConsumerInstrumentation.java

@@ -164,6 +164,7 @@ public static void afterReceive(
       CONSUMER_DECORATE.onError(span, throwable);
 
       activateNext(span); // scope is left open until next message or it times out
+      JMSLogger.logIterationSpan(span);
 
       SessionState sessionState = consumerState.getSessionState();
       if (sessionState.isClientAcknowledge()) {

dd-java-agent/instrumentation/jms/javax-jms-1.1/src/main/java/datadog/trace/instrumentation/jms/JavaxJmsModule.java

@@ -36,7 +36,8 @@ public String[] helperClassNames() {
       packageName + ".MessageExtractAdapter",
       packageName + ".MessageExtractAdapter$1",
       packageName + ".MessageInjectAdapter",
-      packageName + ".DatadogMessageListener"
+      packageName + ".DatadogMessageListener",
+      packageName + ".JMSLogger"
     };
   }
 

dd-trace-core/src/main/java/datadog/trace/core/scopemanager/ContinuableScopeManager.java

@@ -1,6 +1,7 @@
 package datadog.trace.core.scopemanager;
 
 import static datadog.trace.api.ConfigDefaults.DEFAULT_ASYNC_PROPAGATING;
+import static datadog.trace.api.telemetry.LogCollector.SEND_TELEMETRY;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.noopScope;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.noopSpan;
 import static datadog.trace.core.scopemanager.ContinuableScope.CONTEXT;
@@ -248,6 +249,13 @@ public void closePrevious(final boolean finishSpan) {
       if (finishSpan && span != null) {
         span.finishWithEndToEnd();
       }
+    } else if (top != null) {
+      log.debug(
+          SEND_TELEMETRY,
+          "Scope found at top of stack has source {} when we expect {}. Current span at the top of the stack {}.",
+          top.source(),
+          ITERATION,
+          top.span());
     }
   }