Merge pull request #839 from DataDog/labbati/jdbc-error-glasshfish

Glassfish: prevent blacklisting of specific classes and dump stacktrace in debug mode if this happens

Author: labbati

dd-java-agent/agent-tooling/src/main/java/datadog/trace/agent/tooling/Utils.java

@@ -84,5 +84,17 @@ public static MethodDescription getMethodDefinition(
     return type.getDeclaredMethods().filter(named(methodName)).getOnly();
   }
 
+  /** @return The current stack trace with multiple entries on new lines. */
+  public static String getStackTraceAsString() {
+    StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
+    StringBuilder stringBuilder = new StringBuilder();
+    String lineSeparator = System.getProperty("line.separator");
+    for (StackTraceElement element : stackTrace) {
+      stringBuilder.append(element.toString());
+      stringBuilder.append(lineSeparator);
+    }
+    return stringBuilder.toString();
+  }
+
   private Utils() {}
 }

dd-java-agent/agent-tooling/src/test/groovy/datadog/trace/agent/tooling/UtilsTest.groovy

@@ -0,0 +1,16 @@
+package datadog.trace.agent.tooling
+
+import spock.lang.Specification
+
+
+class UtilsTest extends Specification {
+
+  def "getStackTraceAsString() returns the stack trace as a single new line separated string"() {
+    setup:
+    def stackTrace = Utils.stackTraceAsString
+
+    expect:
+    stackTrace.contains('datadog.trace.agent.tooling.Utils')
+    stackTrace.contains(System.getProperty("line.separator"))
+  }
+}

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

@@ -0,0 +1,35 @@
+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 = "[3.0,)"
+    assertInverse = true
+  }
+}
+
+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/src/main/java/datadog/trace/instrumentation/glassfish/GlassfishInstrumentation.java

@@ -0,0 +1,66 @@
+package datadog.trace.instrumentation.glassfish;
+
+import static java.util.Collections.singletonMap;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+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.Instrumenter;
+import java.util.Map;
+import lombok.extern.slf4j.Slf4j;
+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;
+
+/**
+ * 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("glassfish");
+  }
+
+  @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(1)),
+        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)) {
+          name = "__datadog_no_blacklist." + name;
+          break;
+        }
+      }
+    }
+  }
+}

settings.gradle

@@ -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'
 include ':dd-java-agent:instrumentation:grpc-1.5'
 include ':dd-java-agent:instrumentation:hibernate'
 include ':dd-java-agent:instrumentation:hibernate:core-3.3'