Skip to content

Fix benchmark typos and add workers file example #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: source
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/benchmarks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,16 @@ $ sudo bin/benchmark \
`-wf` / `--workers-file` | Path to a YAML file containing the list of workers addresses. | N/A
`-h` / `--help` | Print help message | `false`

here is an example of a file for `--workers-file` flag

```yaml
workers:
- http://1.1.1.1:8080
- http://1.1.1.2:8080
- http://1.1.1.3:8080
- http://1.1.1.4:8080
```

### Workers
```
$ sudo bin/benchmark-worker \
Expand Down Expand Up @@ -100,19 +110,19 @@ Workload | Topics | Partitions per topic | Message size | Subscriptions per topi

## Interpreting the results

Initially, you should see a log message like this, which affirms that a warm-up phase is intiating:
Initially, you should see a log message like this, which affirms that a warm-up phase is initiating:

```
22:03:19.125 [main] INFO - ----- Starting warm-up traffic ------
```

You should then see some just a handful of readings, followed by an aggregation message that looks like this:
You should then see just a handful of readings, followed by an aggregation message that looks like this:

```
22:04:19.329 [main] INFO - ----- Aggregated Pub Latency (ms) avg: 2.1 - 50%: 1.7 - 95%: 3.0 - 99%: 11.8 - 99.9%: 45.4 - 99.99%: 52.6 - Max: 55.4
```

At this point, the benchmarking traffic will begin. You'll start see readings like this emitted every few seconds:
At this point, the benchmarking traffic will begin. You'll start to see readings like this emitted every few seconds:

```
22:03:29.199 [main] INFO - Pub rate 50175.1 msg/s / 4.8 Mb/s | Cons rate 50175.2 msg/s / 4.8 Mb/s | Backlog: 0.0 K | Pub Latency (ms) avg: 3.5 - 50%: 1.9 - 99%: 39.8 - 99.9%: 52.3 - Max: 55.4
Expand Down
2 changes: 1 addition & 1 deletion docs/benchmarks/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This tutorial shows you how to run OpenMessaging [benchmarks](..) for [Apache Ka

## Initial setup

To being, you'll need to clone the [`benchmark`](https://github.com/openmessaging/openmessaging-benchmark) repo from the [`openmessaging`](https://github.com/openmessaging) organization on [GitHub](https://github.com):
To start, you'll need to clone the [`benchmark`](https://github.com/openmessaging/openmessaging-benchmark) repo from the [`openmessaging`](https://github.com/openmessaging) organization on [GitHub](https://github.com):

```bash
$ git clone https://github.com/openmessaging/openmessaging-benchmark
Expand Down