Skip to content

Commit

Permalink
8335479: JFR: Missing documentation for -XX:StartFlightRecording
Browse files Browse the repository at this point in the history
Reviewed-by: mgronlun
Backport-of: 68ffec9
  • Loading branch information
egahlin committed Jul 5, 2024
1 parent 10b28ba commit 653c481
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/java.base/share/man/java.1
Original file line number Diff line number Diff line change
Expand Up @@ -1710,10 +1710,12 @@ This prevents the JVM from exiting and keeps the process active so that
you can attach a debugger to it to investigate the cause of the error.
By default, this option is disabled.
.TP
\f[V]-XX:StartFlightRecording=\f[R]\f[I]parameter\f[R]\f[V]=\f[R]\f[I]value\f[R]
\f[V]-XX:StartFlightRecording:\f[R]\f[I]parameter\f[R]\f[V]=\f[R]\f[I]value\f[R]
Starts a JFR recording for the Java application.
This option is equivalent to the \f[V]JFR.start\f[R] diagnostic command
that starts a recording during runtime.
\f[V]-XX:StartFlightRecording:help\f[R] prints available options and
example command lines.
You can set the following \f[I]parameter\f[R]\f[V]=\f[R]\f[I]value\f[R]
entries when starting a JFR recording:
.RS
Expand Down Expand Up @@ -1760,6 +1762,8 @@ written when the recording is stopped, for example:
.PP
If %p and/or %t is specified in the filename, it expands to the
JVM\[aq]s PID and the current timestamp, respectively.
The filename may also be a directory in which case, the filename is
generated from the PID and the current date in the specified directory.
.RE
.TP
\f[V]name=\f[R]\f[I]identifier\f[R]
Expand Down Expand Up @@ -1840,6 +1844,9 @@ The whitespace delimiter can be omitted for timespan values, i.e.
20ms.
For more information about the settings syntax, see Javadoc of the
jdk.jfr package.
.PP
To only see warnings and errors from JFR during startup set
-Xlog:jfr+startup=warning.
.RE
.TP
\f[V]-XX:ThreadStackSize=\f[R]\f[I]size\f[R]
Expand Down

1 comment on commit 653c481

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.