Skip to content

[docs] Add subcommands in workload-transfer #1462

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 8 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
8 changes: 6 additions & 2 deletions ydb/docs/en/core/reference/ydb-cli/workload-transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,12 @@ Parameter name | Parameter Description | Default value
`--consumer-threads`, `-t` | Number of consumer threads | `1`
`--consumers`, `-c` | Number of consumers | `1`
`--message-size`, `-m` | Message size in bytes. It is possible to specify in KB, MB, GB by adding suffixes `K`, `M`, `G` respectively | `10240`
`--message-rate` | Target total write speed. In messages per second. Excludes the use of the `--byte-rate` | `0` parameter
`--byte-rate` | Target total write speed. In bytes per second. Excludes the use of the --message-rate parameter. It is possible to specify in KB/s, MB/s, GB/s by adding suffixes `K`, `M`, `G` respectively | `0`
`--message-rate` | Target total write speed. In messages per second. Excludes the use of the `--byte-rate` parameter | `0`
`--byte-rate` | Target total write speed. In bytes per second. Excludes the use of the `--message-rate` parameter. It is possible to specify in KB/s, MB/s, GB/s by adding suffixes `K`, `M`, `G` respectively | `0`
`--commit-period` | The period between `COMMIT` calls. In seconds | `10`
`--commit-messages` | The period between `COMMIT` calls. Number of messages | `1000000`
`--only-topic-in-tx` | Only topic partitions are forced to participate in transactions Excludes the use of the `--only-table-in-tx` parameter | `0`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A point symbol is missed befor "Excludes".
"in transactions Excludes"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A point symbol is missed befor "Excludes". "in transactions Excludes"

`--only-table-in-tx` | Only table shards are forced to participate in transactions. Excludes the use of the `--only-topic-in-tx` parameter | `0`

For example, the command `{{ ydb-cli }} --profile quickstart workload transfer topic-to-table run` will run a test lasting 60 seconds. The data for the first 5 seconds will not be taken into account in the work statistics. Example of console output:

Expand Down Expand Up @@ -112,6 +115,7 @@ Window Write speed Write time Inflight Lag Lag time
* `Lag` — the specified percentile of maximum number of messages waiting to be read in the statistics collection window. Messages for all batches are taken into account.
* `Lag time` — the specified percentile of message delay time in ms.
* `Read speed` — the speed of reading messages by consumers. In messages per second and in megabytes per second.
* `Select time`, `Upsert time`, `Commit time` — the specified percentile of the execution time of Select, Insert, Commit operations in ms.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't see this columns in the table above. It may be OK, just noticed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't see this columns in the table above. It may be OK, just noticed.

* `Full time` — the specified percentile of the time of complete processing of the message, from writing by the producer to reading by the consumer in ms.

## Removing the test environment {#clean}
Expand Down
8 changes: 6 additions & 2 deletions ydb/docs/ru/core/reference/ydb-cli/workload-transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,11 @@
`--consumers`, `-c` | Количество читателей | `1`
`--message-size`, `-m` | Размер сообщения в байтах. Возможно задание в КБ, МБ, ГБ путем добавления суффиксов `K`, `M`, `G` соответственно | `10240`
`--message-rate` | Целевая суммарная скорость записи. В сообщениях в секунду. Исключает использование параметра `--byte-rate` | `0`
`--byte-rate` | Целевая суммарная скорость записи. В байтах в секунду. Исключает использование параметра --message-rate. Возможно задание в КБ/с, МБ/с, ГБ/с путем добавления суффиксов `K`, `M`, `G` соответственно | `0`
`--commit-period` | Период между вызовами `COMMIT`. В секундах | `10`
`--byte-rate` | Целевая суммарная скорость записи. В байтах в секунду. Исключает использование параметра `--message-rate`. Возможно задание в КБ/с, МБ/с, ГБ/с путем добавления суффиксов `K`, `M`, `G` соответственно | `0`
`--commit-period` | Период между вызовами `COMMIT`. В секундах | `10`
`--commit-messages` | Период между вызовами `COMMIT`. Количество сообщений | `1000000`
`--only-topic-in-tx` | В транзакциях принудительно участвуют только партиции топиков. Исключает использование параметра `--only-table-in-tx` | `0`
`--only-table-in-tx` | В транзакциях принудительно участвуют только шарды таблиц. Исключает использование параметра `--only-topic-in-tx` | `0`

Например, команда
```bash
Expand Down Expand Up @@ -120,6 +123,7 @@ Window Write speed Write time Inflight Lag Lag time
* `Lag` — максимальное число сообщений, ожидающих чтения, в окне сбора статистики. Учитываются сообщения по всем партициям.
* `Lag time` — процентиль времени задержки сообщений в мс.
* `Read speed` — скорость чтения сообщений читателями. В сообщениях в секунду и в мегабайтах в секунду.
* `Select time`, `Upsert time`, `Commit time` — процентиль времени выполнения операций Select, Upsert, Commit в мс.
* `Full time` — процентиль времени полной обработки сообщения, от записи писателем до чтения читателем в мс.

## Удаление тестового окружения {#clean}
Expand Down