Skip to content

Commit 75f69cf

Browse files
JornydbJornydb
authored
[docs] Add subcommands in workload-transfer (#1462)
1 parent ab6bbc4 commit 75f69cf

File tree

2 files changed

+52
-44
lines changed

2 files changed

+52
-44
lines changed

‎ydb/docs/en/core/reference/ydb-cli/workload-transfer.md

+26-22
Original file line numberDiff line numberDiff line change
@@ -76,32 +76,35 @@ Parameter name | Parameter Description | Default value
7676
`--consumer-threads`, `-t` | Number of consumer threads | `1`
7777
`--consumers`, `-c` | Number of consumers | `1`
7878
`--message-size`, `-m` | Message size in bytes. It is possible to specify in KB, MB, GB by adding suffixes `K`, `M`, `G` respectively | `10240`
79-
`--message-rate` | Target total write speed. In messages per second. Excludes the use of the `--byte-rate` | `0` parameter
80-
`--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`
79+
`--message-rate` | Target total write speed. In messages per second. Excludes the use of the `--byte-rate` parameter | `0`
80+
`--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`
8181
`--commit-period` | The period between `COMMIT` calls. In seconds | `10`
82+
`--commit-messages` | The period between `COMMIT` calls. In number of messages | `1000000`
83+
`--only-topic-in-tx` | Only topic partitions are forced to participate in transactions. Excludes the use of the `--only-table-in-tx` parameter | `0`
84+
`--only-table-in-tx` | Only table shards are forced to participate in transactions. Excludes the use of the `--only-topic-in-tx` parameter | `0`
8285

8386
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:
8487

8588
```text
86-
Window Write speed Write time Inflight Lag Lag time Read speed Full time
87-
# msg/s MB/s percentile,ms percentile,msg percentile,msg percentile,ms msg/s MB/s percentile,ms
88-
1 0 0 0 0 0 0 0 0 0
89-
2 0 0 0 0 0 0 0 0 0
90-
3 0 0 0 0 0 0 0 0 0
91-
4 0 0 0 0 0 0 0 0 0
92-
5 0 0 0 0 0 0 0 0 0
93-
6 103 1 911 78 0 0 103 1 914
94-
7 103 1 983 78 0 0 103 1 984
95-
8 103 1 1103 80 0 0 103 1 1106
96-
9 103 1 1003 85 0 0 103 1 1004
97-
10 103 1 1003 86 0 0 103 1 1006
98-
11 103 1 1015 85 0 0 103 1 1019
99-
12 103 1 1047 91 0 0 103 1 1043
100-
13 103 1 999 88 0 0 103 1 1003
101-
14 103 1 1063 85 0 0 103 1 1064
102-
15 103 1 1003 89 0 0 103 1 1008
103-
16 103 1 999 88 0 0 103 1 1003
104-
17 103 1 1071 78 0 0 103 1 1077
89+
Window Write speed Write time Inflight Read speed Topic time Select time Upsert time Commit time
90+
# msg/s MB/s percentile,ms percentile,msg msg/s MB/s percentile,ms percentile,ms percentile,ms percentile,ms
91+
1 0 0 0 0 0 0 0 0 0 0
92+
2 0 0 0 0 0 0 0 0 0 0
93+
3 0 0 0 0 0 0 0 0 0 0
94+
4 0 0 0 0 0 0 0 0 0 0
95+
5 0 0 0 0 0 0 0 0 0 0
96+
6 103 1 1023 83 103 1 1025 0 0 0
97+
7 103 1 999 78 103 1 1001 0 0 0
98+
8 103 1 1003 93 103 1 1002 0 0 0
99+
9 103 1 1003 88 103 1 1003 0 0 0
100+
10 103 1 999 79 103 1 999 0 0 0
101+
11 103 1 1119 89 0 0 0 0 0 0
102+
12 103 1 1023 90 206 2 1028 90 223 695
103+
13 103 1 975 84 103 1 976 0 0 0
104+
14 103 1 1003 91 103 1 1006 0 0 0
105+
15 103 1 1003 93 103 1 1005 0 0 0
106+
16 103 1 1103 89 103 1 1100 0 0 0
107+
17 103 1 1063 89 103 1 1061 0 0 0
105108
...
106109
```
107110

@@ -112,7 +115,8 @@ Window Write speed Write time Inflight Lag Lag time
112115
* `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.
113116
* `Lag time` — the specified percentile of message delay time in ms.
114117
* `Read speed` — the speed of reading messages by consumers. In messages per second and in megabytes per second.
115-
* `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.
118+
* `Select time`, `Upsert time`, `Commit time` — the specified percentile of the execution time of Select, Insert, Commit operations in ms.
119+
<!-- * `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. -->
116120

117121
## Removing the test environment {#clean}
118122

‎ydb/docs/ru/core/reference/ydb-cli/workload-transfer.md

+26-22
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,11 @@
8181
`--consumers`, `-c` | Количество читателей | `1`
8282
`--message-size`, `-m` | Размер сообщения в байтах. Возможно задание в КБ, МБ, ГБ путем добавления суффиксов `K`, `M`, `G` соответственно | `10240`
8383
`--message-rate` | Целевая суммарная скорость записи. В сообщениях в секунду. Исключает использование параметра `--byte-rate` | `0`
84-
`--byte-rate` | Целевая суммарная скорость записи. В байтах в секунду. Исключает использование параметра --message-rate. Возможно задание в КБ/с, МБ/с, ГБ/с путем добавления суффиксов `K`, `M`, `G` соответственно | `0`
85-
`--commit-period` | Период между вызовами `COMMIT`. В секундах | `10`
84+
`--byte-rate` | Целевая суммарная скорость записи. В байтах в секунду. Исключает использование параметра `--message-rate`. Возможно задание в КБ/с, МБ/с, ГБ/с путем добавления суффиксов `K`, `M`, `G`, соответственно | `0`
85+
`--commit-period` | Период между вызовами `COMMIT`. В секундах | `10`
86+
`--commit-messages` | Период между вызовами `COMMIT`. В количестве сообщений | `1000000`
87+
`--only-topic-in-tx` | В транзакциях принудительно участвуют только партиции топиков. Исключает использование параметра `--only-table-in-tx` | `0`
88+
`--only-table-in-tx` | В транзакциях принудительно участвуют только шарды таблиц. Исключает использование параметра `--only-topic-in-tx` | `0`
8689

8790
Например, команда
8891
```bash
@@ -91,25 +94,25 @@
9194
запустит тест продолжительностью 60 секунд. Данные за первые 5 секунд не будут учитываться в статистике работы. Пример вывода на консоль
9295

9396
```text
94-
Window Write speed Write time Inflight Lag Lag time Read speed Full time
95-
# msg/s MB/s percentile,ms percentile,msg percentile,msg percentile,ms msg/s MB/s percentile,ms
96-
1 0 0 0 0 0 0 0 0 0
97-
2 0 0 0 0 0 0 0 0 0
98-
3 0 0 0 0 0 0 0 0 0
99-
4 0 0 0 0 0 0 0 0 0
100-
5 0 0 0 0 0 0 0 0 0
101-
6 103 1 911 78 0 0 103 1 914
102-
7 103 1 983 78 0 0 103 1 984
103-
8 103 1 1103 80 0 0 103 1 1106
104-
9 103 1 1003 85 0 0 103 1 1004
105-
10 103 1 1003 86 0 0 103 1 1006
106-
11 103 1 1015 85 0 0 103 1 1019
107-
12 103 1 1047 91 0 0 103 1 1043
108-
13 103 1 999 88 0 0 103 1 1003
109-
14 103 1 1063 85 0 0 103 1 1064
110-
15 103 1 1003 89 0 0 103 1 1008
111-
16 103 1 999 88 0 0 103 1 1003
112-
17 103 1 1071 78 0 0 103 1 1077
97+
Window Write speed Write time Inflight Read speed Topic time Select time Upsert time Commit time
98+
# msg/s MB/s percentile,ms percentile,msg msg/s MB/s percentile,ms percentile,ms percentile,ms percentile,ms
99+
1 0 0 0 0 0 0 0 0 0 0
100+
2 0 0 0 0 0 0 0 0 0 0
101+
3 0 0 0 0 0 0 0 0 0 0
102+
4 0 0 0 0 0 0 0 0 0 0
103+
5 0 0 0 0 0 0 0 0 0 0
104+
6 103 1 1023 83 103 1 1025 0 0 0
105+
7 103 1 999 78 103 1 1001 0 0 0
106+
8 103 1 1003 93 103 1 1002 0 0 0
107+
9 103 1 1003 88 103 1 1003 0 0 0
108+
10 103 1 999 79 103 1 999 0 0 0
109+
11 103 1 1119 89 0 0 0 0 0 0
110+
12 103 1 1023 90 206 2 1028 90 223 695
111+
13 103 1 975 84 103 1 976 0 0 0
112+
14 103 1 1003 91 103 1 1006 0 0 0
113+
15 103 1 1003 93 103 1 1005 0 0 0
114+
16 103 1 1103 89 103 1 1100 0 0 0
115+
17 103 1 1063 89 103 1 1061 0 0 0
113116
...
114117
```
115118

@@ -120,7 +123,8 @@ Window Write speed Write time Inflight Lag Lag time
120123
* `Lag` — максимальное число сообщений, ожидающих чтения, в окне сбора статистики. Учитываются сообщения по всем партициям.
121124
* `Lag time` — процентиль времени задержки сообщений в мс.
122125
* `Read speed` — скорость чтения сообщений читателями. В сообщениях в секунду и в мегабайтах в секунду.
123-
* `Full time` — процентиль времени полной обработки сообщения, от записи писателем до чтения читателем в мс.
126+
* `Select time`, `Upsert time`, `Commit time` — процентиль времени выполнения операций Select, Upsert, Commit в мс.
127+
<!-- * `Full time` — процентиль времени полной обработки сообщения, от записи писателем до чтения читателем в мс. -->
124128

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

0 commit comments

Comments
 (0)