feat: add injection metadata fields to telemetry forwarder

.gitignore

@@ -60,6 +60,7 @@ replay_pid*
 .bsp/
 **/src/*/generated/*
 !dd-java-agent/benchmark/releases/*.jar
+*.jar
 
 # Magic for local JMC built
 /vendor/jmc-libs

dd-java-agent/agent-bootstrap/src/main/java/datadog/trace/bootstrap/InitializationTelemetry.java

@@ -8,7 +8,7 @@
  * Thread safe wrapper around BootstrapInitializationTelemetry used inside the Datadog ClassLoader.
  *
  * <p>Right now, this is needed because of the build separation between the two portions of the
- * bootstrap. We should consider adjusting the build to allow Agent et al to reference
+ * bootstrap. We should consider adjusting the build to allow Agent et al. to reference
  * BootstrapInitializationTelemetry, then we could remove this proxy.
  */
 public abstract class InitializationTelemetry {
@@ -48,7 +48,7 @@ public static final InitializationTelemetry noOpInstance() {
   public abstract void onFatalError(Throwable t);
 
   /**
-   * Indicates that an exception conditional occurred during the bootstrapping process. By default
+   * Indicates that an exception conditional occurred during the bootstrapping process. By default,
    * the exceptional condition is assumed to NOT have fully stopped the initialization of the
    * tracer.
    *

dd-java-agent/src/main/java/datadog/trace/bootstrap/BootstrapInitializationTelemetry.java

@@ -53,6 +53,12 @@ public static BootstrapInitializationTelemetry createFromForwarderPath(String fo
 
   public abstract void onError(String reasonCode);
 
+  public abstract void setInjectResult(String result);
+
+  public abstract void setInjectResultReason(String reason);
+
+  public abstract void setInjectResultClass(String resultClass);
+
   public abstract void markIncomplete();
 
   public abstract void finish();
@@ -77,6 +83,15 @@ public void onFatalError(Throwable t) {}
     @Override
     public void onError(Throwable t) {}
 
+    @Override
+    public void setInjectResult(String result) {}
+
+    @Override
+    public void setInjectResultReason(String reason) {}
+
+    @Override
+    public void setInjectResultClass(String resultClass) {}
+
     @Override
     public void markIncomplete() {}
 
@@ -92,6 +107,7 @@ public static final class JsonBased extends BootstrapInitializationTelemetry {
 
     // one way false to true
     private volatile boolean incomplete = false;
+    private volatile boolean error = false;
 
     JsonBased(JsonSender sender) {
       this.sender = sender;
@@ -107,15 +123,37 @@ public void initMetaInfo(String attr, String value) {
       }
     }
 
+    @Override
+    public void setInjectResult(String result) {
+      initMetaInfo("result", result);
+    }
+
+    @Override
+    public void setInjectResultReason(String resultReason) {
+      initMetaInfo("resultReason", resultReason);
+    }
+
+    @Override
+    public void setInjectResultClass(String resultClass) {
+      initMetaInfo("resultClass", resultClass);
+    }
+
     @Override
     public void onAbort(String reasonCode) {
       onPoint("library_entrypoint.abort", "reason:" + reasonCode);
       markIncomplete();
+      setInjectResult("abort");
+      setInjectResultReason(reasonCode);
+      setInjectResultClass(mapResultClass(reasonCode));
     }
 
     @Override
     public void onError(Throwable t) {
+      error = true;
       onPoint("library_entrypoint.error", "error_type:" + t.getClass().getName());
+      setInjectResult("error");
+      setInjectResultReason(t.getMessage());
+      setInjectResultClass("internal_error");
     }
 
     @Override
@@ -126,7 +164,27 @@ public void onFatalError(Throwable t) {
 
     @Override
     public void onError(String reasonCode) {
+      error = true;
       onPoint("library_entrypoint.error", "error_type:" + reasonCode);
+      setInjectResult("error");
+      setInjectResultReason(reasonCode);
+      setInjectResultClass(mapResultClass(reasonCode));
+    }
+
+    private String mapResultClass(String reasonCode) {
+      if (reasonCode == null) {
+        return "success";
+      }
+      switch (reasonCode) {
+        case "already_initialized":
+          return "already_initialized";
+        case "other-java-agents":
+          return "already_instrumented";
+        case "jdk_tool":
+          return "incorrect_installation";
+        default:
+          return "unknown";
+      }
     }
 
     private void onPoint(String name, String tag) {
@@ -143,6 +201,11 @@ public void markIncomplete() {
 
     @Override
     public void finish() {
+      if (!this.incomplete && !this.error) {
+        setInjectResult("success");
+        setInjectResultReason("Successfully configured ddtrace package");
+        setInjectResultClass("success");
+      }
       try (JsonWriter writer = new JsonWriter()) {
         writer.beginObject();
         writer.name("metadata").beginObject();

dd-java-agent/src/main/java6/datadog/trace/bootstrap/AgentPreCheck.java

@@ -11,6 +11,7 @@
 
 /** Special lightweight pre-main class that skips installation on incompatible JVMs. */
 public class AgentPreCheck {
+  public static final int minJavaVersion = 8;
   public static void premain(final String agentArgs, final Instrumentation inst) {
     agentmain(agentArgs, inst);
   }
@@ -59,6 +60,10 @@ static void sendTelemetry(String forwarderPath, String javaVersion, String agent
             + "\"points\":[{"
             + "\"name\":\"library_entrypoint.abort\","
             + "\"tags\":[\"reason:incompatible_runtime\"]"
+            + "\"result:error\","
+            + "\"result_class:incompatible_runtime\","
+            + "\"result_reason:need to install a java version later than " + minJavaVersion + "\""
+            + "]"
             + "}]"
             + "}";
 
@@ -87,7 +92,7 @@ private static boolean compatible() {
   static boolean compatible(String javaVersion, String javaHome, PrintStream output) {
     int majorJavaVersion = parseJavaMajorVersion(javaVersion);
 
-    if (majorJavaVersion >= 8) {
+    if (majorJavaVersion >= minJavaVersion) {
       return true;
     }
 

dd-java-agent/src/test/groovy/datadog/trace/bootstrap/BootstrapInitializationTelemetryTest.groovy

@@ -38,7 +38,78 @@ class BootstrapInitializationTelemetryTest extends Specification {
     initTelemetry.finish()
 
     then:
-    capture.json() == '{"metadata":{"runtime_name":"java","runtime_version":"1.8.0_382"},"points":[{"name":"library_entrypoint.error","tags":["error_type:java.lang.Exception"]},{"name":"library_entrypoint.complete"}]}'
+    capture.json() == '{"metadata":{"runtime_name":"java","runtime_version":"1.8.0_382","result":"error","resultReason":"foo","resultClass":"internal_error"},"points":[{"name":"library_entrypoint.error","tags":["error_type:java.lang.Exception"]},{"name":"library_entrypoint.complete"}]}'
+  }
+
+  def "test fatal error"() {
+    when:
+    initTelemetry.initMetaInfo("runtime_name", "java")
+    initTelemetry.initMetaInfo("runtime_version", "1.8.0_382")
+
+    initTelemetry.onFatalError(new Exception("foo"))
+    initTelemetry.finish()
+
+    then:
+    capture.json() == '{"metadata":{"runtime_name":"java","runtime_version":"1.8.0_382","result":"error","resultReason":"foo","resultClass":"internal_error"},"points":[{"name":"library_entrypoint.error","tags":["error_type:java.lang.Exception"]}]}'
+  }
+
+  def "test abort"() {
+    when:
+    initTelemetry.initMetaInfo("runtime_name", "java")
+    initTelemetry.initMetaInfo("runtime_version", "1.8.0_382")
+
+    initTelemetry.onAbort("jdk_tool")
+    initTelemetry.finish()
+
+    then:
+    capture.json() == '{"metadata":{"runtime_name":"java","runtime_version":"1.8.0_382","result":"abort","resultReason":"jdk_tool","resultClass":"incorrect_installation"},"points":[{"name":"library_entrypoint.abort","tags":["reason:jdk_tool"]}]}'
+  }
+
+  def "test success"() {
+    when:
+    initTelemetry.initMetaInfo("runtime_name", "java")
+    initTelemetry.initMetaInfo("runtime_version", "1.8.0_382")
+
+    initTelemetry.finish()
+
+    then:
+    capture.json() == '{"metadata":{"runtime_name":"java","runtime_version":"1.8.0_382","result":"success","resultReason":"Successfully configured ddtrace package","resultClass":"success"},"points":[{"name":"library_entrypoint.complete"}]}'
+  }
+
+  def "test abort jdk_tool"() {
+    when:
+    initTelemetry.initMetaInfo("runtime_name", "java")
+    initTelemetry.initMetaInfo("runtime_version", "1.8.0_382")
+
+    initTelemetry.onAbort("jdk_tool")
+    initTelemetry.finish()
+
+    then:
+    capture.json() == '{"metadata":{"runtime_name":"java","runtime_version":"1.8.0_382","result":"abort","resultReason":"jdk_tool","resultClass":"incorrect_installation"},"points":[{"name":"library_entrypoint.abort","tags":["reason:jdk_tool"]}]}'
+  }
+
+  def "test abort other-java-agents"() {
+    when:
+    initTelemetry.initMetaInfo("runtime_name", "java")
+    initTelemetry.initMetaInfo("runtime_version", "1.8.0_382")
+
+    initTelemetry.onAbort("other-java-agents")
+    initTelemetry.finish()
+
+    then:
+    capture.json() == '{"metadata":{"runtime_name":"java","runtime_version":"1.8.0_382","result":"abort","resultReason":"other-java-agents","resultClass":"already_instrumented"},"points":[{"name":"library_entrypoint.abort","tags":["reason:other-java-agents"]}]}'
+  }
+
+  def "test abort unknown"() {
+    when:
+    initTelemetry.initMetaInfo("runtime_name", "java")
+    initTelemetry.initMetaInfo("runtime_version", "1.8.0_382")
+
+    initTelemetry.onAbort("foo")
+    initTelemetry.finish()
+
+    then:
+    capture.json() == '{"metadata":{"runtime_name":"java","runtime_version":"1.8.0_382","result":"abort","resultReason":"foo","resultClass":"unknown"},"points":[{"name":"library_entrypoint.abort","tags":["reason:foo"]}]}'
   }
 
   def "trivial completion check"() {