Skip to content

Commit

Permalink
8313710: jcmd: typo in the documentation of JFR.start and JFR.dump
Browse files Browse the repository at this point in the history 
Reviewed-by: dholmes, egahlin
  • Loading branch information
@kurashige23 @egahlin
kurashige23 authored and egahlin committed Feb 27, 2024
1 parent 60cbf29 commit 16d917a
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 113 deletions.
84 changes: 42 additions & 42 deletions src/jdk.jfr/share/classes/jdk/jfr/internal/dcmd/DCmdDump.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,59 +201,59 @@ public String[] printHelp() {
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.
Expand All @@ -265,7 +265,7 @@ public String[] printHelp() {
$ 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
Expand Down
142 changes: 71 additions & 71 deletions src/jdk.jfr/share/classes/jdk/jfr/internal/dcmd/DCmdStart.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,82 +319,82 @@ private boolean hasJDKEvents(Map<String, String> settings) {

@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)
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)
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)
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)
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)
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)
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)
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)
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)
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.
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))
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-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)
Event settings and .jfc options can also be specified using the following syntax:
Expand Down

1 comment on commit 16d917a

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

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

Review

Issues

Please sign in to comment.