Crashtracking: send ping message

Author: amarziali

dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/ConfigManager.java

@@ -9,6 +9,7 @@
 import datadog.trace.api.ProcessTags;
 import datadog.trace.api.WellKnownTags;
 import datadog.trace.util.PidHelper;
+import datadog.trace.util.RandomUtils;
 import java.io.BufferedReader;
 import java.io.BufferedWriter;
 import java.io.IOException;
@@ -31,6 +32,7 @@ public static class StoredConfig {
     final String tags;
     final String processTags;
     final String runtimeId;
+    final String reportUUID;
 
     StoredConfig(
         String service,
@@ -45,6 +47,7 @@ public static class StoredConfig {
       this.tags = tags;
       this.processTags = processTags;
       this.runtimeId = runtimeId;
+      this.reportUUID = RandomUtils.randomUUID().toString();
     }
 
     public static class Builder {

dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/CrashLogParser.java

@@ -4,7 +4,7 @@
 import datadog.crashtracking.parsers.HotspotCrashLogParser;
 
 public final class CrashLogParser {
-  public static CrashLog fromHotspotCrashLog(String logText) {
-    return new HotspotCrashLogParser().parse(logText);
+  public static CrashLog fromHotspotCrashLog(String uuid, String logText) {
+    return new HotspotCrashLogParser().parse(uuid, logText);
   }
 }

dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/CrashUploader.java

@@ -61,8 +61,6 @@ public final class CrashUploader {
 
   private static final MediaType APPLICATION_JSON =
       MediaType.get("application/json; charset=utf-8");
-  private static final MediaType APPLICATION_OCTET_STREAM =
-      MediaType.parse("application/octet-stream");
 
   private final Config config;
   private final ConfigManager.StoredConfig storedConfig;
@@ -114,10 +112,32 @@ public CrashUploader(@Nonnull final ConfigManager.StoredConfig storedConfig) {
                     CRASH_TRACKING_UPLOAD_TIMEOUT, CRASH_TRACKING_UPLOAD_TIMEOUT_DEFAULT)));
   }
 
+  public void notifyCrashStarted(String error) {
+    // send a ping message to the telemetry to notify that the crash report started
+    try (Buffer buf = new Buffer();
+        JsonWriter writer = JsonWriter.of(buf)) {
+      writer.beginObject();
+      writer.name("crash_uuid").value(storedConfig.reportUUID);
+      writer
+          .name("message")
+          .value(
+              "Crashtracker crash ping: " + (error != null ? error : "crash processing started"));
+      writer.endObject();
+      handleCall(
+          makeTelemetryRequest(RequestBody.create(APPLICATION_JSON, buf.toString())), "ping");
+    } catch (Throwable t) {
+      log.error("Failed to send c crash ping", t);
+    }
+  }
+
   public void upload(@Nonnull List<Path> files) throws IOException {
+    String uuid = storedConfig.reportUUID;
     for (Path file : files) {
       uploadToLogs(file);
-      uploadToTelemetry(file);
+      uploadToTelemetry(file, uuid);
+      // if we send more than 1 file via the CLI, let's make sure we have unique uuid (will be
+      // generated if null)
+      uuid = null;
     }
   }
 
@@ -236,24 +256,18 @@ private String extractErrorStackTrace(String fileContent, boolean redact) {
     return "";
   }
 
-  private String extractErrorStackTrace(String fileContent) {
-    return extractErrorStackTrace(fileContent, true);
-  }
-
-  boolean uploadToTelemetry(@Nonnull Path file) {
+  boolean uploadToTelemetry(@Nonnull Path file, String uuid) {
     try {
       String content = new String(Files.readAllBytes(file), Charset.defaultCharset());
-      handleCall(makeTelemetryRequest(content));
+      handleCall(makeTelemetryRequest(makeTelemetryRequestBody(content, uuid)), "file");
     } catch (IOException e) {
       log.error("Failed to upload crash file: {}", file, e);
       return false;
     }
     return true;
   }
 
-  private Call makeTelemetryRequest(@Nonnull String content) throws IOException {
-    final RequestBody requestBody = makeTelemetryRequestBody(content);
-
+  private Call makeTelemetryRequest(@Nonnull RequestBody requestBody) throws IOException {
     final Map<String, String> headers = new HashMap<>();
     // Set chunked transfer
     MediaType contentType = requestBody.contentType();
@@ -273,8 +287,9 @@ private Call makeTelemetryRequest(@Nonnull String content) throws IOException {
             .build());
   }
 
-  private RequestBody makeTelemetryRequestBody(@Nonnull String content) throws IOException {
-    CrashLog crashLog = CrashLogParser.fromHotspotCrashLog(content);
+  private RequestBody makeTelemetryRequestBody(@Nonnull String content, String uuid)
+      throws IOException {
+    CrashLog crashLog = CrashLogParser.fromHotspotCrashLog(content, uuid);
     if (crashLog == null) {
       throw new IOException("Failed to parse crash log");
     }
@@ -327,32 +342,35 @@ private RequestBody makeTelemetryRequestBody(@Nonnull String content) throws IOE
     }
   }
 
-  private void handleCall(final Call call) {
+  private void handleCall(final Call call, String kind) {
     try (Response response = call.execute()) {
-      handleSuccess(call, response);
-    } catch (IOException e) {
-      handleFailure(e);
+      handleSuccess(call, response, kind);
+    } catch (Throwable t) {
+      handleFailure(t, kind);
     }
   }
 
-  private void handleSuccess(final Call call, final Response response) throws IOException {
+  private void handleSuccess(final Call call, final Response response, String kind)
+      throws IOException {
     if (response.isSuccessful()) {
       log.info(
-          "Successfully uploaded the crash files to {}, code = {} \"{}\"",
+          "Successfully uploaded the crash {} to {}, code = {} \"{}\"",
+          kind,
           call.request().url(),
           response.code(),
           response.message());
     } else {
       log.error(
-          "Failed to upload crash files to {}, code = {} \"{}\", body = \"{}\"",
+          "Failed to upload crash {} to {}, code = {} \"{}\", body = \"{}\"",
+          kind,
           call.request().url(),
           response.code(),
           response.message(),
           response.body() != null ? response.body().string().trim() : "<null>");
     }
   }
 
-  private void handleFailure(final IOException exception) {
-    log.error("Failed to upload crash files, got exception", exception);
+  private void handleFailure(final Throwable exception, String kind) {
+    log.error("Failed to upload crash {}, got exception", kind, exception);
   }
 }

dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/dto/CrashLog.java

@@ -17,7 +17,7 @@ public final class CrashLog {
     ADAPTER = moshi.adapter(CrashLog.class);
   }
 
-  public final String uuid = RandomUtils.randomUUID().toString();
+  public final String uuid;
 
   @Json(name = "data_schema_version")
   public final String dataSchemaVersion;
@@ -37,13 +37,15 @@ public final class CrashLog {
   public final int version = VERSION;
 
   public CrashLog(
+      String uuid,
       boolean incomplete,
       String timestamp,
       ErrorData error,
       Metadata metadata,
       OSInfo osInfo,
       ProcInfo procInfo,
       String dataSchemaVersion) {
+    this.uuid = uuid != null ? uuid : RandomUtils.randomUUID().toString();
     this.incomplete = incomplete;
     this.timestamp = timestamp;
     this.error = error;

dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/parsers/HotspotCrashLogParser.java

@@ -115,7 +115,7 @@ private StackFrame parseLine(String line) {
     return null;
   }
 
-  public CrashLog parse(String crashLog) {
+  public CrashLog parse(String uuid, String crashLog) {
     String signal = null;
     String pid = null;
     List<StackFrame> frames = new ArrayList<>();
@@ -213,7 +213,7 @@ public CrashLog parse(String crashLog) {
             SystemProperties.get("os.name"),
             SemanticVersion.of(SystemProperties.get("os.version")));
     ProcInfo procInfo = pid != null ? new ProcInfo(pid) : null;
-    return new CrashLog(false, datetime, error, metadata, osInfo, procInfo, "1.0");
+    return new CrashLog(uuid, false, datetime, error, metadata, osInfo, procInfo, "1.0");
   }
 
   static String dateTimeToISO(String datetime) {

dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/CrashUploaderTest.java

@@ -45,6 +45,7 @@ public class CrashUploaderTest {
   private static final String HOSTNAME = "crash-hostname";
   private static final String SERVICE = "crash-service";
   private static final String VERSION = "crash-version";
+  private static final String SAMPLE_UUID = "a4194cd6-8cb3-45fd-9bd9-3af83e0a3ad3";
   // private static final Map<String, String> TAGS = Map.of("foo", "bar", "baz", "123", "null",
   // null, "empty", "");
 
@@ -159,7 +160,7 @@ public void testTelemetryHappyPath(String log) throws Exception {
     // When
     uploader = new CrashUploader(config, crashConfig);
     server.enqueue(new MockResponse().setResponseCode(200));
-    uploader.uploadToTelemetry(getResourcePath(log));
+    uploader.uploadToTelemetry(getResourcePath(log), SAMPLE_UUID);
 
     final RecordedRequest recordedRequest = server.takeRequest(5, TimeUnit.SECONDS);
 
@@ -170,6 +171,7 @@ public void testTelemetryHappyPath(String log) throws Exception {
     final JsonNode event = mapper.readTree(recordedRequest.getBody().readUtf8());
 
     assertEquals(CrashUploader.TELEMETRY_API_VERSION, event.get("api_version").asText());
+    assertEquals(SAMPLE_UUID, event.get("uuid").asText());
     assertEquals("logs", event.get("request_type").asText());
     assertEquals("crashtracker", event.get("origin").asText());
     assertEquals("1234", event.get("runtime_id").asText());
@@ -209,7 +211,7 @@ public void testTelemetryUnrecognizedFile() throws Exception {
     // When
     uploader = new CrashUploader(config, crashConfig);
     server.enqueue(new MockResponse().setResponseCode(200));
-    assertFalse(uploader.uploadToTelemetry(getResourcePath("no-crash.txt")));
+    assertFalse(uploader.uploadToTelemetry(getResourcePath("no-crash.txt"), null));
   }
 
   @Test

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

@@ -83,22 +83,33 @@ public static void sendSampleTraces(final int count, final double interval) thro
   }
 
   public static void uploadCrash(final String configFile, final String... files) throws Exception {
+    String error = null;
     ConfigManager.StoredConfig storedConfig = null;
     if (configFile != null) {
       Path configPath = Paths.get(configFile);
       if (!Files.exists(configPath)) {
         log.error("Config file {} does not exist", configFile);
-        System.exit(1);
+        error = "Config file does not exist";
       }
       storedConfig = readConfig(Config.get(), configPath);
       if (storedConfig == null) {
         log.error("Unable to parse config file {}", configFile);
-        System.exit(1);
+        error += "Unable to parse config file";
       }
-    } else {
+    }
+    if (storedConfig == null) {
       // if the PID is not provided, the config file will be null
       storedConfig = new ConfigManager.StoredConfig.Builder(Config.get()).build();
     }
+
+    final CrashUploader crashUploader = new CrashUploader(storedConfig);
+    // send the crash ping
+    crashUploader.notifyCrashStarted(error);
+
+    if (error != null) {
+      System.exit(1);
+    }
+
     List<Path> paths = new ArrayList<>(files.length);
     for (String file : files) {
       final Path path = Paths.get(file);
@@ -108,7 +119,7 @@ public static void uploadCrash(final String configFile, final String... files) t
       }
       paths.add(path);
     }
-    new CrashUploader(storedConfig).upload(paths);
+    crashUploader.upload(paths);
   }
 
   public static void sendOomeEvent(String taglist) throws Exception {