feat(crashtracking): Add crashtracking.experimental.register-mapping.enabled

bric3 · bric3 · commit c71deb43af19 · 2026-04-02T16:32:16.000+02:00
diff --git a/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/ConfigManager.java b/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/ConfigManager.java
@@ -35,6 +35,7 @@ public static class StoredConfig {
     final String reportUUID;
     final boolean agentless;
     final boolean sendToErrorTracking;
+    final boolean registerMappingEnabled;
 
     StoredConfig(
         String reportUUID,
@@ -45,7 +46,8 @@ public static class StoredConfig {
         String processTags,
         String runtimeId,
         boolean agentless,
-        boolean sendToErrorTracking) {
+        boolean sendToErrorTracking,
+        boolean registerMappingEnabled) {
       this.service = service;
       this.env = env;
       this.version = version;
@@ -55,6 +57,11 @@ public static class StoredConfig {
       this.reportUUID = reportUUID;
       this.agentless = agentless;
       this.sendToErrorTracking = sendToErrorTracking;
+      this.registerMappingEnabled = registerMappingEnabled;
+    }
+
+    public CrashUploaderSettings toCrashUploaderSettings() {
+      return new CrashUploaderSettings(registerMappingEnabled);
     }
 
     public static class Builder {
@@ -67,6 +74,7 @@ public static class Builder {
       String reportUUID;
       boolean agentless;
       boolean sendToErrorTracking;
+      boolean registerMappingEnabled;
 
       public Builder(Config config) {
         // get sane defaults
@@ -77,6 +85,7 @@ public Builder(Config config) {
         this.reportUUID = RandomUtils.randomUUID().toString();
         this.agentless = config.isCrashTrackingAgentless();
         this.sendToErrorTracking = config.isCrashTrackingErrorsIntakeEnabled();
+        this.registerMappingEnabled = config.isCrashTrackingExperimentalRegisterMappingEnabled();
       }
 
       public Builder service(String service) {
@@ -119,6 +128,11 @@ public Builder agentless(boolean agentless) {
         return this;
       }
 
+      public Builder registerMappingEnabled(boolean registerMappingEnabled) {
+        this.registerMappingEnabled = registerMappingEnabled;
+        return this;
+      }
+
       // @VisibleForTesting
       Builder reportUUID(String reportUUID) {
         this.reportUUID = reportUUID;
@@ -135,7 +149,8 @@ public StoredConfig build() {
             processTags,
             runtimeId,
             agentless,
-            sendToErrorTracking);
+            sendToErrorTracking,
+            registerMappingEnabled);
       }
     }
   }
@@ -194,6 +209,10 @@ static void writeConfigToFile(Config config, Path cfgPath, String... additionalE
       writeEntry(bw, "java_home", SystemProperties.get("java.home"));
       writeEntry(bw, "agentless", Boolean.toString(config.isCrashTrackingAgentless()));
       writeEntry(bw, "upload_to_et", Boolean.toString(config.isCrashTrackingErrorsIntakeEnabled()));
+      writeEntry(
+          bw,
+          "register_mapping",
+          Boolean.toString(config.isCrashTrackingExperimentalRegisterMappingEnabled()));
 
       Runtime.getRuntime()
           .addShutdownHook(
@@ -257,6 +276,9 @@ public static StoredConfig readConfig(Config config, Path scriptPath) {
           case "upload_to_et":
             cfgBuilder.sendToErrorTracking(Boolean.parseBoolean(value));
             break;
+          case "register_mapping":
+            cfgBuilder.registerMappingEnabled(Boolean.parseBoolean(value));
+            break;
           default:
             // ignore
             break;
diff --git a/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/CrashLogParser.java b/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/CrashLogParser.java
@@ -33,10 +33,18 @@ public static CrashLog fromJ9Javacore(String uuid, String javacoreContent) {
    * </ul>
    */
   public static CrashLog parse(String uuid, String content) {
+    return parse(uuid, content, new CrashUploaderSettings(true));
+  }
+
+  /**
+   * Auto-detect crash log format and parse accordingly, using the provided settings to control
+   * which sections are included in the result.
+   */
+  public static CrashLog parse(String uuid, String content, CrashUploaderSettings settings) {
     if (isJ9Javacore(content)) {
       return fromJ9Javacore(uuid, content);
     }
-    return fromHotspotCrashLog(uuid, content);
+    return new HotspotCrashLogParser(settings).parse(uuid, content);
   }
 
   /** Check if the content appears to be a J9 javacore file. */
diff --git a/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/CrashUploader.java b/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/CrashUploader.java
@@ -257,7 +257,8 @@ void remoteUpload(
     final String uuid = storedConfig.reportUUID;
     try {
       // Auto-detect crash log format (HotSpot hs_err or J9 javacore)
-      CrashLog crashLog = CrashLogParser.parse(uuid, fileContent);
+      CrashLog crashLog =
+          CrashLogParser.parse(uuid, fileContent, storedConfig.toCrashUploaderSettings());
       if (sendToTelemetry) {
         uploadToTelemetry(crashLog);
       }
diff --git a/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/CrashUploaderSettings.java b/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/CrashUploaderSettings.java
@@ -0,0 +1,18 @@
+package datadog.crashtracking;
+
+/**
+ * Crash-tracking-specific settings controlling which sections are included in parsed crash reports.
+ */
+public final class CrashUploaderSettings {
+
+  private final boolean registerMappingEnabled;
+
+  public CrashUploaderSettings(boolean registerMappingEnabled) {
+    this.registerMappingEnabled = registerMappingEnabled;
+  }
+
+  /** Whether the register-to-memory mapping section should be included in parsed crash reports. */
+  public boolean isRegisterMappingEnabled() {
+    return registerMappingEnabled;
+  }
+}
diff --git a/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/parsers/HotspotCrashLogParser.java b/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/parsers/HotspotCrashLogParser.java
@@ -3,6 +3,7 @@
 import static java.time.format.DateTimeFormatter.ISO_OFFSET_DATE_TIME;
 
 import datadog.common.version.VersionInfo;
+import datadog.crashtracking.CrashUploaderSettings;
 import datadog.crashtracking.buildid.BuildIdCollector;
 import datadog.crashtracking.buildid.BuildInfo;
 import datadog.crashtracking.dto.CrashLog;
@@ -72,9 +73,15 @@ enum State {
   }
 
   private State state = State.NEW;
+  private final CrashUploaderSettings settings;
 
   public HotspotCrashLogParser() {
+    this(new CrashUploaderSettings(true));
+  }
+
+  public HotspotCrashLogParser(CrashUploaderSettings settings) {
     this.buildIdCollector = new BuildIdCollector();
+    this.settings = settings;
   }
 
   private static final Pattern PLUS_SPLITTER = Pattern.compile("\\+");
@@ -598,12 +605,16 @@ public CrashLog parse(String uuid, String crashLog) {
     Metadata metadata = new Metadata("dd-trace-java", VersionInfo.VERSION, "java", null);
     Integer parsedPid = safelyParseInt(pid);
     ProcInfo procInfo = parsedPid != null ? new ProcInfo(parsedPid) : null;
-    registerToMemoryMapping.replaceAll((k, v) -> RedactUtils.redactRegisterToMemoryMapping(v));
+    Map<String, String> resolvedMapping = null;
+    if (settings.isRegisterMappingEnabled() && !registerToMemoryMapping.isEmpty()) {
+      registerToMemoryMapping.replaceAll((k, v) -> RedactUtils.redactRegisterToMemoryMapping(v));
+      resolvedMapping = registerToMemoryMapping;
+    }
     Experimental experimental =
         !registers.isEmpty()
-                || !registerToMemoryMapping.isEmpty()
+                || resolvedMapping != null
                 || (runtimeArgs != null && !runtimeArgs.isEmpty())
-            ? new Experimental(registers, registerToMemoryMapping, runtimeArgs)
+            ? new Experimental(registers, resolvedMapping, runtimeArgs)
             : null;
     DynamicLibs files =
         (dynamicLibraryLines != null && !dynamicLibraryLines.isEmpty())
diff --git a/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/parsers/RedactUtils.java b/dd-java-agent/agent-crashtracking/src/main/java/datadog/crashtracking/parsers/RedactUtils.java
@@ -44,8 +44,7 @@ public final class RedactUtils {
   private static final Pattern METHOD_IN_CLASS = Pattern.compile("( in ')([^']+)'");
 
   // Object-reference field values in oop dumps: a 'com/company/Class'{0x...}
-  private static final Pattern OBJ_FIELD_REF =
-      Pattern.compile("(a ')([A-Za-z$_][A-Za-z0-9$_/]*)'");
+  private static final Pattern OBJ_FIELD_REF = Pattern.compile("(a ')([A-Za-z$_][A-Za-z0-9$_/]*)'");
 
   // Class name in nmethod compiled-method output (JDK 11+):
   //   "Compiled method (c2) ... com.company.Foo::methodName (N bytes)"   (PRODUCT — dots)
@@ -163,8 +162,7 @@ static String redactTypeDescriptors(String line) {
    * klass: 'redacted/Redacted'</code>
    */
   static String redactKlassReference(String line) {
-    return replaceAll(
-        KLASS_REF, line, m -> m.group(1) + redactJvmClassName(m.group(2)) + "'");
+    return replaceAll(KLASS_REF, line, m -> m.group(1) + redactJvmClassName(m.group(2)) + "'");
   }
 
   /**
@@ -190,8 +188,7 @@ static String redactLibraryPath(String line) {
    * 'com/company/Class'</code> to <code>a 'redacted/Redacted'</code>.
    */
   static String redactObjFieldRef(String line) {
-    return replaceAll(
-        OBJ_FIELD_REF, line, m -> m.group(1) + redactJvmClassName(m.group(2)) + "'");
+    return replaceAll(OBJ_FIELD_REF, line, m -> m.group(1) + redactJvmClassName(m.group(2)) + "'");
   }
 
   /**
diff --git a/dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/ConfigManagerTest.java b/dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/ConfigManagerTest.java
@@ -24,6 +24,7 @@ public void testConfigWriteAndRead() throws IOException {
         .thenReturn(new WellKnownTags("1234", "", "env", "service", "version", ""));
     when(config.isCrashTrackingAgentless()).thenReturn(false);
     when(config.isCrashTrackingErrorsIntakeEnabled()).thenReturn(true);
+    when(config.isCrashTrackingExperimentalRegisterMappingEnabled()).thenReturn(true);
     when(config.getMergedCrashTrackingTags()).thenReturn(Collections.singletonMap("key", "value"));
     File tmpFile = File.createTempFile("ConfigManagerTest", null);
     tmpFile.deleteOnExit();
@@ -41,6 +42,7 @@ public void testConfigWriteAndRead() throws IOException {
         deserialized.processTags);
     assertFalse(deserialized.agentless);
     assertTrue(deserialized.sendToErrorTracking);
+    assertTrue(deserialized.registerMappingEnabled);
   }
 
   @Test
@@ -56,5 +58,6 @@ public void testStoredConfigDefaults() {
     assertEquals("env", storedConfig.env);
     assertFalse(storedConfig.agentless);
     assertFalse(storedConfig.sendToErrorTracking);
+    assertFalse(storedConfig.registerMappingEnabled);
   }
 }
diff --git a/dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/CrashUploaderTest.java b/dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/CrashUploaderTest.java
@@ -401,6 +401,7 @@ public void testErrorTrackingSerializesRegisterToMemoryMapping() throws Exceptio
             .processTags("a:b")
             .runtimeId("1234")
             .tags(ConfigManager.getMergedTagsForSerialization(Config.get()))
+            .registerMappingEnabled(true)
             .build();
 
     uploader = new CrashUploader(config, crashConfig);
@@ -418,6 +419,28 @@ public void testErrorTrackingSerializesRegisterToMemoryMapping() throws Exceptio
     assertThat(mapping.get("RDI").asText()).isEqualTo("0x0 is NULL");
   }
 
+  @Test
+  public void testErrorTrackingOmitsRegisterToMemoryMappingByDefault() throws Exception {
+    // registerMappingEnabled defaults to false — the mapping must not appear in the payload
+    ConfigManager.StoredConfig crashConfig =
+        new ConfigManager.StoredConfig.Builder(config)
+            .reportUUID(SAMPLE_UUID)
+            .processTags("a:b")
+            .runtimeId("1234")
+            .tags(ConfigManager.getMergedTagsForSerialization(Config.get()))
+            .build();
+
+    uploader = new CrashUploader(config, crashConfig);
+    server.enqueue(new MockResponse().setResponseCode(200));
+    uploader.remoteUpload(readFileAsString("sample-crash.txt"), false, true);
+
+    final RecordedRequest recordedRequest = server.takeRequest(5, TimeUnit.SECONDS);
+    final ObjectMapper mapper = new ObjectMapper();
+    final JsonNode event = mapper.readTree(recordedRequest.getBody().readUtf8());
+
+    assertThat(event.at("/experimental/register_to_memory_mapping").isMissingNode()).isTrue();
+  }
+
   private void assertCommonHeader(JsonNode event) {
     assertEquals(TELEMETRY_API_VERSION, event.get("api_version").asText());
     assertEquals("logs", event.get("request_type").asText());
diff --git a/dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/parsers/HotspotCrashLogParserTest.java b/dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/parsers/HotspotCrashLogParserTest.java
@@ -7,6 +7,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import datadog.crashtracking.CrashUploaderSettings;
 import datadog.crashtracking.dto.CrashLog;
 import java.io.BufferedReader;
 import java.io.IOException;
@@ -304,6 +305,31 @@ public void testParseCurrentThreadName(String line, String expected) {
         HotspotCrashLogParser.parseCurrentThreadName(line));
   }
 
+  @Test
+  public void testRegisterToMemoryMappingExcludedWhenDisabled() throws Exception {
+    CrashLog crashLog =
+        new HotspotCrashLogParser(new CrashUploaderSettings(false))
+            .parse(UUID.randomUUID().toString(), readFileAsString("sample-crash.txt"));
+
+    assertNotNull(crashLog.experimental, "registers and runtimeArgs should still be populated");
+    assertThat(crashLog.experimental.registerToMemoryMapping)
+        .as("registerToMemoryMapping should be absent when disabled")
+        .isNull();
+  }
+
+  @Test
+  public void testRegisterToMemoryMappingIncludedWhenEnabled() throws Exception {
+    CrashLog crashLog =
+        new HotspotCrashLogParser(new CrashUploaderSettings(true))
+            .parse(UUID.randomUUID().toString(), readFileAsString("sample-crash.txt"));
+
+    assertNotNull(crashLog.experimental);
+    assertNotNull(crashLog.experimental.registerToMemoryMapping);
+    assertFalse(
+        crashLog.experimental.registerToMemoryMapping.isEmpty(),
+        "registerToMemoryMapping should be populated when enabled");
+  }
+
   private String readFileAsString(String resource) throws IOException {
     try (InputStream stream = getClass().getClassLoader().getResourceAsStream(resource)) {
       return new BufferedReader(
diff --git a/dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/parsers/RedactUtilsTest.java b/dd-java-agent/agent-crashtracking/src/test/java/datadog/crashtracking/parsers/RedactUtilsTest.java
diff --git a/dd-trace-api/src/main/java/datadog/trace/api/config/CrashTrackingConfig.java b/dd-trace-api/src/main/java/datadog/trace/api/config/CrashTrackingConfig.java
diff --git a/internal-api/src/main/java/datadog/trace/api/Config.java b/internal-api/src/main/java/datadog/trace/api/Config.java
diff --git a/metadata/supported-configurations.json b/metadata/supported-configurations.json
