Move glassfish 4 compatibility layer to instrumentation module

Author: labbati

dd-java-agent/agent-tooling/src/main/java/datadog/trace/agent/tooling/compatibility/GlassfishClassloaderBlacklistCompatibility.java

@@ -0,0 +1,34 @@
+apply from: "${rootDir}/gradle/java.gradle"
+apply plugin: 'idea'
+apply plugin: 'org.unbroken-dome.test-sets'
+
+muzzle {
+  pass {
+    group = 'org.glassfish.main.extras'
+    module = 'glassfish-embedded-all'
+    versions = "[4.1,5("
+  }
+}
+
+testSets {
+  latestDepTest {
+    dirName = 'test'
+  }
+}
+
+dependencies {
+
+  compile project(':dd-trace-ot')
+  compile project(':dd-java-agent:agent-tooling')
+
+  compile deps.bytebuddy
+  compile deps.opentracing
+  compile deps.autoservice
+  annotationProcessor deps.autoservice
+  implementation deps.autoservice
+
+  testCompile project(':dd-java-agent:testing')
+  testCompile group: 'org.glassfish.main.extras', name: 'glassfish-embedded-all', version: '4.1.2'
+
+  latestDepTestCompile sourceSets.test.output
+}

dd-java-agent/instrumentation/glassfish-4.1/glassfish-4.1.gradle

@@ -0,0 +1,77 @@
+package datadog.trace.instrumentation.glassfish4;
+
+import static java.util.Collections.singletonMap;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.isPrivate;
+import static net.bytebuddy.matcher.ElementMatchers.nameStartsWith;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
+
+import com.google.auto.service.AutoService;
+import datadog.trace.agent.tooling.Constants;
+import datadog.trace.agent.tooling.ExceptionHandlers;
+import datadog.trace.agent.tooling.Instrumenter;
+import datadog.trace.agent.tooling.Utils;
+import lombok.extern.slf4j.Slf4j;
+import net.bytebuddy.agent.builder.AgentBuilder;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.method.MethodDescription;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+import net.bytebuddy.matcher.ElementMatchers;
+
+import java.util.Map;
+
+/**
+ * This instrumenter prevents a mechanism from GlassFish classloader to produces a class not found
+ * exception in our tracer. Link to the GH issue:
+ * https://github.com/eclipse-ee4j/glassfish/issues/22566 If a class loading is attempted, as an
+ * example, as a resource and is it not found, then it is blacklisted. Successive attempts to load a
+ * class as a class (not a resource) will fail because the class is not even tried. We hook into the
+ * blacklisting method to avoid specific namespaces to be blacklisted.
+ */
+@Slf4j
+@AutoService(Instrumenter.class)
+public final class GlassfishInstrumentation extends Instrumenter.Default {
+
+  public GlassfishInstrumentation() {
+    super("cassandra");
+  }
+
+  @Override
+  public String[] helperClassNames() {
+    return new String[] {Constants.class.getName()};
+  }
+
+  @Override
+  public ElementMatcher<? super TypeDescription> typeMatcher() {
+    return ElementMatchers.named("com.sun.enterprise.v3.server.APIClassLoaderServiceImpl$APIClassLoader");
+  }
+
+  @Override
+  public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() {
+    return singletonMap(
+      isMethod().and(named("addToBlackList")).and(takesArguments(0)),
+      AvoidGlassFishBlacklistAdvice.class.getName());
+  }
+
+  public static class AvoidGlassFishBlacklistAdvice {
+
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void preventBlacklistingOfTracerClasses(
+        @Advice.Argument(value = 0, readOnly = false) String name) {
+      for (String prefix : Constants.BOOTSTRAP_PACKAGE_PREFIXES) {
+        if (name.startsWith(prefix)) {
+          if (log.isDebugEnabled()) {
+            log.debug(
+                "Prevented blacklisting of class {}. Stack trace is: \n{}",
+              name,
+                Utils.getStackTraceAsString());
+          }
+          name = "__datadog_no_blacklist." + name;
+          break;
+        }
+      }
+    }
+  }
+}

dd-java-agent/instrumentation/glassfish-4.1/src/main/java/datadog/trace/instrumentation/glassfish4/GlassfishInstrumentation.java

@@ -40,6 +40,7 @@ include ':dd-java-agent:instrumentation:elasticsearch:transport-2'
 include ':dd-java-agent:instrumentation:elasticsearch:transport-5'
 include ':dd-java-agent:instrumentation:elasticsearch:transport-5.3'
 include ':dd-java-agent:instrumentation:elasticsearch:transport-6'
+include ':dd-java-agent:instrumentation:glassfish-4.1'
 include ':dd-java-agent:instrumentation:grpc-1.5'
 include ':dd-java-agent:instrumentation:hibernate'
 include ':dd-java-agent:instrumentation:hibernate:core-3.3'