Skip to content

Commit 0ac4316

Browse files
jbachorikclaude
jbachorik
and
claude
committed
Enable live heap profiling by default on safe JVM versions
Adds unified config key `profiling.liveheap.enabled` that auto-detects safe systems (isJmethodIDSafe || isOldObjectSampleAvailable) and enables live heap profiling by default. Ddprof native library is preferred with JFR OldObjectSample as fallback. New `profiling.liveheap.jfr.enabled` replaces deprecated `profiling.heap.enabled` with context-aware deprecation warnings. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent bfa5ff5 commit 0ac4316

File tree

9 files changed

+215
-38
lines changed

9 files changed

+215
-38
lines changed

‎dd-java-agent/agent-profiling/profiling-controller-openjdk/src/main/java/com/datadog/profiling/controller/openjdk/OpenJdkController.java‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -192,10 +192,26 @@ public OpenJdkController(final ConfigProvider configProvider)
192192

193193
// Toggle settings from config
194194

195-
if (configProvider.getBoolean(
196-
ProfilingConfig.PROFILING_HEAP_ENABLED, ProfilingConfig.PROFILING_HEAP_ENABLED_DEFAULT)) {
197-
log.debug("Enabling OldObjectSample JFR event with the config.");
198-
recordingSettings.put("jdk.OldObjectSample#enabled", "true");
195+
// Unified live heap (profiling.heap.enabled): when explicitly disabled, turn off
196+
// OldObjectSample. When enabled (or default), if ddprof is likely handling live heap,
197+
// proactively disable OldObjectSample to avoid double collection.
198+
// disableOverriddenEvents() at recording start is the definitive safety net,
199+
// but we disable here too so the settings map is consistent from the start.
200+
if (!configProvider.getBoolean(
201+
ProfilingConfig.PROFILING_HEAP_ENABLED, isLiveHeapProfilingSafe())) {
202+
disableEvent(recordingSettings, "jdk.OldObjectSample", "live heap profiling is disabled");
203+
} else {
204+
boolean ddprofLikelyActive =
205+
configProvider.getBoolean(
206+
ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_ENABLED, true)
207+
&& configProvider.getBoolean(
208+
ProfilingConfig.PROFILING_DATADOG_PROFILER_ENABLED, true);
209+
if (ddprofLikelyActive) {
210+
disableEvent(
211+
recordingSettings,
212+
"jdk.OldObjectSample",
213+
"ddprof live heap profiling is expected to handle live heap data");
214+
}
199215
}
200216

201217
if (configProvider.getBoolean(
@@ -240,9 +256,8 @@ ProfilingConfig.PROFILING_ALLOCATION_ENABLED, isObjectAllocationSampleAvailable(
240256

241257
// Warn users for expensive events
242258

243-
if (!isOldObjectSampleAvailable()
244-
&& isEventEnabled(recordingSettings, "jdk.OldObjectSample#enabled")) {
245-
log.warn("Inexpensive heap profiling is not supported for this JDK but is enabled.");
259+
if (!isOldObjectSampleAvailable() && isEventEnabled(recordingSettings, "jdk.OldObjectSample")) {
260+
log.warn("JFR based live heap profiling is not supported for this JDK but is enabled.");
246261
}
247262

248263
if (isEventEnabled(recordingSettings, "jdk.ObjectAllocationInNewTLAB")

‎dd-java-agent/agent-profiling/profiling-controller-openjdk/src/test/java/com/datadog/profiling/controller/openjdk/OpenJdkControllerTest.java‎

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@
1616

1717
import com.datadog.profiling.controller.ControllerContext;
1818
import com.datadog.profiling.controller.jfr.JfpUtilsTest;
19+
import com.datadog.profiling.utils.ProfilingMode;
1920
import datadog.environment.JavaVirtualMachine;
2021
import datadog.trace.api.profiling.RecordingData;
2122
import datadog.trace.bootstrap.config.provider.ConfigProvider;
23+
import java.util.EnumSet;
2224
import java.util.Properties;
2325
import jdk.jfr.Recording;
2426
import org.junit.jupiter.api.BeforeAll;
@@ -94,6 +96,8 @@ public void testHeapProfilerIsStillOverriddenOnUnsupportedVersion() throws Excep
9496
public void testHeapProfilerIsStillOverriddenThroughConfig() throws Exception {
9597
Properties props = getConfigProperties();
9698
props.put(PROFILING_HEAP_ENABLED, "true");
99+
// Disable ddprof so OldObjectSample is not proactively disabled
100+
props.put(PROFILING_DATADOG_PROFILER_ENABLED, "false");
97101

98102
ConfigProvider configProvider = ConfigProvider.withPropertiesOverride(props);
99103

@@ -102,10 +106,8 @@ public void testHeapProfilerIsStillOverriddenThroughConfig() throws Exception {
102106
((OpenJdkRecordingData)
103107
controller.createRecording(TEST_NAME, new ControllerContext().snapshot()).stop())
104108
.getRecording()) {
105-
if (!isOldObjectSampleAvailable()) {
106-
assertEquals(
107-
true, Boolean.parseBoolean(recording.getSettings().get("jdk.OldObjectSample#enabled")));
108-
}
109+
assertEquals(
110+
true, Boolean.parseBoolean(recording.getSettings().get("jdk.OldObjectSample#enabled")));
109111
}
110112
}
111113

@@ -234,6 +236,43 @@ public void testNativeProfilerIsStillOverriddenOnUnsupportedVersion() throws Exc
234236
}
235237
}
236238

239+
@Test
240+
public void testOldObjectSampleDisabledWhenDdprofMemleakActive() throws Exception {
241+
Properties props = getConfigProperties();
242+
props.put(PROFILING_DATADOG_PROFILER_ENABLED, "true");
243+
244+
ConfigProvider configProvider = ConfigProvider.withPropertiesOverride(props);
245+
246+
ControllerContext context = new ControllerContext();
247+
context.setDatadogProfilerEnabled(true);
248+
context.setDatadogProfilingModes(EnumSet.of(ProfilingMode.MEMLEAK));
249+
250+
OpenJdkController controller = new OpenJdkController(configProvider);
251+
try (final Recording recording =
252+
((OpenJdkRecordingData) controller.createRecording(TEST_NAME, context.snapshot()).stop())
253+
.getRecording()) {
254+
assertFalse(Boolean.parseBoolean(recording.getSettings().get("jdk.OldObjectSample#enabled")));
255+
}
256+
}
257+
258+
@Test
259+
public void testUnifiedFlagDisabledTurnsOffOldObjectSample() throws Exception {
260+
Properties props = getConfigProperties();
261+
props.put(PROFILING_HEAP_ENABLED, "false");
262+
263+
ConfigProvider configProvider = ConfigProvider.withPropertiesOverride(props);
264+
265+
OpenJdkController controller = new OpenJdkController(configProvider);
266+
RecordingData data =
267+
controller.createRecording(TEST_NAME, new ControllerContext().snapshot()).stop();
268+
assertTrue(data instanceof OpenJdkRecordingData);
269+
try (final Recording recording = ((OpenJdkRecordingData) data).getRecording()) {
270+
assertFalse(
271+
Boolean.parseBoolean(recording.getSettings().get("jdk.OldObjectSample#enabled")),
272+
"OldObjectSample should be disabled when unified live heap flag is false");
273+
}
274+
}
275+
237276
private static Properties getConfigProperties() {
238277
Properties props = new Properties();
239278
// make sure the async profiler is not force-enabled

‎dd-java-agent/agent-profiling/profiling-controller/src/main/java/com/datadog/profiling/controller/ProfilerFlareReporter.java‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,12 +157,19 @@ private String getProfilerConfig() {
157157
ProfilingConfig.PROFILING_DIRECT_ALLOCATION_SAMPLE_LIMIT_DEFAULT);
158158

159159
sb.append("\n=== Heap Profiling ===\n");
160+
boolean heapDefault = ProfilingSupport.isLiveHeapProfilingSafe();
160161
appendConfig(
161162
sb,
162163
"Heap Profiling Enabled",
163-
configProvider.getBoolean(
164-
ProfilingConfig.PROFILING_HEAP_ENABLED, ProfilingConfig.PROFILING_HEAP_ENABLED_DEFAULT),
165-
ProfilingConfig.PROFILING_HEAP_ENABLED_DEFAULT);
164+
configProvider.getBoolean(ProfilingConfig.PROFILING_HEAP_ENABLED, heapDefault),
165+
heapDefault);
166+
appendConfig(
167+
sb,
168+
"DDProf Live Heap Enabled",
169+
configProvider.getString(ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_ENABLED),
170+
null);
171+
appendConfig(
172+
sb, "JFR OldObjectSample Available", ProfilingSupport.isOldObjectSampleAvailable(), false);
166173
appendConfig(
167174
sb,
168175
"Heap Histogram Enabled",

‎dd-java-agent/agent-profiling/profiling-controller/src/main/java/com/datadog/profiling/controller/ProfilerSettingsSupport.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ protected ProfilerSettingsSupport(
140140
ProfilingSupport.isObjectAllocationSampleAvailable());
141141
heapProfilingEnabled =
142142
configProvider.getBoolean(
143-
ProfilingConfig.PROFILING_HEAP_ENABLED, ProfilingConfig.PROFILING_HEAP_ENABLED_DEFAULT);
143+
ProfilingConfig.PROFILING_HEAP_ENABLED, ProfilingSupport.isLiveHeapProfilingSafe());
144144
startForceFirst =
145145
configProvider.getBoolean(
146146
ProfilingConfig.PROFILING_START_FORCE_FIRST,

‎dd-java-agent/agent-profiling/profiling-controller/src/main/java/com/datadog/profiling/controller/ProfilingSupport.java‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,41 @@
44
import static datadog.environment.JavaVirtualMachine.isJavaVersionAtLeast;
55
import static datadog.environment.JavaVirtualMachine.isOracleJDK8;
66

7+
import datadog.environment.JavaVirtualMachine;
8+
79
public class ProfilingSupport {
810

11+
/**
12+
* Checks whether jmethodID handling is safe on the current JVM version. Unsafe versions can cause
13+
* crashes due to <a href="https://bugs.openjdk.org/browse/JDK-8313816">JDK-8313816</a>.
14+
*/
15+
public static boolean isJmethodIDSafe() {
16+
if (isJavaVersionAtLeast(22)) {
17+
return true;
18+
}
19+
switch (JavaVirtualMachine.getLangVersion()) {
20+
case "8":
21+
return true;
22+
case "11":
23+
return isJavaVersionAtLeast(11, 0, 23);
24+
case "17":
25+
return isJavaVersionAtLeast(17, 0, 11);
26+
case "21":
27+
return isJavaVersionAtLeast(21, 0, 3);
28+
default:
29+
return false;
30+
}
31+
}
32+
33+
/**
34+
* Checks whether any live heap profiling mechanism is safe to enable on the current platform.
35+
* Returns true if at least one of ddprof native (jmethodID safe) or JFR OldObjectSample is
36+
* available.
37+
*/
38+
public static boolean isLiveHeapProfilingSafe() {
39+
return isJmethodIDSafe() || isOldObjectSampleAvailable();
40+
}
41+
942
public static boolean isOldObjectSampleAvailable() {
1043
if (isOracleJDK8()) {
1144
return false;

‎dd-java-agent/agent-profiling/profiling-ddprof/src/main/java/com/datadog/profiling/ddprof/DatadogProfilerConfig.java‎

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package com.datadog.profiling.ddprof;
22

3+
import static com.datadog.profiling.controller.ProfilingSupport.isOldObjectSampleAvailable;
34
import static datadog.environment.JavaVirtualMachine.isJ9;
45
import static datadog.trace.api.config.ProfilingConfig.PROFILING_ALLOCATION_ENABLED;
56
import static datadog.trace.api.config.ProfilingConfig.PROFILING_CONTEXT_ATTRIBUTES;
@@ -20,7 +21,6 @@
2021
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_CAPACITY;
2122
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_CAPACITY_DEFAULT;
2223
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_ENABLED;
23-
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_ENABLED_DEFAULT;
2424
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_INTERVAL;
2525
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_SAMPLE_PERCENT;
2626
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_SAMPLE_PERCENT_DEFAULT;
@@ -43,6 +43,7 @@
4343
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_WALL_ENABLED;
4444
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_WALL_INTERVAL;
4545
import static datadog.trace.api.config.ProfilingConfig.PROFILING_DATADOG_PROFILER_WALL_INTERVAL_DEFAULT;
46+
import static datadog.trace.api.config.ProfilingConfig.PROFILING_HEAP_ENABLED;
4647
import static datadog.trace.api.config.ProfilingConfig.PROFILING_HEAP_TRACK_GENERATIONS;
4748
import static datadog.trace.api.config.ProfilingConfig.PROFILING_HEAP_TRACK_GENERATIONS_DEFAULT;
4849
import static datadog.trace.api.config.ProfilingConfig.PROFILING_QUEUEING_TIME_ENABLED;
@@ -52,6 +53,7 @@
5253
import static datadog.trace.api.config.ProfilingConfig.PROFILING_ULTRA_MINIMAL;
5354
import static datadog.trace.api.config.TraceInstrumentationConfig.TRACE_ENABLED;
5455

56+
import com.datadog.profiling.controller.ProfilingSupport;
5557
import datadog.environment.JavaVirtualMachine;
5658
import datadog.trace.api.config.ProfilingConfig;
5759
import datadog.trace.bootstrap.config.provider.ConfigProvider;
@@ -165,26 +167,12 @@ public static boolean getWallContextFilter(ConfigProvider configProvider) {
165167
PROFILING_DATADOG_PROFILER_WALL_CONTEXT_FILTER_DEFAULT);
166168
}
167169

168-
private static boolean isJmethodIDSafe() {
169-
// see https://bugs.openjdk.org/browse/JDK-8313816
170-
if (JavaVirtualMachine.isJavaVersionAtLeast(22)) {
171-
// any version after 22 should be safe
172-
return true;
173-
}
174-
switch (JavaVirtualMachine.getLangVersion()) {
175-
case "8":
176-
// Java 8 is not affected by the jmethodID issue
177-
return true;
178-
case "11":
179-
return JavaVirtualMachine.isJavaVersionAtLeast(11, 0, 23);
180-
case "17":
181-
return JavaVirtualMachine.isJavaVersionAtLeast(17, 0, 11);
182-
case "21":
183-
return JavaVirtualMachine.isJavaVersionAtLeast(21, 0, 3);
184-
default:
185-
// any other non-LTS version should be considered unsafe
186-
return false;
187-
}
170+
static boolean isJmethodIDSafe() {
171+
return ProfilingSupport.isJmethodIDSafe();
172+
}
173+
174+
static boolean isMemoryLeakProfilingSafe() {
175+
return ProfilingSupport.isLiveHeapProfilingSafe();
188176
}
189177

190178
public static boolean isAllocationProfilingEnabled(ConfigProvider configProvider) {
@@ -223,16 +211,31 @@ public static int getAllocationInterval() {
223211
}
224212

225213
public static boolean isMemoryLeakProfilingEnabled(ConfigProvider configProvider) {
214+
boolean unifiedEnabled =
215+
configProvider.getBoolean(PROFILING_HEAP_ENABLED, isMemoryLeakProfilingSafe());
216+
if (!unifiedEnabled) {
217+
return false;
218+
}
219+
// JVMTI Allocation Sampler is required for ddprof live heap and is available since Java 11
220+
if (!JavaVirtualMachine.isJavaVersionAtLeast(11)) {
221+
return false;
222+
}
226223
boolean isSafe = isJmethodIDSafe();
227224
boolean enableDdprofMemleak =
228225
getBoolean(
229226
configProvider,
230227
PROFILING_DATADOG_PROFILER_LIVEHEAP_ENABLED,
231-
PROFILING_DATADOG_PROFILER_LIVEHEAP_ENABLED_DEFAULT,
228+
isSafe,
232229
PROFILING_DATADOG_PROFILER_MEMLEAK_ENABLED);
233230
if (!isSafe && enableDdprofMemleak) {
234231
log.warn(
235-
"Memory leak profiling was enabled although it is not considered stable on this JVM version.");
232+
"Live heap profiling (ddprof) was enabled although it is not considered stable"
233+
+ " on this JVM version.");
234+
}
235+
if (!enableDdprofMemleak && !isOldObjectSampleAvailable()) {
236+
log.warn(
237+
"ddprof live heap profiling is disabled and JFR OldObjectSample is not available"
238+
+ " on this JVM. Live heap profiling will be inactive.");
236239
}
237240
return enableDdprofMemleak;
238241
}

‎dd-java-agent/agent-profiling/profiling-ddprof/src/test/java/com/datadog/profiling/ddprof/DatadogProfilerConfigTest.java‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
package com.datadog.profiling.ddprof;
22

3+
import static com.datadog.profiling.controller.ProfilingSupport.isOldObjectSampleAvailable;
34
import static org.junit.jupiter.api.Assertions.assertEquals;
5+
import static org.junit.jupiter.api.Assertions.assertFalse;
6+
import static org.junit.jupiter.api.Assertions.assertTrue;
47

58
import datadog.trace.api.config.ProfilingConfig;
69
import datadog.trace.bootstrap.config.provider.ConfigProvider;
710
import java.util.Properties;
811
import java.util.stream.Stream;
912
import org.junit.jupiter.api.AfterEach;
1013
import org.junit.jupiter.api.BeforeEach;
14+
import org.junit.jupiter.api.Test;
1115
import org.junit.jupiter.params.ParameterizedTest;
1216
import org.junit.jupiter.params.provider.Arguments;
1317
import org.junit.jupiter.params.provider.MethodSource;
@@ -126,4 +130,70 @@ private static Stream<Arguments> hotspotStackwalkerTestCases() {
126130
Arguments.of("lbr", "lbr"),
127131
Arguments.of("no", "no"));
128132
}
133+
134+
@Test
135+
void isMemoryLeakProfilingSafeConsistentWithComponentChecks() {
136+
boolean expected = DatadogProfilerConfig.isJmethodIDSafe() || isOldObjectSampleAvailable();
137+
assertEquals(expected, DatadogProfilerConfig.isMemoryLeakProfilingSafe());
138+
}
139+
140+
@Test
141+
void unifiedFlagEnabledDdprofKeyDefaultReturnsJmethodIDSafe() {
142+
Properties props = new Properties();
143+
props.put(ProfilingConfig.PROFILING_HEAP_ENABLED, "true");
144+
ConfigProvider config = ConfigProvider.withPropertiesOverride(props);
145+
assertEquals(
146+
DatadogProfilerConfig.isJmethodIDSafe(),
147+
DatadogProfilerConfig.isMemoryLeakProfilingEnabled(config));
148+
}
149+
150+
@Test
151+
void unifiedFlagDisabledOverridesDdprof() {
152+
Properties props = new Properties();
153+
props.put(ProfilingConfig.PROFILING_HEAP_ENABLED, "false");
154+
props.put(ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_ENABLED, "true");
155+
ConfigProvider config = ConfigProvider.withPropertiesOverride(props);
156+
assertFalse(DatadogProfilerConfig.isMemoryLeakProfilingEnabled(config));
157+
}
158+
159+
@Test
160+
void unifiedFlagEnabledDdprofKeyDisabledReturnsFalse() {
161+
Properties props = new Properties();
162+
props.put(ProfilingConfig.PROFILING_HEAP_ENABLED, "true");
163+
props.put(ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_ENABLED, "false");
164+
ConfigProvider config = ConfigProvider.withPropertiesOverride(props);
165+
assertFalse(DatadogProfilerConfig.isMemoryLeakProfilingEnabled(config));
166+
}
167+
168+
@Test
169+
void unifiedFlagEnabledDdprofKeyEnabledReturnsTrue() {
170+
Properties props = new Properties();
171+
props.put(ProfilingConfig.PROFILING_HEAP_ENABLED, "true");
172+
props.put(ProfilingConfig.PROFILING_DATADOG_PROFILER_LIVEHEAP_ENABLED, "true");
173+
ConfigProvider config = ConfigProvider.withPropertiesOverride(props);
174+
assertTrue(DatadogProfilerConfig.isMemoryLeakProfilingEnabled(config));
175+
}
176+
177+
@Test
178+
void oldMemleakAliasStillWorks() {
179+
Properties props = new Properties();
180+
props.put(ProfilingConfig.PROFILING_HEAP_ENABLED, "true");
181+
props.put(ProfilingConfig.PROFILING_DATADOG_PROFILER_MEMLEAK_ENABLED, "true");
182+
ConfigProvider config = ConfigProvider.withPropertiesOverride(props);
183+
assertTrue(DatadogProfilerConfig.isMemoryLeakProfilingEnabled(config));
184+
}
185+
186+
@Test
187+
void defaultBehaviorNoFlagsSetUsesAutoDetection() {
188+
Properties props = new Properties();
189+
ConfigProvider config = ConfigProvider.withPropertiesOverride(props);
190+
// With no flags set:
191+
// unified default = isMemoryLeakProfilingSafe()
192+
// ddprof default = isJmethodIDSafe()
193+
// result = unified && ddprof = isMemoryLeakProfilingSafe() && isJmethodIDSafe()
194+
// = isJmethodIDSafe() (since isJmethodIDSafe() implies isMemoryLeakProfilingSafe())
195+
assertEquals(
196+
DatadogProfilerConfig.isJmethodIDSafe(),
197+
DatadogProfilerConfig.isMemoryLeakProfilingEnabled(config));
198+
}
129199
}

‎dd-smoke-tests/profiling-integration-tests/build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ dependencies {
2727
implementation 'org.xerial.snappy:snappy-java:1.1.8.4'
2828

2929
testImplementation project(':dd-smoke-tests')
30+
testImplementation project(':dd-java-agent:agent-profiling:profiling-controller')
3031
testImplementation project(':dd-java-agent:agent-profiling:profiling-testing')
3132
testImplementation libs.bundles.junit5
3233
testImplementation libs.bundles.mockito

0 commit comments

Comments
 (0)