Skip to content

Add JFR emergency dump documentation #13618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
roberttoyonaga wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add JFR emergency dump documentation #13618

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/reference-manual/native-image/JFR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,15 @@ JFR can be controlled using the Java Diagnostic Command utility (`jcmd`).
To enable this functionality, `jcmd` support must be configured at build time.
The following JFR commands are available with `jcmd`: `JFR.start`, `JFR.stop`, `JFR.check`, and `JFR.dump`.

### Emergency Dumps

JFR emergency dumping attempts to persist JFR data to a snapshot (.jfr) file in the event of unexpected VM shutdown.
In Native Image, an emergency dump will be attempted upon `OutOfMemoryError` if `-XX:+ReportFatalErrorOnOutOfMemoryError` is specified at runtime.
This means that a JFR emergency dump will only be attempted if the user does not intend to catch the `OutOfMemoryError` and instead requests that the VM fail fatally.
JFR emergency dumping is not yet supported on Windows.
The dump will be made to the current working directory unless `dumppath=<path>` is specified using `-XX:FlightRecorderOptions`.
The file name will be of the pattern: `svm_oom_pid_<PID>.jfr`.

### Built-In Events

Many of the VM-level built-in events are available in Native Image.
Expand Down