Skip to content

Commit f5dbdf3

Browse files
committed
Fix documentation
1 parent 798ee0b commit f5dbdf3

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -304,24 +304,23 @@ USAGE:
304304
asprof-status (recent SapMachine only)
305305
Get the status of async-profiler on a running Java application
306306

307-
status (requires Java 17+ locally, supports --args)
307+
status (requires Java 17+ locally, supports --args, --full)
308308
Quick status check of the remote JVM: deadlock detection, hot threads,
309-
dependency graph, and more. Requires Java 17+ locally. Pass additional
310-
options via --args (e.g., '--dumps 3', '--full'). See
311-
https://github.com/parttimenerd/jstall
309+
dependency graph, and more. Requires Java 17+ locally. Use --full for
310+
comprehensive analysis. Pass additional options via --args (e.g.,
311+
'--dumps 3'). See https://github.com/parttimenerd/jstall
312312

313313
jstall (requires Java 17+ locally, supports --args)
314314
Inspect the remote JVM via JStall (runs on your machine, connects via cf
315315
ssh). Requires Java 17+ locally. Pass jstall subcommands and options via
316316
--args (default: 'status all'). See
317317
https://github.com/parttimenerd/jstall
318318

319-
record-status (requires Java 17+ locally, supports --args)
319+
record-status (requires Java 17+ locally, supports --args, --full)
320320
Record diagnostic data from the remote JVM via JStall and save to a
321321
local zip file. Requires Java 17+ locally. Output file can be specified
322-
as a trailing argument (default: APP_NAME-status.zip). Use --args to
323-
pass additional jstall record options like '--full'. See
324-
https://github.com/parttimenerd/jstall
322+
as a trailing argument (default: APP_NAME-status.zip). Use --full for
323+
comprehensive recording. See https://github.com/parttimenerd/jstall
325324

326325
OPTIONS:
327326
--app-instance-index -i [index], select to which instance of the app to connect
@@ -334,6 +333,8 @@ OPTIONS:
334333
--container-dir -cd, the directory path in the container that the heap dump/JFR/... file will be
335334
saved to
336335
--dry-run -n, just output to command line what would be executed
336+
--full -f, enable full mode for more comprehensive JVM analysis (only for status and
337+
record-status)
337338
--keep -k, keep the heap dump in the container; by default the heap dump/JFR/... will
338339
be deleted from the container's filesystem after being downloaded
339340
--local-dir -ld, the local directory path that the dump/JFR/... file will be saved to,

0 commit comments

Comments
 (0)