Skip to content

Commit 14dc3bc

Browse files
LeavrthLeavrth
authored
br: improve visualization of BR (#20025)
1 parent 8d853ce commit 14dc3bc

File tree

5 files changed

+36
-9
lines changed

5 files changed

+36
-9
lines changed

‎br/backup-and-restore-use-cases.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,9 @@ tiup br restore point --pd="${PD_IP}:2379" \
141141
--full-backup-storage='s3://tidb-pitr-bucket/backup-data/snapshot-20220514000000' \
142142
--restored-ts '2022-05-15 18:00:00+0800'
143143
144-
Full Restore <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
144+
Split&Scatter Region <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
145+
Download&Ingest SST <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
146+
Restore Pipeline <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
145147
[2022/05/29 18:15:39.132 +08:00] [INFO] [collector.go:69] ["Full Restore success summary"] [total-ranges=12] [ranges-succeed=xxx] [ranges-failed=0] [split-region=xxx.xxxµs] [restore-ranges=xxx] [total-take=xxx.xxxs] [restore-data-size(after-compressed)=xxx.xxx] [Size=xxxx] [BackupTS={TS}] [total-kv=xxx] [total-kv-size=xxx] [average-speed=xxx]
146148
Restore Meta Files <--------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
147149
Restore KV Files <----------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%

‎br/br-pitr-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,9 @@ tiup br restore point --pd "${PD_IP}:2379" \
6969
恢复期间，可通过终端中的进度条查看进度，如下。恢复分为两个阶段：全量恢复 (Full Restore) 和日志恢复（Restore Meta Files 和 Restore KV Files）。每个阶段完成恢复后，br 命令行工具都会输出恢复耗时和恢复数据大小等信息。
7070

7171
```shell
72-
Full Restore <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
72+
Split&Scatter Region <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
73+
Download&Ingest SST <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
74+
Restore Pipeline <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
7375
*** ["Full Restore success summary"] ****** [total-take=xxx.xxxs] [restore-data-size(after-compressed)=xxx.xxx] [Size=xxxx] [BackupTS={TS}] [total-kv=xxx] [total-kv-size=xxx] [average-speed=xxx]
7476
Restore Meta Files <--------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
7577
Restore KV Files <----------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%

‎br/br-pitr-manual.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,9 @@ tiup br restore point --pd="${PD_IP}:2379"
453453
--storage='s3://backup-101/logbackup?access-key=${access-key}&secret-access-key=${secret-access-key}'
454454
--full-backup-storage='s3://backup-101/snapshot-202205120000?access-key=${access-key}&secret-access-key=${secret-access-key}'
455455

456-
Full Restore <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
456+
Split&Scatter Region <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
457+
Download&Ingest SST <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
458+
Restore Pipeline <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
457459
*** ***["Full Restore success summary"] ****** [total-take=3.112928252s] [restore-data-size(after-compressed)=5.056kB] [Size=5056] [BackupTS=434693927394607136] [total-kv=4] [total-kv-size=290B] [average-speed=93.16B/s]
458460
Restore Meta Files <--------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
459461
Restore KV Files <----------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%

‎br/br-snapshot-guide.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,19 @@ tiup br backup full --pd "${PD_IP}:2379" \
3737
- `--storage`：数据备份到的存储地址。快照备份支持以 Amazon S3、Google Cloud Storage、Azure Blob Storage 为备份存储，以上命令以 Amazon S3 为示例。详细存储地址格式请参考[外部存储服务的 URI 格式](/external-storage-uri.md)。
3838
- `--ratelimit`：**每个 TiKV** 备份数据的速度上限，单位为 MiB/s。
3939

40-
在快照备份过程中，终端会显示备份进度条。在备份完成后，会输出备份耗时、速度、备份数据大小等信息。
40+
在快照备份过程中，终端会显示备份进度条。在备份完成后，会输出备份耗时、速度、备份数据大小等信息。其中：
41+
42+
- `total-ranges`：备份的文件总数量
43+
- `ranges-succeed`：备份成功的文件数量
44+
- `ranges-failed`：备份失败的文件数量
45+
- `backup-total-ranges`：备份的表（包括分区表）与索引的数量
46+
- `write-CF-files`：备份文件中含有 `write CF` 数据的 SST 文件数量
47+
- `default-CF-files`：备份文件中含有 `default CF` 数据的 SST 文件数量
4148

4249
```shell
4350
Full Backup <-------------------------------------------------------------------------------> 100.00%
4451
Checksum <----------------------------------------------------------------------------------> 100.00%
45-
*** ["Full Backup success summary"] *** [backup-checksum=3.597416ms] [backup-fast-checksum=2.36975ms] *** [total-take=4.715509333s] [BackupTS=435844546560000000] [total-kv=1131] [total-kv-size=250kB] [average-speed=53.02kB/s] [backup-data-size(after-compressed)=71.33kB] [Size=71330]
52+
*** ["Full Backup success summary"] *** [total-ranges=20] [ranges-succeed=20] [ranges-failed=0] [backup-checksum=3.597416ms] [backup-fast-checksum=2.36975ms] [backup-total-ranges=11] [backup-total-regions=10] [write-CF-files=14] [default-CF-files=6] [total-take=4.715509333s] [BackupTS=435844546560000000] [total-kv=1131] [total-kv-size=250kB] [average-speed=53.02kB/s] [backup-data-size(after-compressed)=71.33kB] [Size=71330]
4653
```
4754

4855
## 查询快照备份的时间点信息
@@ -79,11 +86,23 @@ tiup br restore full --pd "${PD_IP}:2379" \
7986
--storage "s3://backup-101/snapshot-202209081330?access-key=${access-key}&secret-access-key=${secret-access-key}"
8087
```
8188

82-
在恢复快照备份数据过程中，终端会显示恢复进度条。在完成恢复后，会输出恢复耗时、速度、恢复数据大小等信息。
89+
在恢复快照备份数据过程中，终端会显示恢复进度条。在完成恢复后，会输出恢复耗时、速度、恢复数据大小等信息。其中：
90+
91+
- `total-ranges`：恢复的文件总数量
92+
- `ranges-succeed`：恢复成功的文件数量
93+
- `ranges-failed`：恢复失败的文件数量
94+
- `merge-ranges`：合并数据范围的耗时
95+
- `split-region`：切分和打散 Region 的耗时
96+
- `restore-files`： TiKV 恢复 SST 文件的耗时
97+
- `write-CF-files`：恢复文件中含有 `write CF` 数据的 SST 文件数量
98+
- `default-CF-files`：恢复文件中含有 `default CF` 数据的 SST 文件数量
99+
- `split-keys`：生成的用于切分 Region 的 key 数量
83100

84101
```shell
85-
Full Restore <------------------------------------------------------------------------------> 100.00%
86-
*** ["Full Restore success summary"] *** [total-take=4.344617542s] [total-kv=5] [total-kv-size=327B] [average-speed=75.27B/s] [restore-data-size(after-compressed)=4.813kB] [Size=4813] [BackupTS=435844901803917314]
102+
Split&Scatter Region <--------------------------------------------------------------------> 100.00%
103+
Download&Ingest SST <---------------------------------------------------------------------> 100.00%
104+
Restore Pipeline <------------------------------------------------------------------------> 100.00%
105+
*** ["Full Restore success summary"] [total-ranges=20] [ranges-succeed=20] [ranges-failed=0] [merge-ranges=7.546971ms] [split-region=343.594072ms] [restore-files=1.57662s] [default-CF-files=6] [write-CF-files=14] [split-keys=9] [total-take=4.344617542s] [total-kv=5] [total-kv-size=327B] [average-speed=75.27B/s] [restore-data-size(after-compressed)=4.813kB] [Size=4813] [BackupTS=435844901803917314]
87106
```
88107

89108
### 恢复备份数据中指定库表的数据

‎br/br-snapshot-manual.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,9 @@ tiup br restore full \
181181
恢复期间终端会显示进度条，效果如下。当进度条达到 100% 时，表示恢复完成。在完成恢复后，br 工具为了确保数据安全性，还会校验恢复数据。
182182

183183
```shell
184-
Full Restore <---------/...............................................> 17.12%.
184+
Split&Scatter Region <--------------------------------------------------------------------> 100.00%
185+
Download&Ingest SST <---------------------------------------------------------------------> 100.00%
186+
Restore Pipeline <-------------------------/...............................................> 17.12%
185187
```
186188

187189
## 恢复备份数据中指定库表的数据

0 commit comments

Comments
 (0)