Add documentation for jcmd support
#9987
Conversation
oracle-contributor-agreement
bot
added
the
OCA Verified
roberttoyonaga
changed the title
jcmd supportjcmd support
|
Hello @roberttoyonaga! Yes, gladly! |
|
@roberttoyonaga, I left some rewording and cosmetic suggestions. Thank you for always finding time to contribute some documentation for a new feature! |
| ```shell | ||
| native-image --enable-monitoring=jcmd YourApplication | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Please briefly mention jvmstat as well (without jvmstat support, jcmd won't list the native image process if jcmd is executed without any arguments).
There was a problem hiding this comment.
Good idea! I've added a note about jvmstat
|
|
||
| | Name | Included with `--enable-monitoring=` | Description | | ||
| |----------------------|--------------------------------------|----------------------------------------------------------------------------------------------------| | ||
| | GC.heap_dump | heapdump | Generate a HPROF format dump of the Java heap. | |
There was a problem hiding this comment.
Compiler.dump_code_cache is missing here (only available with Truffle).
|
|
||
| ## Performance | ||
|
|
||
| The adding `jcmd` support will have minimal impact on Native Image performance while idle. However, the performance impact of the `jcmd` feature greatly depends on which diagnostic commands are invoked and their frequency. For example, invoking multiple garbage collections will have a much greater impact than dumping a single native memory tracking report. |
There was a problem hiding this comment.
Please mention that jcmd help <cmd> prints the impact of a command.
|
Thank you @olyagpl and @christianhaeubl for the reviews! I've applied your feedback suggestions. |
| ``` | ||
|
|
||
| ```shell | ||
| jcmd -l |
There was a problem hiding this comment.
We only explain below how to get the PID and start jcmd.
There was a problem hiding this comment.
oh yes, I'll fix that
|
@roberttoyonaga, could you please also squash the commits? Your PR should be in a good shape then. |
Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> add jvmstat note, add link to jfr, add dump_code_cache Update docs/reference-manual/native-image/DebuggingAndDiagnostics.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> Update docs/reference-manual/native-image/JCmd.md Co-authored-by: Olga Gupalo <[email protected]> more fixes
roberttoyonaga
force-pushed
the
jcmd-docs
branch
from
25fba85
to
6fcf8dd
Compare
|
Thank you for the review @olyagpl. I've squashed the commits as well. |
Summary
This PR adds some documentation for the new
jcmdsupport. This PR should not be merged until after #9963 is integrated.