Skip to content

Commit 61f5410

Browse files
committed
Rename commands, closes SAP#35
1 parent a2c61bd commit 61f5410

File tree

3 files changed

+209
-92
lines changed

3 files changed

+209
-92
lines changed

README.md

Lines changed: 60 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,22 @@ Trigger installation of the plugin via
2020
cf install-plugin -r CF-Community "java"
2121
```
2222

23+
The releases in the community repository might be older that the actual releases on GitHub, that you
24+
can install manually.
25+
2326
### Manual Installation
24-
Download the binary file for your target OS from the [latest release](https://github.com/SAP/cf-cli-java-plugin/releases/latest).
27+
Download the latest release from [GitHub](https://github.com/SAP/cf-cli-java-plugin/releases/latest).
2528

26-
If you've already installed the plugin and are updating it, you must first execute the `cf uninstall-plugin java` command.
29+
To install a new version of the plugin, run the following:
2730

28-
Install the plugin with `cf install-plugin [cf-cli-java-plugin]` (replace `[cf-cli-java-plugin]` with the actual binary name you will use, which depends on the OS you are running).
31+
```sh
32+
# on Mac arm64
33+
cf install-plugin -f https://github.com/SAP/cf-cli-java-plugin/releases/latest/download/cf-cli-java-plugin-macos-arm64
34+
# on Windows x86
35+
cf install-plugin -f https://github.com/SAP/cf-cli-java-plugin/releases/latest/download/cf-cli-java-plugin-windows-amd64
36+
# on Linux x86
37+
cf install-plugin -f https://github.com/SAP/cf-cli-java-plugin/releases/latest/download/cf-cli-java-plugin-linux-amd64
38+
```
2939

3040
You can verify that the plugin is successfully installed by looking for `java` in the output of `cf plugins`.
3141

@@ -109,46 +119,71 @@ USAGE:
109119
vm-info
110120
Print information about the Java Virtual Machine running a Java application
111121

112-
jcmd
122+
jcmd (supports --args)
113123
Run a JCMD command on a running Java application via --args
114124

115-
start-jfr
116-
Start a Java Flight Recorder recording on a running Java application (additional options via --args)
125+
jfr-start
126+
Start a Java Flight Recorder default recording on a running Java application
127+
128+
jfr-start-profile
129+
Start a Java Flight Recorder profile recording on a running Java application
117130

118-
stop-jfr
119-
Stop a Java Flight Recorder recording on a running Java application (additional options via --args)
131+
jfr-start-gc (recent SapMachine only)
132+
Start a Java Flight Recorder GC recording on a running Java application
133+
134+
jfr-start-gc-details (recent SapMachine only)
135+
Start a Java Flight Recorder detailed GC recording on a running Java application
136+
137+
jfr-stop
138+
Stop a Java Flight Recorder recording on a running Java application
139+
140+
jfr-dump
141+
Dump a Java Flight Recorder recording on a running Java application without stopping it
142+
143+
jfr-status
144+
Check the running Java Flight Recorder recording on a running Java application
120145

121146
vm-version
122147
Print the version of the Java Virtual Machine running a Java application
123148

124149
vm-vitals
125150
Print vital statistics about the Java Virtual Machine running a Java application
126151

127-
asprof (recent SapMachine only)
152+
asprof (recent SapMachine only, supports --args)
128153
Run async-profiler commands passed to asprof via --args
129154

130-
asprof-status
131-
Get the status of async-profiler on a running Java application
155+
asprof-start-cpu (recent SapMachine only)
156+
Start an async-profiler CPU-time profile recording on a running Java application
157+
158+
asprof-start-wall (recent SapMachine only)
159+
Start an async-profiler wall-clock profile recording on a running Java application
132160

133-
start-asprof (recent SapMachine only)
134-
Start async-profiler profiling on a running Java application (additional options via --args)
161+
asprof-start-alloc (recent SapMachine only)
162+
Start an async-profiler allocation profile recording on a running Java application
135163

136-
start-asprof-cpu-profile (recent SapMachine only)
137-
Start async-profiler CPU profiling on a running Java application (additional options via --args)
164+
asprof-start-lock (recent SapMachine only)
165+
Start an async-profiler lock profile recording on a running Java application
138166

139-
start-asprof-wall-clock-profile (recent SapMachine only)
140-
Start async-profiler wall-clock profiling on a running Java application (additional options via --args)
167+
asprof-stop (recent SapMachine only)
168+
Stop an async-profiler profile recording on a running Java application
141169

142-
stop-asprof
143-
Stop async-profiler profiling on a running Java application (additional options via --args)
170+
asprof-dump (recent SapMachine only)
171+
Dump an async-profiler profile recording without stopping it
172+
173+
asprof-status (recent SapMachine only)
174+
Get the status of async-profiler on a running Java application
144175

145176
OPTIONS:
146-
-args -a, Miscellaneous arguments to pass to the command in the container, be aware to end it with a space if it is a simple option
147-
-container-dir -cd, the directory path in the container that the heap dump/JFR/... file will be saved to
148-
-dry-run -n, just output to command line what would be executed
149-
-keep -k, keep the heap dump in the container; by default the heap dump/JFR/... will be deleted from the container's filesystem after been downloaded
150-
-local-dir -ld, the local directory path that the dump/JFR/... file will be saved to
151-
-app-instance-index -i [index], select to which instance of the app to connect
177+
--app-instance-index -i [index], select to which instance of the app to connect
178+
--args -a, Miscellaneous arguments to pass to the command (if supported)
179+
in the container, be aware to end it with a space if it is a simple option
180+
--container-dir -cd, the directory path in the container that the heap dump/JFR/... file
181+
will be saved to
182+
--dry-run -n, just output to command line what would be executed
183+
--keep -k, keep the heap dump in the container; by default the heap dump/JFR/...
184+
will be deleted from the container's filesystem after been downloaded
185+
--local-dir -ld, the local directory path that the dump/JFR/... file will be saved to
186+
defaults to the current directory
152187
</pre>
153188

154189
The heap dumps and profiles will be copied to a local file if `-local-dir` is specified as a full folder path. Without providing `-local-dir` the heap dump will only be created in the container and not transferred.

0 commit comments

Comments
 (0)