summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbazeltsev <[email protected]>2023-05-11 15:06:11 +0300
committerbazeltsev <[email protected]>2023-05-11 15:06:11 +0300
commit744971c61564b2b1f1ca2ad3f450bf7f586f7bf5 (patch)
tree1b52080601019c9281e8e7b2c2af93e1d45f6ba8
parentab7e037b8af826c5c267376a28da7c4b6df4cdd4 (diff)
Workload topic documentation tail
updated
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/workload-topic.md422
1 files changed, 191 insertions, 231 deletions
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 72dd68cb97c..373dedb8f4e 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/workload-topic.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/workload-topic.md
@@ -1,292 +1,252 @@
# Topic нагрузка
-Простой вид нагрузки, использующий [топики](../../concepts/topic.md) YDB в качестве очередей сообщений.
+Нагружает [топики](../../concepts/topic.md) {{ ydb-short-name }}, используя их в качестве очередей сообщений. Для имитации реальной нагрузки вы можете изменять различные входные параметры: число сообщений, размер сообщений, целевую скорость записи, число читателей и писателей.
-В процессе работы пишется и читается большое число сообщений в целях измерения показателей производительности.
+В процессе работы на консоль выдаются результаты, которые включают количество записанных сообщений, скорость записи сообщений и пр.
-Для соответствия реальной нагрузке можно изменять различные входные параметры: число сообщений, размер сообщений, целевую скорость записи, число писателей и читателей.
+Чтобы нагрузить топик:
-В процессе работы на консоль выдаются результаты, включающие число и скорость сообщений, временные показатели.
+1. [Инициализируйте нагрузку](#init).
+1. Запустите один из доступных видов нагрузки:
+ * [write](#run-write) — генерация сообщений и их запись в топик в асинхронном режиме;
+ * [read](#run-read) — асинхронное чтение сообщений из топика;
+ * [full](#run-full) — одновременное асинхронное чтение и запись сообщений.
-## Виды нагрузки {#workload-types}
-
-Данный нагрузочный тест содержит 3 вида нагрузки:
-
-* [write](#run-write) — генерация сообщений и их запись в топик в асинхронном режиме;
-* [read](#run-read) — асинхронное чтение сообщений из топика;
-* [full](#run-full) — одновременное асинхронное чтение и запись сообщений.
+{% include [ydb-cli-profile.md](../../_includes/ydb-cli-profile.md) %}
## Инициализация нагрузочного теста {#init}
-Для начала работы необходимо создать топик:
-
-```bash
-{{ ydb-cli }} workload topic init [init options...]
-```
-
-* `init options` — [параметры инициализации](#init-options).
-
-Посмотреть описание команды для создания топика:
-
-```bash
-{{ ydb-cli }} workload topic init --help
-```
-
-### Доступные параметры {#init-options}
-
-Имя параметра | Короткое имя | Описание параметра
----|---|---
-`--partitions <значение>` | `-p <значение>` | Количество партиций топика. Значение по умолчанию: 128.
-`--consumers <значение>` | `-c <значение>` | Количество читателей топика. Значение по умолчанию: 1.
-
-В результате выполнения команды будет создан топик с фиксированным именем `workload-topic` и указанным числом партиций и читателей.
-
-### Примеры инициализации нагрузки {#init-topic-examples}
-
-Пример команды создания топика с 256 партициями и 2 читателями:
-
-```bash
-{{ ydb-cli }} workload topic init --partitions 256 --consumers 2
-```
-
-## Удаление топика {#clean}
-
-После завершения работы можно удалить топик:
-
-```bash
-{{ ydb-cli }} workload topic clean
-```
-
-В результате выполнения команды будет удален топик `workload-topic`.
-
-### Пример использования clean {#clean-topic-examples}
+Перед запуском нагрузки ее необходимо инициализировать. При инициализации будет создан топик `workload-topic` с указанными параметрами. Инициализация выполняется следующей командой:
```bash
-{{ ydb-cli }} workload topic clean
+{{ ydb-cli }} ydb [global options...] workload topic init [options...]
```
-## Запуск нагрузочного теста {#run}
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — параметры подкоманды.
-Для запуска нагрузки необходимо выполнить команду:
-
-```bash
-{{ ydb-cli }} workload topic run [workload type...] [specific workload options...]
-```
-
-* `workload type` — [виды нагрузки](#workload-types).
-* `global workload options` — [общие параметры для всех видов нагрузки](#global-workload-options).
-* `specific workload options` — параметры конкретного вида нагрузки.
-
-Посмотреть описание команды для запуска нагрузки:
-
-```bash
-{{ ydb-cli }} workload topic run --help
-```
+Параметры подкоманды:
-### Общие параметры для всех видов нагрузки {#global-workload-options}
+Имя параметра | Описание параметра
+---|---
+`--partitions`, `-p` | Количество партиций топика.<br>Значение по умолчанию: `128`.
+`--consumers`, `-c` | Количество читателей топика.<br>Значение по умолчанию: `1`.
-Имя параметра | Короткое имя | Описание параметра
----|---|---
-`--seconds <значение>` | `-s <значение>` | Продолжительность теста (секунд). Значение по умолчанию: 10.
-`--window <значение>` | `-w <значение>` | Длительность окна сбора статистики (секунд). Значение по умолчанию: 1.
-`--quiet` | `-q` | Выводит только итоговый результат теста.
-`--print-timestamp` | - | Печатать время вместе со статистикой каждого временного окна.
+>Чтобы создать топик с `256` партициями и `2` читателями, выполните команду:
+>
+>```bash
+>{{ ydb-cli }} --profile quickstart workload topic init --partitions 256 --consumers 2
+>```
## Нагрузка на запись {#run-write}
-Данный вид нагрузки генерирует и вставляет сообщения в топик в асинхронном режиме.
+Этот вид нагрузки генерирует и записывает сообщения в топик в асинхронном режиме.
-Для запуска данного вида нагрузки необходимо выполнить команду:
+Общий вид команды для запуска нагрузки на запись:
```bash
-{{ ydb-cli }} workload topic run write [global workload options...] [specific workload options...]
+{{ ydb-cli }} [global options...] workload topic run write [options...]
```
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — параметры подкоманды.
+
Посмотреть описание команды для запуска нагрузки на запись:
```bash
{{ ydb-cli }} workload topic run write --help
```
-### Параметры нагрузки на запись {#run-write-options}
-
-Имя параметра | Короткое имя | Описание параметра
----|---|---
-`--threads <значение>` | `-t <значение>` | Количество потоков писателя. Значение по умолчанию: `1`.
-`--message-size <значение>` | `-m <значение>` | Размер сообщения (байт). Возможно задание в Кбайт, Мбайт, Гбайт путем добавления суффиксов соответственно: `K`, `M`, `G`. Значение по умолчанию: `10K`.
-`--message-rate <значение>` | - | Целевая суммарная скорость записи (сообщений в секунду). 0 - нет ограничения. Значение по умолчанию: `0`.
-`--byte-rate <значение>` | - | Целевая суммарная скорость записи (байт в секунду). 0 - нет ограничения. Возможно задание в Кбайт/с, Мбайт/с, Гбайт/с путем добавления суффиксов соответственно: `K`,`M`,`G`. Значение по умолчанию: `0`.
-`--codec <значение>` | - | Кодек, используемый для сжатия сообщений на клиенте перед отправкой на сервер. Возможные варианты: `RAW` - без сжатия, `GZIP`, `ZSTD`. Сжатие увеличивает затраты CPU на клиенте при записи и чтении сообщений, но обычно позволяет уменьшить объем передаваемых по сети и хранимых данных. При последующем чтении сообщений подписчиками они автоматически разжимаются использованным при записи кодеком, не требуя указания каких-либо специальных опций. Значение по умолчанию: `RAW`.
-
-Внимание, параметры `--byte-rate` и `--message-rate` являются взаимоисключающими.
-
-### Примеры запуска нагрузки на запись {#run-write-examples}
-
-Пример команды записи в 100 потоков писателей с целевой скоростью 80 Мбайт/с и длительностью 300 секунд:
-
-```bash
-{{ ydb-cli }} workload topic run write --threads 100 --seconds 300 --byte-rate 80M
-```
+Параметры подкоманды:
-### Вывод нагрузки на запись {#run-write-output}
-
-В процессе работы печатается статистика за промежуточные временные окна и в конце итоговая статистика за всё время работы. Пример вывода:
-
-```text
-Window Write speed Write time Inflight
-# msg/s MB/s P99(ms) max msg
-1 20 0 1079 72
-2 8025 78 1415 78
-3 7987 78 1431 79
-4 7888 77 1471 101
-5 8126 79 1815 116
-6 7018 68 1447 79
-7 8938 87 2511 159
-8 7055 68 1463 78
-9 7062 69 1455 79
-10 9912 96 3679 250
-Window Write speed Write time Inflight
-# msg/s MB/s P99(ms) max msg
-Total 7203 70 3023 250
-```
-
-Имя колонки | Описание колонки
+Имя параметра | Описание параметра
---|---
-`Window`|Порядковый номер временного окна сбора статистики.
-`Write speed`|Скорость записи сообщений (сообщений/с и Мбайт/с).
-`Write time`|99 перцентиль времени записи сообщения (мс).
-`Inflight`|Максимальное число сообщений, ожидающих подтверждения по всем партициям (сообщений).
+`--seconds`, `-s` | Продолжительность теста в секундах.<br>Значение по умолчанию: `10`.
+`--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
+`--quiet`, `-q` | Выводить только итоговый результат теста.
+`--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
+`--threads`, `-t` | Количество потоков писателя.<br>Значение по умолчанию: `1`.
+`--message-size`, `-m` | Размер сообщения в байтах. Возможно задание в КБ, МБ, ГБ путем добавления суффиксов `K`, `M`, `G` соответственно.<br>Значение по умолчанию: `10K`.
+`--message-rate` | Целевая суммарная скорость записи, сообщений в секунду. Исключает использование параметра `--message-rate`.<br>Значение по умолчанию: `0` (нет ограничения).
+`--byte-rate` | Целевая суммарная скорость записи, байт в секунду. Исключает использование параметра `--byte-rate`. Возможно задание в КБ/с, МБ/с, ГБ/с путем добавления суффиксов `K`,`M`,`G` соответственно.<br>Значение по умолчанию: `0` (нет ограничения).
+`--codec` | Кодек, используемый для сжатия сообщений на клиенте перед отправкой на сервер.<br>Сжатие увеличивает затраты CPU на клиенте при записи и чтении сообщений, но обычно позволяет уменьшить объем передаваемых по сети и хранимых данных. При последующем чтении сообщений подписчиками они автоматически разжимаются использованным при записи кодеком, не требуя указания каких-либо параметров.<br>Возможные значения: `RAW` - без сжатия (по умолчанию), `GZIP`, `ZSTD`.
+
+>Чтобы записать в `100` потоков писателей с целевой скоростью `80` МБ/с в течение `10` секунд, выполните следующую команду:
+>
+>```bash
+>{{ ydb-cli }} --profile quickstart workload topic run write --threads 100 --byte-rate 80M
+>```
+>
+>В процессе работы будет выводиться статистика по промежуточные временным окнам, а по окончании теста — итоговая статистика за все время работы:
+>
+>```text
+>Window Write speed Write time Inflight
+># msg/s MB/s P99(ms) max msg
+>1 20 0 1079 72
+>2 8025 78 1415 78
+>3 7987 78 1431 79
+>4 7888 77 1471 101
+>5 8126 79 1815 116
+>6 7018 68 1447 79
+>7 8938 87 2511 159
+>8 7055 68 1463 78
+>9 7062 69 1455 79
+>10 9912 96 3679 250
+>Window Write speed Write time Inflight
+># msg/s MB/s P99(ms) max msg
+>Total 7203 70 3023 250
+>```
+>
+>* `Window` — порядковый номер временного окна сбора статистики;
+>* `Write speed` — скорость записи сообщений, сообщений в секунду и МБ/с;
+>* `Write time` — 99 перцентиль времени записи сообщения, мс.
+>* `Inflight` — максимальное число сообщений, ожидающих подтверждения по всем партициям.
## Нагрузка на чтение {#run-read}
-Данный вид нагрузки асинхронно читает сообщения из топика.
+Этот вид нагрузки асинхронно читает сообщения из топика. Чтобы в топике появились сообщения, перед началом чтения запустите [нагрузку на запись](#run-write).
-Для запуска данного вида нагрузки необходимо выполнить команду:
+Общий вид команды для запуска нагрузки на чтение:
```bash
-{{ ydb-cli }} workload topic run read [global workload options...] [specific workload options...]
+{{ ydb-cli }} [global options...] workload topic run read [options...]
```
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — параметры подкоманды.
+
Посмотреть описание команды для запуска нагрузки на чтение:
```bash
{{ ydb-cli }} workload topic run read --help
```
-### Параметры нагрузки на чтение {#run-read-options}
-
-Имя параметра | Короткое имя | Описание параметра
----|---|---
-`--consumers <значение>` | `-c <значение>` | Количество читателей. Значение по умолчанию: `1`.
-`--threads <значение>` | `-t <значение>` | Количество потоков читателя. Значение по умолчанию: `1`.
+Параметры подкоманды:
-### Примеры запуска нагрузки на чтение {#run-read-examples}
-
-Пример команды чтения с помощью 2 читателей, каждый из который имеет 100 потоков:
-
-```bash
-{{ ydb-cli }} workload topic run read --consumers 2 --threads 100
-```
-
-### Вывод нагрузки на чтение {#run-read-output}
-
-В процессе работы печатается статистика за промежуточные временные окна и в конце итоговая статистика за всё время работы. Пример вывода:
-
-```text
-Window Lag Lag time Read speed Full time
-# max msg P99(ms) msg/s MB/s P99(ms)
-1 0 0 48193 471 0
-2 30176 0 66578 650 0
-3 30176 0 68999 674 0
-4 30176 0 66907 653 0
-5 27835 0 67628 661 0
-6 30176 0 67938 664 0
-7 30176 0 71628 700 0
-8 20338 0 61367 599 0
-9 30176 0 61770 603 0
-10 30176 0 58291 569 0
-Window Lag Lag time Read speed Full time
-# max msg P99(ms) msg/s MB/s P99(ms)
-Total 30176 0 80267 784 0
-```
-
-Имя колонки | Описание колонки
+Имя параметра | Описание параметра
---|---
-`Window`|Порядковый номер временного окна сбора статистики.
-`Lag`|Максимальная задержка сообщений по всем партициям (сообщений). Число сообщений, ожидающих чтения.
-`Lag time`|99 перцентиль времени задержки сообщений (мс).
-`Read`|Скорость чтения сообщений читателем (сообщений/с и Мбайт/с).
-`Full time`|99 перцентиль времени полной обработки сообщения, от записи писателем до чтения читателем (мс).
-
-## Нагрузка на чтение/запись {#run-full}
-
-Данный вид нагрузки одновременно асинхронно пишет и читает сообщения.
-
-Для запуска данного вида нагрузки необходимо выполнить команду:
-
-```bash
-{{ ydb-cli }} workload topic run full [global workload options...] [specific workload options...]
-```
-
-Выполнение данной команды эквивалентно одновременному запуску двух процессов нагрузки на чтение и запись.
-
-Посмотреть описание команды для запуска нагрузки на чтение/запись:
+`--seconds`, `-s` | Продолжительность теста в секундах.<br>Значение по умолчанию: `10`.
+`--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
+`--quiet`, `-q` | Выводить только итоговый результат теста.
+`--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
+`--consumers`, `-c` | Количество читателей.<br>Значение по умолчанию: `1`.
+`--threads`, `-t` | Количество потоков читателя.<br>Значение по умолчанию: `1`.
+
+>Чтобы выполнить чтение из топика с помощью `2` читателей, каждый из который имеет `100` потоков, выполните следующую команду:
+>
+>```bash
+>{{ ydb-cli }} --profile quickstart workload topic run read --consumers 2 --threads 100
+>```
+>
+>В процессе работы будет выводиться статистика по промежуточные временным окнам, а по окончании теста — итоговая статистика за все время работы:
+>
+>```text
+>Window Lag Lag time Read speed Full time
+># max msg P99(ms) msg/s MB/s P99(ms)
+>1 0 0 48193 471 0
+>2 30176 0 66578 650 0
+>3 30176 0 68999 674 0
+>4 30176 0 66907 653 0
+>5 27835 0 67628 661 0
+>6 30176 0 67938 664 0
+>7 30176 0 71628 700 0
+>8 20338 0 61367 599 0
+>9 30176 0 61770 603 0
+>10 30176 0 58291 569 0
+>Window Lag Lag time Read speed Full time
+># max msg P99(ms) msg/s MB/s P99(ms)
+>Total 30176 0 80267 784 0
+>```
+>
+>* `Window` — порядковый номер временного окна сбора статистики.
+>* `Lag` — максимальное в окне сбора статистики отставание читателя. Учитываются сообщения по всем партициям.
+>* `Lag time` — 99 перцентиль времени задержки сообщений в мс.
+>* `Read` — Скорость чтения сообщений читателем, сообщений в секунду и МБ/с.
+>* `Full time` — 99 перцентиль времени полной обработки сообщения (от записи писателем до чтения читателем) в мс.
+
+## Нагрузка на чтение и запись {#run-full}
+
+Этот вид нагрузки одновременно асинхронно пишет и читает сообщения. Выполнение данной команды эквивалентно одновременному запуску нагрузок на чтение и запись.
+
+Общий вид команды для запуска нагрузки на чтение и запись:
+
+```bash
+{{ ydb-cli }} [global options...] workload topic run full [options...]
+```
+
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — параметры подкоманды.
+
+Посмотреть описание команды для запуска нагрузки на чтение и запись:
```bash
{{ ydb-cli }} workload topic run full --help
```
-### Параметры нагрузки на чтение/запись {#run-full-options}
-
-Имя параметра | Короткое имя | Описание параметра
----|---|---
-`--producer-threads <значение>` | `-p <значение>` | Количество потоков писателя. Значение по умолчанию: `1`.
-`--message-size <значение>` | `-m <значение>` | Размер сообщения (байт). Возможно задание в Кбайт, Мбайт, Гбайт путем добавления суффиксов соответственно: `K`, `M`, `G`. Значение по умолчанию: `10K`.
-`--message-rate <значение>` | - | Целевая суммарная скорость записи (сообщений в секунду). 0 - нет ограничения. Значение по умолчанию: `0`.
-`--byte-rate <значение>` | - | Целевая суммарная скорость записи (байт в секунду). 0 - нет ограничения. Возможно задание в Кбайт/с, Мбайт/с, Гбайт/с путем добавления суффиксов соответственно: `K`,`M`,`G`. Значение по умолчанию: `0`.
-`--codec <значение>` | - | Кодек, используемый для сжатия сообщений на клиенте перед отправкой на сервер. Возможные варианты: `RAW` - без сжатия, `GZIP`, `ZSTD`. Сжатие увеличивает затраты CPU на клиенте при записи и чтении сообщений, но обычно позволяет уменьшить объем передаваемых по сети и хранимых данных. При последующем чтении сообщений подписчиками они автоматически разжимаются использованным при записи кодеком, не требуя указания каких-либо специальных опций. Значение по умолчанию: `RAW`.
-`--consumers <значение>` | `-c <значение>` | Количество читателей. Значение по умолчанию: `1`.
-`--consumer-threads <значение>` | `-t <значение>` | Количество потоков читателя. Значение по умолчанию: `1`.
+Параметры подкоманды:
-Внимание, параметры `--byte-rate` и `--message-rate` являются взаимоисключающими.
+Имя параметра | Описание параметра
+---|---
+`--seconds`, `-s` | Продолжительность теста в секундах.<br>Значение по умолчанию: `10`.
+`--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
+`--quiet`, `-q` | Выводить только итоговый результат теста.
+`--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
+`--producer-threads`, `-p` | Количество потоков писателя.<br>Значение по умолчанию: `1`.
+`--message-size`, `-m` | Размер сообщения в байтах. Возможно задание в КБ, МБ, ГБ путем добавления суффиксов `K`, `M`, `G` соответственно.<br>Значение по умолчанию: `10K`.
+`--message-rate` | Целевая суммарная скорость записи, сообщений в секунду. Исключает использование параметра `--message-rate`.<br>Значение по умолчанию: `0` (нет ограничения).
+`--byte-rate` | Целевая суммарная скорость записи, байт в секунду. Исключает использование параметра `--byte-rate`. Возможно задание в КБ/с, МБ/с, ГБ/с путем добавления суффиксов `K`,`M`,`G` соответственно:<br>Значение по умолчанию: `0` (нет ограничения).
+`--codec` | Кодек, используемый для сжатия сообщений на клиенте перед отправкой на сервер.<br>Сжатие увеличивает затраты CPU на клиенте при записи и чтении сообщений, но обычно позволяет уменьшить объем передаваемых по сети и хранимых данных. При последующем чтении сообщений подписчиками они автоматически разжимаются использованным при записи кодеком, не требуя указания каких-либо параметров.<br>Возможные значения: `RAW` - без сжатия (по умолчанию), `GZIP`, `ZSTD`.
+`--consumers`, `-c` | Количество читателей.<br>Значение по умолчанию: `1`.
+`--threads`, `-t` | Количество потоков читателя.<br>Значение по умолчанию: `1`.
+
+>Пример команды чтения с помощью `2` читателей в `50` потоков и записи `100` писателей с целевой скоростью `80` МБ/с и длительностью `10` секунд:
+>
+>```bash
+>{{ ydb-cli }} --profile quickstart workload topic run full --producer-threads 100 --consumers 2 --consumer-threads 50 --byte-rate 80M
+>```
+>
+>В процессе работы будет выводиться статистика по промежуточные временным окнам, а по окончании теста — итоговая статистика за все время работы:
+>
+>```text
+>Window Write speed Write time Inflight Lag Lag time Read speed Full time
+># msg/s MB/s P99(ms) max msg max msg P99(ms) msg/s MB/s P99(ms)
+>1 39 0 1215 4 0 0 30703 300 29716
+>2 1091 10 2143 8 2076 20607 40156 392 30941
+>3 1552 15 2991 12 7224 21887 41040 401 31886
+>4 1733 16 3711 15 10036 22783 38488 376 32577
+>5 1900 18 4319 15 10668 23551 34784 340 33372
+>6 2793 27 5247 21 9461 24575 33267 325 34893
+>7 2904 28 6015 22 12150 25727 34423 336 35507
+>8 2191 21 5087 21 12150 26623 29393 287 36407
+>9 1952 19 2543 10 7627 27391 33284 325 37814
+>10 1992 19 2655 9 10104 28671 29101 284 38797
+>Window Write speed Write time Inflight Lag Lag time Read speed Full time
+># msg/s MB/s P99(ms) max msg max msg P99(ms) msg/s MB/s P99(ms)
+>Total 1814 17 5247 22 12150 28671 44827 438 40252
+>```
+>
+>* `Window` — порядковый номер временного окна сбора статистики.
+>* `Write speed` — скорость записи сообщений, сообщений в секунду и МБ/с.
+>* `Write time` — 99 перцентиль времени записи сообщения в мс.
+>* `Inflight` — максимальное число сообщений, ожидающих подтверждения по всем партициям.
+>* `Lag` — максимальное число сообщений, ожидающих чтения, в окне сбора статистики. Учитываются сообщения по всем партициям.
+>* `Lag time` — 99 перцентиль времени задержки сообщений в мс.
+>* `Read` — Скорость чтения сообщений читателем, сообщений в секунду и МБ/с.
+>* `Full time` — 99 перцентиль времени полной обработки сообщения, от записи писателем до чтения читателем в мс.
-### Примеры запуска нагрузки на чтение/запись {#run-full-examples}
+## Удаление топика {#clean}
-Пример команды чтения/записи с помощью 2 читателей в 50 потоков, 100 писателей с целевой скоростью 80 Мбайт/с и длительностью 300 секунд:
+После завершения работы можно удалить тестовый топик. Общий вид команды для удаления топика:
```bash
-{{ ydb-cli }} workload topic run full --producer-threads 100 --consumers 2 --consumer-threads 50 --byte-rate 80M --seconds 300
+{{ ydb-cli }} [global options...] workload topic clean [options...]
```
-### Вывод нагрузки на чтение/запись {#run-full-output}
-
-В процессе работы печатается статистика за промежуточные временные окна и в конце итоговая статистика за всё время работы. Пример вывода:
-
-```text
-Window Write speed Write time Inflight Lag Lag time Read speed Full time
-# msg/s MB/s P99(ms) max msg max msg P99(ms) msg/s MB/s P99(ms)
-1 39 0 1215 4 0 0 30703 300 29716
-2 1091 10 2143 8 2076 20607 40156 392 30941
-3 1552 15 2991 12 7224 21887 41040 401 31886
-4 1733 16 3711 15 10036 22783 38488 376 32577
-5 1900 18 4319 15 10668 23551 34784 340 33372
-6 2793 27 5247 21 9461 24575 33267 325 34893
-7 2904 28 6015 22 12150 25727 34423 336 35507
-8 2191 21 5087 21 12150 26623 29393 287 36407
-9 1952 19 2543 10 7627 27391 33284 325 37814
-10 1992 19 2655 9 10104 28671 29101 284 38797
-Window Write speed Write time Inflight Lag Lag time Read speed Full time
-# msg/s MB/s P99(ms) max msg max msg P99(ms) msg/s MB/s P99(ms)
-Total 1814 17 5247 22 12150 28671 44827 438 40252
-```
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — параметры подкоманды.
-Имя колонки | Описание колонки
----|---
-`Window`|Порядковый номер временного окна сбора статистики.
-`Write speed`|Скорость записи сообщений (сообщений/с и Мбайт/с).
-`Write time`|99 перцентиль времени записи сообщения (мс).
-`Inflight`|Максимальное число сообщений, ожидающих подтверждения по всем партициям (сообщений).
-`Lag`|Максимальная задержка сообщений по всем партициям (сообщений). Число сообщений, ожидающих чтения.
-`Lag time`|99 перцентиль времени задержки сообщений (мс).
-`Read`|Скорость чтения сообщений читателем (сообщений/с и Мбайт/с).
-`Full time`|99 перцентиль времени полной обработки сообщения, от записи писателем до чтения читателем (мс).
+>Чтобы удалить тестовый топик `workload-topic`, выполните следующую команду:
+>
+>```bash
+>{{ ydb-cli }} --profile quickstart workload topic clean
+>```