add NMT option and doc

quarkusio · Oct 21, 2024 · cabbcdf · cabbcdf
1 parent 1b11ce1
commit cabbcdf
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/pkg/NativeConfig.java b/core/deployment/src/main/java/io/quarkus/deployment/pkg/NativeConfig.java
@@ -313,6 +313,7 @@ default String getEffectiveImage() {
      * <li><code>heapdump</code> for heampdump support</li>
      * <li><code>jmxclient</code> for JMX client support (experimental)</li>
      * <li><code>jmxserver</code> for JMX server support (experimental)</li>
+     * <li><code>nmt</code> for native memory tracking support</li>
      * <li><code>all</code> for all monitoring features</li>
      * </ul>
      */
@@ -550,6 +551,7 @@ enum MonitoringOption {
         JFR,
         JMXSERVER,
         JMXCLIENT,
+        NMT,
         ALL
     }
 

diff --git a/docs/src/main/asciidoc/building-native-image.adoc b/docs/src/main/asciidoc/building-native-image.adoc
@@ -896,7 +896,7 @@ For a more detailed guide about debugging native images please refer to the xref
 
 == Using Monitoring Options
 
-Monitoring options such as JDK flight recorder, jvmstat, heap dumps, and remote JMX (experimental in Mandrel 23)
+Monitoring options such as JDK flight recorder, jvmstat, heap dumps, NMT, and remote JMX (experimental in Mandrel 23)
 can be added to the native executable build. Simply supply a comma separated list of the monitoring options you wish to
 include at build time.
 [source,bash]
@@ -927,6 +927,10 @@ include at build time.
 |Adds support for accepting connections from JMX clients.
 |GraalVM for JDK 17/20 Mandrel 23.0 (17.0.7)
 
+|nmt
+|Adds support for native memory tracking.
+|GraalVM for JDK 23 Mandrel 24.1
+
 |all
 |Adds all monitoring options.
 |GraalVM 22.3, GraalVM CE 17.0.7 Mandrel 22.3 Mandrel 23.0 (17.0.7)

diff --git a/docs/src/main/asciidoc/native-reference.adoc b/docs/src/main/asciidoc/native-reference.adoc
@@ -2447,6 +2447,13 @@ The following table outlines Native Image JFR support and limitations by version
 * Event streaming
 |* No old object sampling
 
+|GraalVM CE for JDK 23 and Mandrel 24.1
+|* Everything from GraalVM CE for JDK 17/20 and Mandrel 23.0
+* Additional events
+* Always on allocation profiling (event throttling)
+* Partial support for old object sampling (no tracking paths to GC roots)
+* Support for `-XX:FlightRecorderOptions`
+| * Old object sampling is missing path to GC root support
 |===