Fix spring jms listener instrumentation (#3359)

* Fix Spring JMS listener instrumentation * Comment * More allows
open-telemetry · Jun 23, 2021 · 1deb81a · 1deb81a
1 parent 5242ef2
commit 1deb81a
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 7 deletions.
diff --git a/...va/io/opentelemetry/javaagent/tooling/ignore/AdditionalLibraryIgnoredTypesConfigurer.java b/...va/io/opentelemetry/javaagent/tooling/ignore/AdditionalLibraryIgnoredTypesConfigurer.java
@@ -29,10 +29,13 @@ public class AdditionalLibraryIgnoredTypesConfigurer implements IgnoredTypesConf
 
   @Override
   public void configure(Config config, IgnoredTypesBuilder builder) {
-    if (!config.getBooleanProperty(ADDITIONAL_LIBRARY_IGNORES_ENABLED, true)) {
-      return;
+    if (config.getBooleanProperty(ADDITIONAL_LIBRARY_IGNORES_ENABLED, true)) {
+      configure(builder);
     }
+  }
 
+  // only used by tests (to bypass the ignores check)
+  public void configure(IgnoredTypesBuilder builder) {
     builder
         .ignoreClass("com.beust.jcommander.")
         .ignoreClass("com.fasterxml.classmate.")
@@ -76,7 +79,14 @@ public void configure(Config config, IgnoredTypesBuilder builder) {
 
     builder
         .ignoreClass("org.springframework.amqp.")
-        .allowClass("org.springframework.amqp.rabbit.connection.");
+        .allowClass("org.springframework.amqp.rabbit.connection.")
+        .allowClass("org.springframework.amqp.rabbit.listener.AbstractMessageListenerContainer")
+        // these implement Runnable, so tests currently force these allows
+        // though not sure if it's important or not that they get instrumented
+        .allowClass(
+            "org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer$AsyncMessageProcessingConsumer")
+        .allowClass(
+            "org.springframework.amqp.rabbit.listener.RabbitListenerEndpointRegistry$AggregatingCallback");
 
     builder
         .ignoreClass("org.springframework.beans.")
@@ -146,8 +156,8 @@ public void configure(Config config, IgnoredTypesBuilder builder) {
 
     builder
         .ignoreClass("org.springframework.jms.")
-        .ignoreClass("org.springframework.jms.listener.")
-        .ignoreClass(
+        .allowClass("org.springframework.jms.listener.")
+        .allowClass(
             "org.springframework.jms.config.JmsListenerEndpointRegistry$AggregatingCallback");
 
     builder

diff --git a/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/AgentTestRunner.java b/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/AgentTestRunner.java
@@ -46,6 +46,11 @@ public void afterTestClass() {
     assert TestAgentListenerAccess.getInstrumentationErrorCount() == 0
         : TestAgentListenerAccess.getInstrumentationErrorCount()
             + " Instrumentation errors during test";
+    // additional library ignores are ignored during tests, because they can make it really
+    // confusing for contributors wondering why their instrumentation is not applied
+    //
+    // but we then need to make sure that the additional library ignores won't then silently prevent
+    // the instrumentation from being applied in real life outside of these tests
     assert TestAgentListenerAccess.getIgnoredButTransformedClassNames().isEmpty()
         : "Transformed classes match global libraries ignore matcher: "
             + TestAgentListenerAccess.getIgnoredButTransformedClassNames();

diff --git a/...xporter/src/main/java/io/opentelemetry/javaagent/testing/bytebuddy/TestAgentListener.java b/...xporter/src/main/java/io/opentelemetry/javaagent/testing/bytebuddy/TestAgentListener.java
@@ -5,7 +5,6 @@
 
 package io.opentelemetry.javaagent.testing.bytebuddy;
 
-import io.opentelemetry.instrumentation.api.config.Config;
 import io.opentelemetry.javaagent.tooling.ignore.AdditionalLibraryIgnoredTypesConfigurer;
 import io.opentelemetry.javaagent.tooling.ignore.IgnoreAllow;
 import io.opentelemetry.javaagent.tooling.ignore.IgnoredTypesBuilderImpl;
@@ -33,7 +32,7 @@ public class TestAgentListener implements AgentBuilder.Listener {
 
   static {
     IgnoredTypesBuilderImpl builder = new IgnoredTypesBuilderImpl();
-    new AdditionalLibraryIgnoredTypesConfigurer().configure(Config.get(), builder);
+    new AdditionalLibraryIgnoredTypesConfigurer().configure(builder);
     ADDITIONAL_LIBRARIES_TRIE = builder.buildIgnoredTypesTrie();
   }