Skip to content

Commit ec1dc72

Browse files
committed
Document monitoring support in performance tool
References #28, #29
1 parent a268ed1 commit ec1dc72

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/docs/asciidoc/performance-tool.adoc

+12
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,18 @@ java -jar stream-perf-test.jar --producer-names %s-%d
465465

466466
The run will start one producer and will use the `stream-1` producer reference (default stream is `stream` and the number of the producer is 1.)
467467

468+
===== Monitoring
469+
470+
The tool can expose some runtime information on HTTP.
471+
The default port is 8080.
472+
The following options are available:
473+
474+
* `--monitoring`: add a `threaddump` endpoint to display a thread dump of the process.
475+
This can be useful to inspect threads if the tool seems blocked.
476+
* `--prometheus`: add a `metrics` endpoint to expose metrics using the Prometheus format.
477+
The endpoint can then be declared in a Prometheus instance to scrape the metrics.
478+
* `--monitoring-port`: set the port to use for the web server.
479+
468480
===== Logging
469481

470482
The performance tool binary uses Logback with an internal configuration file.

0 commit comments

Comments
 (0)