Skip to content

Docs: fix --warmup option name for topic workload command #2483

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

Merged
merged 2 commits into from
Mar 12, 2024
Merged
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
6 changes: 3 additions & 3 deletions ydb/docs/en/core/reference/ydb-cli/workload-topic.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Subcommand options:
| `--window`, `-w` | Statistics window in seconds.<br>Default value: `1`. |
| `--quiet`, `-q` | Output only the final test result. |
| `--print-timestamp` | Print the time together with the statistics of each time window. |
| `--warmup-time` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
| `--warmup` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
| `--percentile` | Percentile that is output in statistics.<br>Default value: `50`. |
| `--topic` | Topic name.<br>Default value: `workload-topic`. |
| `--threads`, `-t` | Number of producer threads.<br>Default value: `1`. |
Expand Down Expand Up @@ -134,7 +134,7 @@ Subcommand options:
| `--window`, `-w` | Statistics window in seconds.<br>Default value: `1`. |
| `--quiet`, `-q` | Output only the final test result. |
| `--print-timestamp` | Print the time together with the statistics of each time window. |
| `--warmup-time` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
| `--warmup` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
| `--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`. |
Expand Down Expand Up @@ -200,7 +200,7 @@ Subcommand options:
| `--window`, `-w` | Statistics window in seconds.<br>Default value: `1`. |
| `--quiet`, `-q` | Output only the final test result. |
| `--print-timestamp` | Print the time together with the statistics of each time window. |
| `--warmup-time` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
| `--warmup` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
| `--percentile` | Percentile that is output in statistics.<br>Default value: `50`. |
| `--topic` | Topic name.<br>Default value: `workload-topic`. |
| `--producer-threads`, `-p` | Number of producer threads.<br>Default value: `1`. |
Expand Down
6 changes: 3 additions & 3 deletions ydb/docs/ru/core/reference/ydb-cli/workload-topic.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
`--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
`--quiet`, `-q` | Выводить только итоговый результат теста.
`--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
`--warmup-time` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
`--warmup` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
`--threads`, `-t` | Количество потоков писателя.<br>Значение по умолчанию: `1`.
Expand Down Expand Up @@ -134,7 +134,7 @@
`--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
`--quiet`, `-q` | Выводить только итоговый результат теста.
`--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
`--warmup-time` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
`--warmup` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
`--consumers`, `-c` | Количество читателей.<br>Значение по умолчанию: `1`.
Expand Down Expand Up @@ -200,7 +200,7 @@
`--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
`--quiet`, `-q` | Выводить только итоговый результат теста.
`--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
`--warmup-time` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
`--warmup` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
`--producer-threads`, `-p` | Количество потоков писателя.<br>Значение по умолчанию: `1`.
Expand Down