New parameters: warm-uptime, percentile, topic

1 files changed, 57 insertions, 41 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 5e8be0d177a..1f5425b00f6 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/workload-topic.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/workload-topic.md
@@ -29,6 +29,7 @@
 
 Имя параметра | Описание параметра
 ---|---
+`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
 `--partitions`, `-p` | Количество партиций топика.<br>Значение по умолчанию: `128`.
 `--consumers`, `-c` | Количество читателей топика.<br>Значение по умолчанию: `1`.
 
@@ -61,10 +62,13 @@
 
 Имя параметра | Описание параметра
 ---|---
-`--seconds`, `-s` | Продолжительность теста в секундах.<br>Значение по умолчанию: `10`.
+`--seconds`, `-s` | Продолжительность теста в секундах.<br>Значение по умолчанию: `60`.
 `--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
 `--quiet`, `-q` | Выводить только итоговый результат теста.
 `--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
+`--warmup-time` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
+`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
+`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
 `--threads`, `-t` | Количество потоков писателя.<br>Значение по умолчанию: `1`.
 `--message-size`, `-m` | Размер сообщения в байтах. Возможно задание в КБ, МБ, ГБ путем добавления суффиксов `K`, `M`, `G` соответственно.<br>Значение по умолчанию: `10K`.
 `--message-rate` | Целевая суммарная скорость записи, сообщений в секунду. Исключает использование параметра `--byte-rate`.<br>Значение по умолчанию: `0` (нет ограничения).
@@ -81,7 +85,7 @@
 >
 >```text
 >Window  Write speed     Write time      Inflight
->#       msg/s   MB/s    P99(ms)         max msg
+>#       msg/s   MB/s    percentile,ms   percentile,msg
 >1       20      0       1079            72
 >2       8025    78      1415            78
 >3       7987    78      1431            79
@@ -93,13 +97,13 @@
 >9       7062    69      1455            79
 >10      9912    96      3679            250
 >Window  Write speed     Write time      Inflight
->#       msg/s   MB/s    P99(ms)         max msg
+>#       msg/s   MB/s    percentile,ms   percentile,msg
 >Total   7203    70      3023            250
 >```
 >
 >* `Window` — порядковый номер временного окна сбора статистики;
 >* `Write speed` — скорость записи сообщений, сообщений в секунду и МБ/с;
->* `Write time` — 99 перцентиль времени записи сообщения, мс.
+>* `Write time` — процентиль времени записи сообщения, мс.
 >* `Inflight` — максимальное число сообщений, ожидающих подтверждения по всем партициям.
 
 ## Нагрузка на чтение {#run-read}
@@ -125,10 +129,13 @@
 
 Имя параметра | Описание параметра
 ---|---
-`--seconds`, `-s` | Продолжительность теста в секундах.<br>Значение по умолчанию: `10`.
+`--seconds`, `-s` | Продолжительность теста в секундах.<br>Значение по умолчанию: `60`.
 `--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
 `--quiet`, `-q` | Выводить только итоговый результат теста.
 `--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
+`--warmup-time` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
+`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
+`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
 `--consumers`, `-c` | Количество читателей.<br>Значение по умолчанию: `1`.
 `--threads`, `-t` | Количество потоков читателя.<br>Значение по умолчанию: `1`.
 
@@ -141,28 +148,28 @@
 >В процессе работы будет выводиться статистика по промежуточным временным окнам, а по окончании теста — итоговая статистика за все время работы:
 >
 >```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        Read speed      Full time
+>#       percentile,msg  percentile,ms   msg/s   MB/s    percentile,ms
+>1       0               0               0       0       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
+>#       percentile,msg  percentile,ms   msg/s   MB/s    percentile,ms
+>Total   30176           0               80267   784     0
 >```
 >
 >* `Window` — порядковый номер временного окна сбора статистики.
 >* `Lag` — максимальное в окне сбора статистики отставание читателя. Учитываются сообщения по всем партициям.
->* `Lag time` — 99 перцентиль времени задержки сообщений в мс.
+>* `Lag time` — процентиль времени задержки сообщений в мс.
 >* `Read` — Скорость чтения сообщений читателем, сообщений в секунду и МБ/с.
->* `Full time` — 99 перцентиль времени полной обработки сообщения (от записи писателем до чтения читателем) в мс.
+>* `Full time` — процентиль времени полной обработки сообщения (от записи писателем до чтения читателем) в мс.
 
 ## Нагрузка на чтение и запись {#run-full}
 
@@ -187,10 +194,13 @@
 
 Имя параметра | Описание параметра
 ---|---
-`--seconds`, `-s` | Продолжительность теста в секундах.<br>Значение по умолчанию: `10`.
+`--seconds`, `-s` | Продолжительность теста в секундах.<br>Значение по умолчанию: `60`.
 `--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
 `--quiet`, `-q` | Выводить только итоговый результат теста.
 `--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
+`--warmup-time` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
+`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
+`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
 `--producer-threads`, `-p` | Количество потоков писателя.<br>Значение по умолчанию: `1`.
 `--message-size`, `-m` | Размер сообщения в байтах. Возможно задание в КБ, МБ, ГБ путем добавления суффиксов `K`, `M`, `G` соответственно.<br>Значение по умолчанию: `10K`.
 `--message-rate` | Целевая суммарная скорость записи, сообщений в секунду. Исключает использование параметра `--message-rate`.<br>Значение по умолчанию: `0` (нет ограничения).
@@ -208,31 +218,31 @@
 >В процессе работы будет выводиться статистика по промежуточным временным окнам, а по окончании теста — итоговая статистика за все время работы:
 >
 >```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      Inflight        Lag             Lag time        Read speed      Full time
+>#       msg/s   MB/s    percentile,ms   percentile,msg  percentile,msg  percentile,ms   msg/s   MB/s    percentile,ms
+>1       0       0       0               0               0               0               0       0       0
+>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    percentile,ms   percentile,msg  percentile,msg  percentile,ms   msg/s   MB/s    percentile,ms
+>Total   1814    17      5247            22              12150           28671           44827   438     40252
 >```
 >
 >* `Window` — порядковый номер временного окна сбора статистики.
 >* `Write speed` — скорость записи сообщений, сообщений в секунду и МБ/с.
->* `Write time` — 99 перцентиль времени записи сообщения в мс.
+>* `Write time` — процентиль времени записи сообщения в мс.
 >* `Inflight` — максимальное число сообщений, ожидающих подтверждения по всем партициям.
 >* `Lag` — максимальное число сообщений, ожидающих чтения, в окне сбора статистики. Учитываются сообщения по всем партициям.
->* `Lag time` — 99 перцентиль времени задержки сообщений в мс.
+>* `Lag time` — процентиль времени задержки сообщений в мс.
 >* `Read` — Скорость чтения сообщений читателем, сообщений в секунду и МБ/с.
->* `Full time` — 99 перцентиль времени полной обработки сообщения, от записи писателем до чтения читателем в мс.
+>* `Full time` — процентиль времени полной обработки сообщения, от записи писателем до чтения читателем в мс.
 
 ## Удаление топика {#clean}
 
@@ -245,6 +255,12 @@
 * `global options` — [глобальные параметры](commands/global-options.md).
 * `options` — параметры подкоманды.
 
+Параметры подкоманды:
+
+Имя параметра | Описание параметра
+---|---
+`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
+
 >Чтобы удалить тестовый топик `workload-topic`, выполните следующую команду:
 >
 >```bash