Skip to content

Commit 41bb490

Browse files
committed
clarify metrics for kafka and prometheus
1 parent 06198bb commit 41bb490

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,12 @@ metrics:
383383
- "topic2"
384384
```
385385

386+
Metrics:
387+
388+
- `msg-rate-in-per-second[TOPIC]`: Incoming messages per second per topic.
389+
- `msg-megabytes-in-per-second[TOPIC]`: Incoming megabytes per second per topic.
390+
- `msg-megabytes-out-per-second[TOPIC]`: Outgoing megabytes per second per topic.
391+
386392
### Prometheus
387393

388394
The Prometheus metrics collector continuously scrapes a metrics endpoint, stores
@@ -420,6 +426,9 @@ metrics:
420426
interval: "1s"
421427
```
422428

429+
Metrics are user defined using the `queries` field. The `name` field is used as
430+
the metric name in the CSV output.
431+
423432
## Troubleshooting
424433

425434
- Benchi fails with the error `Cannot connect to the Docker daemon at

0 commit comments

Comments
 (0)