|
7 | 7 | This plugin for the [Cloud Foundry Command Line](https://github.com/cloudfoundry/cli) provides convenience utilities to |
8 | 8 | work with Java applications deployed on Cloud Foundry. |
9 | 9 |
|
10 | | -Currently, it allows to: |
| 10 | +Currently, it allows you to: |
11 | 11 |
|
12 | 12 | - Trigger and retrieve a heap dump and a thread dump from an instance of a Cloud Foundry Java application |
13 | 13 | - To run jcmd remotely on your application |
@@ -44,7 +44,7 @@ Trigger installation of the plugin via |
44 | 44 | cf install-plugin java |
45 | 45 | ``` |
46 | 46 |
|
47 | | -The releases in the community repository are older that the actual releases on GitHub, that you can install manually, so |
| 47 | +The releases in the community repository are older than the actual releases on GitHub, that you can install manually, so |
48 | 48 | we recommend the manual installation. |
49 | 49 |
|
50 | 50 | ### Manual Installation of Snapshot Release |
@@ -97,16 +97,16 @@ applications: |
97 | 97 | buildpack: https://github.com/cloudfoundry/java-buildpack |
98 | 98 | env: |
99 | 99 | JBP_CONFIG_OPEN_JDK_JRE: |
100 | | - '{ jre: { repository_root: "https://java-buildpack.cloudfoundry.org/openjdk-jdk/bionic/x86_64", version: 11.+ } |
| 100 | + '{ jre: { repository_root: "https://java-buildpack.cloudfoundry.org/openjdk-jdk/jammy/x86_64", version: 11.+ } |
101 | 101 | }' |
102 | 102 | JBP_CONFIG_JAVA_OPTS: "[java_opts: '-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints']" |
103 | 103 | ``` |
104 | 104 |
|
105 | | -`-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints` is used to improve profiling accurary and has no known negative |
| 105 | +`-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints` is used to improve profiling accuracy and has no known negative |
106 | 106 | performance impacts. |
107 | 107 |
|
108 | 108 | Please note that this requires the use of an online buildpack (configured in the `buildpack` property). When system |
109 | | -buildpacks are used, staging will fail with cache issues, because the system buildpacks don’t have the JDK chached. |
| 109 | +buildpacks are used, staging will fail with cache issues, because the system buildpacks don’t have the JDK cached. |
110 | 110 | Please also note that this is not to be considered a recommendation to use a full JDK. It's just one option to get the |
111 | 111 | tools required for the use of this plugin when you need it, e.g., for troubleshooting. The `version` property is |
112 | 112 | optional and can be used to request a specific Java version. |
@@ -150,7 +150,7 @@ Creating a CPU-time profile via async-profiler: |
150 | 150 | > cf java asprof-start-cpu $APP_NAME |
151 | 151 | Profiling started |
152 | 152 | # wait some time to gather data |
153 | | -> cf java asprof-stop-cpu $APP_NAME |
| 153 | +> cf java asprof-stop $APP_NAME |
154 | 154 | -> ./$APP_NAME-asprof-$RANDOM.jfr |
155 | 155 | ``` |
156 | 156 |
|
@@ -222,19 +222,19 @@ USAGE: |
222 | 222 |
|
223 | 223 | jfr-start |
224 | 224 | Start a Java Flight Recorder default recording on a running Java |
225 | | - application (stores in the the container-dir) |
| 225 | + application (stores in the container-dir) |
226 | 226 |
|
227 | 227 | jfr-start-profile |
228 | 228 | Start a Java Flight Recorder profile recording on a running Java |
229 | | - application (stores in the the container-dir)) |
| 229 | + application (stores in the container-dir)) |
230 | 230 |
|
231 | 231 | jfr-start-gc (recent SapMachine only) |
232 | 232 | Start a Java Flight Recorder GC recording on a running Java application |
233 | | - (stores in the the container-dir) |
| 233 | + (stores in the container-dir) |
234 | 234 |
|
235 | 235 | jfr-start-gc-details (recent SapMachine only) |
236 | 236 | Start a Java Flight Recorder detailed GC recording on a running Java |
237 | | - application (stores in the the container-dir) |
| 237 | + application (stores in the container-dir) |
238 | 238 |
|
239 | 239 | jfr-stop |
240 | 240 | Stop a Java Flight Recorder recording on a running Java application |
@@ -288,23 +288,23 @@ USAGE: |
288 | 288 | Get the status of async-profiler on a running Java application |
289 | 289 |
|
290 | 290 | OPTIONS: |
291 | | - -args -a, Miscellaneous arguments to pass to the command (if supported) in the |
292 | | - container, be aware to end it with a space if it is a simple option. For |
293 | | - commands that create arbitrary files (jcmd, asprof), the environment |
294 | | - variables @FSPATH, @ARGS, @APP_NAME, @FILE_NAME, and @STATIC_FILE_NAME are |
295 | | - available in --args to reference the working directory path, arguments, |
296 | | - application name, and generated file name respectively. |
297 | 291 | -container-dir -cd, the directory path in the container that the heap dump/JFR/... file will be |
298 | 292 | saved to |
299 | 293 | -dry-run -n, just output to command line what would be executed |
300 | 294 | -keep -k, keep the heap dump in the container; by default the heap dump/JFR/... will |
301 | | - be deleted from the container's filesystem after been downloaded |
| 295 | + be deleted from the container's filesystem after being downloaded |
302 | 296 | -local-dir -ld, the local directory path that the dump/JFR/... file will be saved to, |
303 | 297 | defaults to the current directory |
304 | 298 | -no-download -nd, don't download the heap dump/JFR/... file to local, only keep it in the |
305 | 299 | container, implies '--keep' |
306 | 300 | -verbose -v, enable verbose output for the plugin |
307 | 301 | -app-instance-index -i [index], select to which instance of the app to connect |
| 302 | + -args -a, Miscellaneous arguments to pass to the command (if supported) in the |
| 303 | + container, be aware to end it with a space if it is a simple option. For |
| 304 | + commands that create arbitrary files (jcmd, asprof), the environment |
| 305 | + variables @FSPATH, @ARGS, @APP_NAME, @FILE_NAME, and @STATIC_FILE_NAME are |
| 306 | + available in --args to reference the working directory path, arguments, |
| 307 | + application name, and generated file name respectively. |
308 | 308 |
|
309 | 309 | </pre> |
310 | 310 |
|
|
0 commit comments