Skip to content

Commit

Permalink
add help descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
roberttoyonaga committed Oct 12, 2023
1 parent 47f0f8d commit 4163a38
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -905,7 +905,7 @@ public Boolean getValue(OptionValues values) {
@Option(help = "file:doc-files/FlightRecorderLoggingHelp.txt")//
public static final RuntimeOptionKey<String> FlightRecorderLogging = new RuntimeOptionKey<>("all=warning", Immutable);

@Option(help = "Use additional flight recorder options.")//
@Option(help = "file:doc-files/FlightRecorderOptionsHelp.txt")//
public static final RuntimeOptionKey<String> FlightRecorderOptions = new RuntimeOptionKey<>("", Immutable);

public static String reportsPath() {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Usage: -XX:FlightRecorderOptions=[option[=value][,...]]

This option expects a comma separated list of key-value pairs. None of the options are mandatory. Possible option keys are as follows:

globalbuffercount (Optional) Number of global buffers. This option is a legacy
option: change the memorysize parameter to alter the number of
global buffers. This value cannot be changed once JFR has been"
initialized. (LONG, default determined by the value for
memorysize)

globalbuffersize (Optional) Size of the global buffers, in bytes. This option is a
legacy option: change the memorysize parameter to alter the size
of the global buffers. This value cannot be changed once JFR has
been initialized. (STRING, default determined by the value for
memorysize)

maxchunksize (Optional) Maximum size of an individual data chunk in bytes if
one of the following suffixes is not used: 'm' or 'M' for
megabytes OR 'g' or 'G' for gigabytes. This value cannot be
changed once JFR has been initialized. (STRING, 12M)

memorysize (Optional) Overall memory size, in bytes if one of the following
suffixes is not used: 'm' or 'M' for megabytes OR 'g' or 'G' for
gigabytes. This value cannot be changed once JFR has been
initialized. (STRING, 10M)

repositorypath (Optional) Path to the location where recordings are stored until
they are written to a permanent file. (STRING, The default
location is the temporary directory for the operating system. On
Linux operating systems, the temporary directory is /tmp. On
Windows, the temporary directory is specified by the TMP
environment variable)

stackdepth (Optional) Stack depth for stack traces. Setting this value
greater than the default of 64 may cause a performance
degradation. This value cannot be changed once JFR has been
initialized. (LONG, 64)

thread_buffer_size (Optional) Local buffer size for each thread in bytes if one of
the following suffixes is not used: 'k' or 'K' for kilobytes or
'm' or 'M' for megabytes. Overriding this parameter could reduce
performance and is not recommended. This value cannot be changed
once JFR has been initialized. (STRING, 8k)

preserve-repository (Optional) Preserve files stored in the disk repository after the
Java Virtual Machine has exited. (BOOLEAN, false)
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ private enum FlightRecorderOptionsArgument implements JfrArgument {
RepositoryPath("repositorypath"),
StackDepth("stackdepth"),
ThreadBufferSize("thread_buffer_size"),
PreserveRepository("preserveRepository");
PreserveRepository("preserve-repository");

private final String cmdLineKey;

Expand Down

0 comments on commit 4163a38

Please sign in to comment.