aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorartem-trof <artem-trof@yandex-team.com>2023-07-27 08:55:55 +0300
committerartem-trof <artem-trof@yandex-team.com>2023-07-27 08:55:55 +0300
commitbf9bfd28540ee8cb9976d4b573fa7aeb69d3f04a (patch)
treed9d1fc07af1a21ae836e21d2944f3b86a126bc28
parenta4d459e1893178cc5bb63e8ffe1b90c15857c703 (diff)
downloadydb-bf9bfd28540ee8cb9976d4b573fa7aeb69d3f04a.tar.gz
add consumer-prefix parameter
-rw-r--r--ydb/docs/en/core/reference/ydb-cli/workload-topic.md3
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/workload-topic.md3
2 files changed, 6 insertions, 0 deletions
diff --git a/ydb/docs/en/core/reference/ydb-cli/workload-topic.md b/ydb/docs/en/core/reference/ydb-cli/workload-topic.md
index f72c14459c..ad263ecd8f 100644
--- a/ydb/docs/en/core/reference/ydb-cli/workload-topic.md
+++ b/ydb/docs/en/core/reference/ydb-cli/workload-topic.md
@@ -32,6 +32,7 @@ Subcommand options:
| `--topic` | Topic name.<br>Default value: `workload-topic`. |
| `--partitions`, `-p` | Number of topic partitions.<br>Default value: `128`. |
| `--consumers`, `-c` | Number of topic consumers.<br>Default value: `1`. |
+| `--consumer-prefix` | Consumer name prefix.<br/>Default value: `workload-consumer`.<br>For example, if the number of consumers `--consumers` is `2` and the prefix `--consumer-prefix` is `workload-consumer`, then the following consumer names will be used: `workload-consumer-0`, `workload-consumer-1`. |
> To create a topic with `256` partitions and `2` consumers, run this command:
>
@@ -137,6 +138,7 @@ Subcommand options:
| `--percentile` | Percentile that is output in statistics.<br>Default value: `50`. |
| `--topic` | Topic name.<br>Default value: `workload-topic`. |
| `--consumers`, `-c` | Number of consumers.<br>Default value: `1`. |
+| `--consumer-prefix` | Consumer name prefix.<br/>Default value: `workload-consumer`.<br>For example, if the number of consumers `--consumers` is `2` and the prefix `--consumer-prefix` is `workload-consumer`, then the following consumer names will be used: `workload-consumer-0`, `workload-consumer-1`. |
| `--threads`, `-t` | Number of consumer threads.<br>Default value: `1`. |
> To use `2` consumers to read data from the topic, with `100` threads per consumer, run the following command:
@@ -207,6 +209,7 @@ Subcommand options:
| `--byte-rate` | Total target write rate in bytes per second. Can't be used together with the `--byte-rate` option. Use the `K`, `M`, or `G` suffix to set the rate in KB/s, MB/s, or GB/s, respectively.<br>Default value: `0` (no limit). |
| `--codec` | Codec used to compress messages on the client before sending them to the server.<br>Compression increases CPU usage on the client when reading and writing messages, but usually enables you to reduce the amounts of data stored and transmitted over the network. When consumers read messages, they decompress them by the codec that was used to write the messages, with no special options needed.<br>Acceptable values: `RAW` - no compression (default), `GZIP`, `ZSTD`. |
| `--consumers`, `-c` | Number of consumers.<br>Default value: `1`. |
+| `--consumer-prefix` | Consumer name prefix.<br/>Default value: `workload-consumer`.<br>For example, if the number of consumers `--consumers` is `2` and the prefix `--consumer-prefix` is `workload-consumer`, then the following consumer names will be used: `workload-consumer-0`, `workload-consumer-1`. |
| `--threads`, `-t` | Number of consumer threads.<br>Default value: `1`. |
> Example of a command that reads `50` threads by `2` consumers and writes data to `100` producer threads at the target rate of `80` MB/s and duration of `10` seconds:
diff --git a/ydb/docs/ru/core/reference/ydb-cli/workload-topic.md b/ydb/docs/ru/core/reference/ydb-cli/workload-topic.md
index 1f5425b00f..4172f18fa2 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/workload-topic.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/workload-topic.md
@@ -32,6 +32,7 @@
`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
`--partitions`, `-p` | Количество партиций топика.<br>Значение по умолчанию: `128`.
`--consumers`, `-c` | Количество читателей топика.<br>Значение по умолчанию: `1`.
+`--consumer-prefix` | Префикс имени читателей.<br/>Значение по умолчанию: `workload-consumer`.<br/>Например, если количество читателей `--consumers` равно `2` и префикс `--consumer-prefix` равен `workload-consumer`, то будут использованы следующие имена читателей: `workload-consumer-0`, `workload-consumer-1`.
>Чтобы создать топик с `256` партициями и `2` читателями, выполните команду:
>
@@ -137,6 +138,7 @@
`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
`--consumers`, `-c` | Количество читателей.<br>Значение по умолчанию: `1`.
+`--consumer-prefix` | Префикс имени читателей.<br/>Значение по умолчанию: `workload-consumer`.<br/>Например, если количество читателей `--consumers` равно `2` и префикс `--consumer-prefix` равен `workload-consumer`, то будут использованы следующие имена читателей: `workload-consumer-0`, `workload-consumer-1`.
`--threads`, `-t` | Количество потоков читателя.<br>Значение по умолчанию: `1`.
>Чтобы выполнить чтение из топика с помощью `2` читателей, каждый из который имеет `100` потоков, выполните следующую команду:
@@ -207,6 +209,7 @@
`--byte-rate` | Целевая суммарная скорость записи, байт в секунду. Исключает использование параметра `--byte-rate`. Возможно задание в КБ/с, МБ/с, ГБ/с путем добавления суффиксов `K`,`M`,`G` соответственно.<br>Значение по умолчанию: `0` (нет ограничения).
`--codec` | Кодек, используемый для сжатия сообщений на клиенте перед отправкой на сервер.<br>Сжатие увеличивает затраты CPU на клиенте при записи и чтении сообщений, но обычно позволяет уменьшить объем передаваемых по сети и хранимых данных. При последующем чтении сообщений подписчиками они автоматически разжимаются использованным при записи кодеком, не требуя указания каких-либо параметров.<br>Возможные значения: `RAW` - без сжатия (по умолчанию), `GZIP`, `ZSTD`.
`--consumers`, `-c` | Количество читателей.<br>Значение по умолчанию: `1`.
+`--consumer-prefix` | Префикс имени читателей.<br/>Значение по умолчанию: `workload-consumer`.<br/>Например, если количество читателей `--consumers` равно `2` и префикс `--consumer-prefix` равен `workload-consumer`, то будут использованы следующие имена читателей: `workload-consumer-0`, `workload-consumer-1`.
`--threads`, `-t` | Количество потоков читателя.<br>Значение по умолчанию: `1`.
>Пример команды чтения с помощью `2` читателей в `50` потоков и записи `100` потоков писателей с целевой скоростью `80` МБ/с и длительностью `10` секунд: