ryankert01 opened a new pull request, #3114:
URL: https://github.com/apache/iggy/pull/3114
## Which issue does this PR close?
`-v` is remove at e46f294b. Let's also remove it in readme.
```
ryan@Mac-mini iggy % cargo r --bin iggy-bench -r -- -v pinned-producer tcp
Finished `release` profile [optimized] target(s) in 0.31s
Running `target/release/iggy-bench -v pinned-producer tcp`
___ ____ _
|_ _|__ _ __ _ _ _ | __ ) ___ _ __ ___| |__
| |/ _` |/ _` | | | | | _ \ / _ \ '_ \ / __| '_ \
| | (_| | (_| | |_| | | |_) | __/ | | | (__| | | |
|___\__, |\__, |\__, | |____/ \___|_| |_|\___|_| |_|
|___/ |___/ |___/
error: unexpected argument '-v' found
Usage: iggy-bench [OPTIONS] <COMMAND>
For more information, try '--help'.
ryan@Mac-mini iggy % cargo r --bin iggy-bench -r -- --help
Finished `release` profile [optimized] target(s) in 0.31s
Running `target/release/iggy-bench --help`
___ ____ _
|_ _|__ _ __ _ _ _ | __ ) ___ _ __ ___| |__
| |/ _` |/ _` | | | | | _ \ / _ \ '_ \ / __| '_ \
| | (_| | (_| | |_| | | |_) | __/ | | | (__| | | |
|___\__, |\__, |\__, | |____/ \___|_| |_|\___|_| |_|
|___/ |___/ |___/
Benchmarking CLI for Iggy message streaming platform
Usage: iggy-bench [OPTIONS] <COMMAND>
Commands:
pinned-producer Pinned producer benchmark [aliases:
pp]
pinned-consumer Pinned consumer benchmark [aliases:
pc]
pinned-producer-and-consumer Pinned producer and consumer
benchmark [aliases: ppc]
balanced-producer Balanced producer benchmark
[aliases: bp]
balanced-consumer-group Balanced consumer group benchmark
[aliases: bcg]
balanced-producer-and-consumer-group N producers sending to M partitions
in K streams, L consumers polling from P consumer groups
[aliases: bpcg]
end-to-end-producing-consumer N producing consumers sending and
polling to/from M streams [aliases: e2e]
end-to-end-producing-consumer-group N producing consumers assigned to M
consumer groups sending and polling to/from K streams
[aliases: e2ecg]
examples Print examples [aliases: e]
help Print this message or the help of
the given subcommand(s)
Options:
-m, --message-size <MESSAGE_SIZE>
Message size in bytes. Accepts either a single value or a range
(e.g. "200..500") [default: 1000]
-P, --messages-per-batch <MESSAGES_PER_BATCH>
Number of messages per batch [default: 1000]
-b, --message-batches <MESSAGE_BATCHES>
Number of message batches per actor (producer / consumer /
producing consumer). This argument is mutually exclusive with
`total_messages_size`
-T, --total-data <TOTAL_DATA>
Total size of all messages to process in bytes (aggregate, for all
actors). This argument is mutually exclusive with
`message_batches`
-r, --rate-limit <RATE_LIMIT>
Optional total rate limit (aggregate, for all actors)
Accepts human-readable formats like "50KB", "10MB", or "1GB"
-w, --warmup-time <WARMUP_TIME>
Warmup time in human readable format, e.g. "1s", "2m", "3h"
[default: 0s]
-t, --sampling-time <SAMPLING_TIME>
Sampling time for metrics collection. It is also used as bucket
size for time series calculations [default: 10ms]
-W, --moving-average-window <MOVING_AVERAGE_WINDOW>
Window size for moving average calculations in time series data
[default: 20]
-H, --high-level-api
Use high-level API for actors
-u, --username <USERNAME>
Username for server authentication [default: iggy]
-p, --password <PASSWORD>
Password for server authentication [default: iggy]
--pretty
Pretty table output for benchmark results
--reuse-streams
Reuse existing bench streams instead of deleting and recreating
them. Without this flag, existing bench streams are deleted
to ensure consumers start with fresh data and accurate latency
measurements
-h, --help
Print help
-V, --version
Print version
```
Closes #
## Rationale
<!--
Why is this change needed? If the issue explains it well, a one-liner is
fine.
-->
## What changed?
<!--
2-4 sentences. Problem first (before), then solution (after).
GOOD:
"Messages were unavailable when background message_saver committed the
journal and started async disk I/O before completion. Polling during
this window found neither journal nor disk data.
The fix freezes journal batches in the in-flight buffer before async
persist."
GOOD:
"When many small messages accumulate in the journal, the flush passes
thousands of IO vectors to writev(), exceeding IOV_MAX (1024 on Linux)."
BAD:
- Walls of text
- "This PR adds..." (we can see the diff)
-->
## Local Execution
- Passed / not passed
- Pre-commit hooks ran / not ran
<!--
You must run your code locally before submitting.
"Relying on CI" is not acceptable - PRs from authors who haven't run the
code will be closed.
Did you have `prek` installed? It runs automatically on commit and covers
all project languages. See
[CONTRIBUTING.md](https://github.com/apache/iggy/blob/master/CONTRIBUTING.md).
-->
## AI Usage
<!--
If AI tools were used, please answer:
1. Which tools? (e.g., GitHub Copilot, Claude, ChatGPT)
2. Scope of usage? (e.g., autocomplete, generated functions, entire
implementation)
3. How did you verify the generated code works correctly?
4. Can you explain every line of the code if asked?
If no AI tools were used, write "None" or delete this section.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
