8313710: jcmd: typo in the documentation of JFR.start and JFR.dump
Reviewed-by: dholmes, egahlin
This commit is contained in:
Taizo Kurashige
Erik Gahlin
parent
60cbf29250
commit
16d917a85f
@ -201,59 +201,59 @@ final class DCmdDump extends AbstractDCmd {
|
||||
|
||||
Options:
|
||||
|
||||
begin (Optional) Specify the time from which recording data will be included
|
||||
in the dump file. The format is specified as local time.
|
||||
(STRING, no default value)
|
||||
begin (Optional) Specify the time from which recording data will be
|
||||
included in the dump file. The format is specified as local time.
|
||||
(STRING, no default value)
|
||||
|
||||
end (Optional) Specify the time to which recording data will be included
|
||||
in the dump file. The format is specified as local time.
|
||||
(STRING, no default value)
|
||||
end (Optional) Specify the time to which recording data will be included
|
||||
in the dump file. The format is specified as local time.
|
||||
(STRING, no default value)
|
||||
|
||||
Note: For both begin and end, the time must be in a format that can
|
||||
be read by any of these methods:
|
||||
Note: For both begin and end, the time must be in a format that can
|
||||
be read by any of these methods:
|
||||
|
||||
java.time.LocalTime::parse(String),
|
||||
java.time.LocalDateTime::parse(String)
|
||||
java.time.Instant::parse(String)
|
||||
java.time.LocalTime::parse(String),
|
||||
java.time.LocalDateTime::parse(String)
|
||||
java.time.Instant::parse(String)
|
||||
|
||||
For example, "13:20:15", "2020-03-17T09:00:00" or
|
||||
"2020-03-17T09:00:00Z".
|
||||
For example, "13:20:15", "2020-03-17T09:00:00" or
|
||||
"2020-03-17T09:00:00Z".
|
||||
|
||||
Note: begin and end times correspond to the timestamps found within
|
||||
the recorded information in the flight recording data.
|
||||
Note: begin and end times correspond to the timestamps found within
|
||||
the recorded information in the flight recording data.
|
||||
|
||||
Another option is to use a time relative to the current time that is
|
||||
specified by a negative integer followed by "s", "m" or "h".
|
||||
For example, "-12h", "-15m" or "-30s"
|
||||
Another option is to use a time relative to the current time that is
|
||||
specified by a negative integer followed by "s", "m" or "h".
|
||||
For example, "-12h", "-15m" or "-30s"
|
||||
|
||||
filename (Optional) Name of the file to which the flight recording data is
|
||||
dumped. If no filename is given, a filename is generated from the PID
|
||||
and the current date. 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. (STRING, no default value)
|
||||
filename (Optional) Name of the file to which the flight recording data is
|
||||
dumped. If no filename is given, a filename is generated from the PID
|
||||
and the current date. 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. (STRING, no default value)
|
||||
|
||||
Note: If a filename is given, '%%p' in the filename will be
|
||||
replaced by the PID, and '%%t' will be replaced by the time in
|
||||
'yyyy_MM_dd_HH_mm_ss' format.
|
||||
Note: If a filename is given, '%%p' in the filename will be
|
||||
replaced by the PID, and '%%t' will be replaced by the time in
|
||||
'yyyy_MM_dd_HH_mm_ss' format.
|
||||
|
||||
maxage (Optional) Length of time for dumping the flight recording data to a
|
||||
file. (INTEGER followed by 's' for seconds 'm' for minutes or 'h' for
|
||||
hours, no default value)
|
||||
maxage (Optional) Length of time for dumping the flight recording data to a
|
||||
file. (INTEGER followed by 's' for seconds 'm' for minutes or 'h' for
|
||||
hours, no default value)
|
||||
|
||||
maxsize (Optional) Maximum size for the amount of data to dump from a flight
|
||||
recording in bytes if one of the following suffixes is not used:
|
||||
'm' or 'M' for megabytes OR 'g' or 'G' for gigabytes.
|
||||
(STRING, no default value)
|
||||
maxsize (Optional) Maximum size for the amount of data to dump from a flight
|
||||
recording in bytes if one of the following suffixes is not used:
|
||||
'm' or 'M' for megabytes OR 'g' or 'G' for gigabytes.
|
||||
(STRING, no default value)
|
||||
|
||||
name (Optional) Name of the recording. If no name is given, data from all
|
||||
recordings is dumped. (STRING, no default value)
|
||||
name (Optional) Name of the recording. If no name is given, data from all
|
||||
recordings is dumped. (STRING, no default value)
|
||||
|
||||
path-to-gc-root (Optional) Flag for saving the path to garbage collection (GC) roots
|
||||
at the time the recording data is dumped. The path information is
|
||||
useful for finding memory leaks but collecting it can cause the
|
||||
application to pause for a short period of time. Turn on this flag
|
||||
only when you have an application that you suspect has a memory
|
||||
leak. (BOOLEAN, false)
|
||||
path-to-gc-roots (Optional) Flag for saving the path to garbage collection (GC) roots
|
||||
at the time the recording data is dumped. The path information is
|
||||
useful for finding memory leaks but collecting it can cause the
|
||||
application to pause for a short period of time. Turn on this flag
|
||||
only when you have an application that you suspect has a memory
|
||||
leak. (BOOLEAN, false)
|
||||
|
||||
Options must be specified using the <key> or <key>=<value> syntax.
|
||||
|
||||
@ -265,7 +265,7 @@ final class DCmdDump extends AbstractDCmd {
|
||||
$ jcmd <pid> JFR.dump name=1 filename=%s
|
||||
$ jcmd <pid> JFR.dump maxage=1h
|
||||
$ jcmd <pid> JFR.dump maxage=1h maxsize=50M
|
||||
$ jcmd <pid> JFR.dump fillename=leaks.jfr path-to-gc-root=true
|
||||
$ jcmd <pid> JFR.dump filename=leaks.jfr path-to-gc-roots=true
|
||||
$ jcmd <pid> JFR.dump begin=13:15
|
||||
$ jcmd <pid> JFR.dump begin=13:15 end=21:30:00
|
||||
$ jcmd <pid> JFR.dump end=18:00 maxage=10m
|
||||
|
||||
@ -319,82 +319,82 @@ final class DCmdStart extends AbstractDCmd {
|
||||
|
||||
@Override
|
||||
public String[] printHelp() {
|
||||
// 0123456789001234567890012345678900123456789001234567890012345678900123456789001234567890
|
||||
// 0123456789001234567890012345678900123456789001234567890012345678900123456789001234567890
|
||||
return """
|
||||
Syntax : JFR.start [options]
|
||||
|
||||
Options:
|
||||
|
||||
delay (Optional) Length of time to wait before starting to record
|
||||
(INTEGER followed by 's' for seconds 'm' for minutes or h' for
|
||||
hours, 0s)
|
||||
delay (Optional) Length of time to wait before starting to record
|
||||
(INTEGER followed by 's' for seconds 'm' for minutes or h' for
|
||||
hours, 0s)
|
||||
|
||||
disk (Optional) Flag for also writing the data to disk while recording
|
||||
(BOOLEAN, true)
|
||||
disk (Optional) Flag for also writing the data to disk while recording
|
||||
(BOOLEAN, true)
|
||||
|
||||
dumponexit (Optional) Flag for writing the recording to disk when the Java
|
||||
Virtual Machine (JVM) shuts down. If set to 'true' and no value
|
||||
is given for filename, the recording is written to a file in the
|
||||
directory where the process was started. The file name is a
|
||||
system-generated name that contains the process ID, the recording
|
||||
ID and the current time stamp. (For example:
|
||||
id-1-2021_09_14_09_00.jfr) (BOOLEAN, false)
|
||||
dumponexit (Optional) Flag for writing the recording to disk when the Java
|
||||
Virtual Machine (JVM) shuts down. If set to 'true' and no value
|
||||
is given for filename, the recording is written to a file in the
|
||||
directory where the process was started. The file name is a
|
||||
system-generated name that contains the process ID, the recording
|
||||
ID and the current time stamp. (For example:
|
||||
id-1-2021_09_14_09_00.jfr) (BOOLEAN, false)
|
||||
|
||||
duration (Optional) Length of time to record. Note that 0s means forever
|
||||
(INTEGER followed by 's' for seconds 'm' for minutes or 'h' for
|
||||
hours, 0s)
|
||||
duration (Optional) Length of time to record. Note that 0s means forever
|
||||
(INTEGER followed by 's' for seconds 'm' for minutes or 'h' for
|
||||
hours, 0s)
|
||||
|
||||
filename (Optional) Name of the file to which the flight recording data is
|
||||
written when the recording is stopped. If no filename is given, a
|
||||
filename is generated from the PID and the current date and is
|
||||
placed in the directory where the process was started. 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. (STRING, no default value)
|
||||
filename (Optional) Name of the file to which the flight recording data is
|
||||
written when the recording is stopped. If no filename is given, a
|
||||
filename is generated from the PID and the current date and is
|
||||
placed in the directory where the process was started. 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. (STRING, no default value)
|
||||
|
||||
Note: If a filename is given, '%%p' in the filename will be
|
||||
replaced by the PID, and '%%t' will be replaced by the time in
|
||||
'yyyy_MM_dd_HH_mm_ss' format.
|
||||
Note: If a filename is given, '%%p' in the filename will be
|
||||
replaced by the PID, and '%%t' will be replaced by the time in
|
||||
'yyyy_MM_dd_HH_mm_ss' format.
|
||||
|
||||
maxage (Optional) Maximum time to keep the recorded data on disk. This
|
||||
parameter is valid only when the disk parameter is set to true.
|
||||
Note 0s means forever. (INTEGER followed by 's' for seconds 'm'
|
||||
for minutes or 'h' for hours, 0s)
|
||||
maxage (Optional) Maximum time to keep the recorded data on disk. This
|
||||
parameter is valid only when the disk parameter is set to true.
|
||||
Note 0s means forever. (INTEGER followed by 's' for seconds 'm'
|
||||
for minutes or 'h' for hours, 0s)
|
||||
|
||||
maxsize (Optional) Maximum size of the data to keep on disk in bytes if
|
||||
one of the following suffixes is not used: 'm' or 'M' for
|
||||
megabytes OR 'g' or 'G' for gigabytes. This parameter is valid
|
||||
only when the disk parameter is set to 'true'. The value must not
|
||||
be less than the value for the maxchunksize parameter set with
|
||||
the JFR.configure command. (STRING, 0 (no max size))
|
||||
maxsize (Optional) Maximum size of the data to keep on disk in bytes if
|
||||
one of the following suffixes is not used: 'm' or 'M' for
|
||||
megabytes OR 'g' or 'G' for gigabytes. This parameter is valid
|
||||
only when the disk parameter is set to 'true'. The value must not
|
||||
be less than the value for the maxchunksize parameter set with
|
||||
the JFR.configure command. (STRING, 0 (no max size))
|
||||
|
||||
name (Optional) Name of the recording. If no name is provided, a name
|
||||
is generated. Make note of the generated name that is shown in
|
||||
the response to the command so that you can use it with other
|
||||
commands. (STRING, system-generated default name)
|
||||
name (Optional) Name of the recording. If no name is provided, a name
|
||||
is generated. Make note of the generated name that is shown in
|
||||
the response to the command so that you can use it with other
|
||||
commands. (STRING, system-generated default name)
|
||||
|
||||
path-to-gc-root (Optional) Flag for saving the path to garbage collection (GC)
|
||||
roots at the end of a recording. The path information is useful
|
||||
for finding memory leaks but collecting it is time consuming.
|
||||
Turn on this flag only when you have an application that you
|
||||
suspect has a memory leak. If the settings parameter is set to
|
||||
'profile', then the information collected includes the stack
|
||||
trace from where the potential leaking object was allocated.
|
||||
(BOOLEAN, false)
|
||||
path-to-gc-roots (Optional) Flag for saving the path to garbage collection (GC)
|
||||
roots at the end of a recording. The path information is useful
|
||||
for finding memory leaks but collecting it is time consuming.
|
||||
Turn on this flag only when you have an application that you
|
||||
suspect has a memory leak. If the settings parameter is set to
|
||||
'profile', then the information collected includes the stack
|
||||
trace from where the potential leaking object was allocated.
|
||||
(BOOLEAN, false)
|
||||
|
||||
settings (Optional) Name of the settings file that identifies which events
|
||||
to record. To specify more than one file, use the settings
|
||||
parameter repeatedly. Include the path if the file is not in
|
||||
JAVA-HOME/lib/jfr. The following profiles are included with the
|
||||
JDK in the JAVA-HOME/lib/jfr directory: 'default.jfc': collects a
|
||||
predefined set of information with low overhead, so it has minimal
|
||||
impact on performance and can be used with recordings that run
|
||||
continuously; 'profile.jfc': Provides more data than the
|
||||
'default.jfc' profile, but with more overhead and impact on
|
||||
performance. Use this configuration for short periods of time
|
||||
when more information is needed. Use none to start a recording
|
||||
without a predefined configuration file. (STRING,
|
||||
JAVA-HOME/lib/jfr/default.jfc)
|
||||
settings (Optional) Name of the settings file that identifies which events
|
||||
to record. To specify more than one file, use the settings
|
||||
parameter repeatedly. Include the path if the file is not in
|
||||
JAVA-HOME/lib/jfr. The following profiles are included with the
|
||||
JDK in the JAVA-HOME/lib/jfr directory: 'default.jfc': collects a
|
||||
predefined set of information with low overhead, so it has minimal
|
||||
impact on performance and can be used with recordings that run
|
||||
continuously; 'profile.jfc': Provides more data than the
|
||||
'default.jfc' profile, but with more overhead and impact on
|
||||
performance. Use this configuration for short periods of time
|
||||
when more information is needed. Use none to start a recording
|
||||
without a predefined configuration file. (STRING,
|
||||
JAVA-HOME/lib/jfr/default.jfc)
|
||||
|
||||
Event settings and .jfc options can also be specified using the following syntax:
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user