Skip to content

Commit

Permalink
ticdc: adjust TOC and reorganize troubleshooting & faq (#9945) (#10166)
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Jun 27, 2022
1 parent 6f4daea commit 62fb6bb
Show file tree
Hide file tree
Showing 11 changed files with 292 additions and 274 deletions.
19 changes: 11 additions & 8 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -484,14 +484,17 @@
- [概述](/ticdc/ticdc-overview.md)
- [安装部署](/ticdc/deploy-ticdc.md)
- [运维管理](/ticdc/manage-ticdc.md)
- [故障诊断](/ticdc/troubleshoot-ticdc.md)
- [监控指标](/ticdc/monitor-ticdc.md)
- [报警规则](/ticdc/ticdc-alert-rules.md)
- [TiCDC Open API](/ticdc/ticdc-open-api.md)
- [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md)
- [TiCDC Canal-JSON Protocol](/ticdc/ticdc-canal-json.md)
- [TiCDC Avro Protocol](/ticdc/ticdc-avro-protocol.md)
- [将 TiDB 集成到 Confluent Platform](/ticdc/integrate-confluent-using-ticdc.md)
- 监控告警
- [监控指标](/ticdc/monitor-ticdc.md)
- [报警规则](/ticdc/ticdc-alert-rules.md)
- [故障处理](/ticdc/troubleshoot-ticdc.md)
- 参考指南
- [TiCDC Open API](/ticdc/ticdc-open-api.md)
- [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md)
- [TiCDC Avro Protocol](/ticdc/ticdc-avro-protocol.md)
- [TiCDC Canal-JSON Protocol](/ticdc/ticdc-canal-json.md)
- [将 TiDB 集成到 Confluent Platform](/ticdc/integrate-confluent-using-ticdc.md)
- [常见问题解答](/ticdc/ticdc-faq.md)
- [术语表](/ticdc/ticdc-glossary.md)
- TiUniManager
- [概述](/tiunimanager/tiunimanager-overview.md)
Expand Down
2 changes: 1 addition & 1 deletion _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ summary: 了解 TiDB 数据库。
- [SQL 诊断](/information-schema/information-schema-sql-diagnostics.md)
- [热点问题处理](/troubleshoot-hot-spot-issues.md)
- [磁盘 I/O 过高](/troubleshoot-high-disk-io.md)
- [TiCDC 常见问题](/ticdc/troubleshoot-ticdc.md)
- [TiCDC 故障处理](/ticdc/troubleshoot-ticdc.md)
- [TiFlash 常见问题](/tiflash/troubleshoot-tiflash.md)

</NavColumn>
Expand Down
2 changes: 1 addition & 1 deletion faq/migration-tidb-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ summary: 介绍 TiDB 迁移中的常见问题。
- [TiDB Binlog 常见问题](/tidb-binlog/tidb-binlog-faq.md)
- [TiDB Lightning 常见问题](/tidb-lightning/tidb-lightning-faq.md)
- [Data Migration 常见问题](/dm/dm-faq.md)
- [TiCDC 常见问题和故障处理](/ticdc/troubleshoot-ticdc.md)
- [TiCDC 常见问题](/ticdc/ticdc-faq.md)

## 全量数据导出导入

Expand Down
2 changes: 1 addition & 1 deletion migrate-from-tidb-to-tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ aliases: ['/zh/tidb/stable/incremental-replication-between-clusters/']

3. 重新开启 GC。

TiCDC 可以保证 GC 只回收已经同步的历史数据。因此,创建完从上游到下游集群的 changefeed 之后,就可以执行如下命令恢复集群的垃圾回收功能。详情请参考 [TiCDC GC safepoint 的完整行为](/ticdc/troubleshoot-ticdc.md#ticdc-gc-safepoint-的完整行为是什么)。
TiCDC 可以保证 GC 只回收已经同步的历史数据。因此,创建完从上游到下游集群的 changefeed 之后,就可以执行如下命令恢复集群的垃圾回收功能。详情请参考 [TiCDC GC safepoint 的完整行为](/ticdc/ticdc-faq.md#ticdc-gc-safepoint-的完整行为是什么)。

{{< copyable "sql" >}}

Expand Down
3 changes: 2 additions & 1 deletion production-deployment-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -448,4 +448,5 @@ tiup cluster display tidb-test
如果你已同时部署了 [TiCDC](/ticdc/ticdc-overview.md),接下来可参阅以下文档:

- [TiCDC 任务管理](/ticdc/manage-ticdc.md)
- [TiCDC 常见问题](/ticdc/troubleshoot-ticdc.md)
- [TiCDC 故障处理](/ticdc/troubleshoot-ticdc.md)
- [TiCDC 常见问题](/ticdc/ticdc-faq.md)
2 changes: 1 addition & 1 deletion replicate-between-primary-and-secondary-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ summary: 了解如何配置一个 TiDB 集群以及该集群的 TiDB 或 MySQL

3. 重新开启 GC。

TiCDC 可以保证未同步的历史数据不会被回收。因此,创建完从上游到下游集群的 changefeed 之后,就可以执行如下命令恢复集群的垃圾回收功能。详情请参考 [TiCDC GC safepoint 的完整行为](/ticdc/troubleshoot-ticdc.md#ticdc-gc-safepoint-的完整行为是什么)。
TiCDC 可以保证未同步的历史数据不会被回收。因此,创建完从上游到下游集群的 changefeed 之后,就可以执行如下命令恢复集群的垃圾回收功能。详情请参考 [TiCDC GC safepoint 的完整行为](/ticdc/ticdc-faq.md#ticdc-gc-safepoint-的完整行为是什么)。

{{< copyable "sql" >}}

Expand Down
2 changes: 1 addition & 1 deletion ticdc/deploy-ticdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ cdc server --pd=http://10.0.10.25:2379 --log-file=ticdc_3.log --addr=0.0.0.0:830
- `pd`:TiCDC 监听的 PD 节点地址,用 `,` 来分隔多个 PD 节点地址。
- `config`:可选项,表示 TiCDC 使用的配置文件地址。TiCDC 从 v5.0.0 开始支持该选项,TiUP 从 v1.4.0 开始支持在部署 TiCDC 时使用该配置。
- `data-dir`:指定 TiCDC 使用磁盘储存文件时的目录。目前 Unified Sorter 会使用该目录储存临时文件,建议确保该目录所在设备的可用空间大于等于 500 GiB。更详细的说明参见 [Unified Sorter](/ticdc/manage-ticdc.md#unified-sorter-功能)。对于使用 TiUP 的用户,本选项可以通过配置 [`cdc_servers`](/tiup/tiup-cluster-topology-reference.md#cdc_servers) 中的 `data_dir` 来指定或默认使用 `global``data_dir` 路径。
- `gc-ttl`:TiCDC 在 PD 设置的服务级别 GC safepoint 的 TTL (Time To Live) 时长,和 TiCDC 同步任务所能够停滞的时长。单位为秒,默认值为 `86400`,即 24 小时。注意:TiCDC 同步任务的停滞会影响 TiCDC GC safepoint 的推进,即会影响上游 TiDB GC 的推进,详情可以参考 [TiCDC GC safepoint 的完整行为](/ticdc/troubleshoot-ticdc.md#ticdc-gc-safepoint-的完整行为是什么)
- `gc-ttl`:TiCDC 在 PD 设置的服务级别 GC safepoint 的 TTL (Time To Live) 时长,和 TiCDC 同步任务所能够停滞的时长。单位为秒,默认值为 `86400`,即 24 小时。注意:TiCDC 同步任务的停滞会影响 TiCDC GC safepoint 的推进,即会影响上游 TiDB GC 的推进,详情可以参考 [TiCDC GC safepoint 的完整行为](/ticdc/ticdc-faq.md#ticdc-gc-safepoint-的完整行为是什么)
- `log-file`:TiCDC 进程运行时日志的输出地址,未设置时默认为标准输出 (stdout)。
- `log-level`:TiCDC 进程运行时的日志级别,默认为 `"info"`
- `ca`:TiCDC 创建 TLS 连接时使用的 CA 证书文件路径,PEM 格式,可选。
Expand Down
10 changes: 5 additions & 5 deletions ticdc/ticdc-alert-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ summary: 了解 TiCDC 集群监控报警规则以及处理方法。

* 处理方法:

参考 [`TiCDC 同步任务出现中断`](/ticdc/troubleshoot-ticdc.md#ticdc-同步任务出现中断) 的处理方法。
参考 [TiCDC 同步任务出现中断](/ticdc/troubleshoot-ticdc.md#ticdc-同步任务出现中断)的处理方法。

### `cdc_resolvedts_high_delay`

Expand All @@ -37,7 +37,7 @@ summary: 了解 TiCDC 集群监控报警规则以及处理方法。

* 处理方法:

该告警与同步任务中断类似,可参考 [`TiCDC 同步任务出现中断`](/ticdc/troubleshoot-ticdc.md#ticdc-同步任务出现中断) 的处理方法。
该告警与同步任务中断类似,可参考 [TiCDC 同步任务出现中断](/ticdc/troubleshoot-ticdc.md#ticdc-同步任务出现中断)的处理方法。

### `ticdc_processor_exit_with_error_count`

Expand All @@ -51,7 +51,7 @@ summary: 了解 TiCDC 集群监控报警规则以及处理方法。

* 处理方法:

参考 [`TiCDC 同步任务出现中断`](/ticdc/troubleshoot-ticdc.md#ticdc-同步任务出现中断) 的处理方法。
参考 [TiCDC 同步任务出现中断](/ticdc/troubleshoot-ticdc.md#ticdc-同步任务出现中断)的处理方法。

## 警告级别报警项

Expand Down Expand Up @@ -111,7 +111,7 @@ summary: 了解 TiCDC 集群监控报警规则以及处理方法。

* 处理方法:

参考 [`TiCDC 同步任务出现中断`](/ticdc/troubleshoot-ticdc.md#ticdc-同步任务出现中断) 的处理方法。
参考 [TiCDC 同步任务出现中断](/ticdc/troubleshoot-ticdc.md#ticdc-同步任务出现中断)的处理方法。

### `ticdc_puller_entry_sorter_sort_bucket`

Expand Down Expand Up @@ -181,7 +181,7 @@ summary: 了解 TiCDC 集群监控报警规则以及处理方法。

* 处理方法:

MySQL 报错的情况较多,参考[`TiCDC 常见问题和故障处理`](/ticdc/troubleshoot-ticdc.md)
MySQL 报错的情况较多,参考 [TiCDC 故障处理](/ticdc/troubleshoot-ticdc.md)

### `ticdc_memory_abnormal`

Expand Down
Loading

0 comments on commit 62fb6bb

Please sign in to comment.