Skip to content
4 changes: 3 additions & 1 deletion ticdc/monitor-ticdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ cdc cli changefeed create --server=http://10.0.10.25:8300 --sink-uri="mysql://ro

## TiCDC 新架构监控指标

[TiCDC 新架构](/ticdc/ticdc-architecture.md)的监控面板 **TiCDC-New-Arch** 暂时未集成到 TiUP 中。要在 Grafana 中查看相关监控信息,你需要手动导入 TiCDC 监控指标文件:
TiCDC 新架构的监控面板为 **TiCDC-New-Arch**。对于 v8.5.4 及以上版本的 TiDB 集群,该监控面板已在集群部署或升级时集成到 Grafana,无需手动操作。

如果你的集群版本低于 v8.5.4,需要手动导入 TiCDC 监控指标文件:

1. 下载 TiCDC 新架构监控指标文件

Expand Down
55 changes: 48 additions & 7 deletions ticdc/ticdc-architecture.md
Copy link
Collaborator

Choose a reason for hiding this comment

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

Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,57 @@ TiCDC 新架构仅支持 v7.5.0 或者以上版本的 TiDB 集群,使用之前

你可以通过 TiUP 或 TiDB Operator 部署 TiCDC 新架构。

### 部署启用新架构 TiCDC 的全新 TiDB 集群

<SimpleTab>
<div label="TiUP">

在使用 TiUP 部署 v8.5.4 或者以上版本的全新 TiDB 集群时,支持同时部署启用新架构的 TiCDC 组件。你需要在 TiUP 启动 TiDB 集群时的配置文件中加入 TiCDC 组件相关的部分并设置 `newarch: true` 以启用新架构,以下是一个示例:

```yaml
cdc_servers:
- host: 10.0.1.20
config:
newarch: true
- host: 10.0.1.21
config:
newarch: true
```

更多 TiCDC 部署信息,请参考[使用 TiUP 部署包含 TiCDC 组件的全新 TiDB 集群](/ticdc/deploy-ticdc.md#使用-tiup-部署包含-ticdc-组件的全新-tidb-集群)。

</div>
<div label="TiDB Operator">

在使用 TiDB Operator 部署 v8.5.4 或者以上版本的全新 TiDB 集群时,支持同时部署启用新架构的 TiCDC 组件。你需要在集群配置文件中加入 TiCDC 组件相关的部分并设置 `newarch = true` 以启用新架构,以下是一个示例:

```yaml
spec:
ticdc:
baseImage: pingcap/ticdc
version: v8.5.4
replicas: 3
config:
newarch = true
```

更多 TiCDC 部署信息,请参考[全新部署 TiDB 集群同时部署 TiCDC](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-ticdc/#在现有-tidb-集群上新增-ticdc-组件)。

</div>
</SimpleTab>

### 在原有 TiDB 集群中部署启用新架构的 TiCDC 组件

<SimpleTab>
<div label="TiUP">

以下为通过 TiUP 部署 TiCDC 新架构的步骤
以下为通过 TiUP 在原有 TiDB 集群中部署启用新架构的 TiCDC 组件的步骤

1. 如果你的 TiDB 集群中尚无 TiCDC 节点,参考[扩容 TiCDC 节点](/scale-tidb-using-tiup.md#扩容-ticdc-节点)在集群中扩容新的 TiCDC 节点,否则跳过该步骤。

2. 下载 TiCDC 新架构离线包。
2. 如果你的 TiDB 集群为 v8.5.4 之前版本,需要按照以下方式手动下载 TiCDC 新架构离线包,并将下载的 TiCDC 二进制文件动态替换到你的 TiDB 集群,否则跳过该步骤

离线包下载链接格式为 `https://tiup-mirrors.pingcap.com/cdc-${version}-${os}-${arch}.tar.gz`。其中,`${version}` 为 TiCDC 版本号,`${os}` 为你的操作系统,`${arch}` 为组件运行的平台(`amd64` 或 `arm64`)。
离线包下载链接格式为 `https://tiup-mirrors.pingcap.com/cdc-${version}-${os}-${arch}.tar.gz`。其中,`${version}` 为 TiCDC 版本号(版本号信息可参考 [TiCDC 新架构版本发布列表](https://github.com/pingcap/ticdc/releases)),`${os}` 为你的操作系统,`${arch}` 为组件运行的平台(`amd64` 或 `arm64`)。

例如,可以使用以下命令下载 Linux 系统 x86-64 架构的 TiCDC v8.5.4-release.1 的离线包:

Expand Down Expand Up @@ -158,9 +199,9 @@ TiCDC 新架构仅支持 v7.5.0 或者以上版本的 TiDB 集群,使用之前
</div>
<div label="TiDB Operator">

以下为通过 TiDB Operator 部署 TiCDC 新架构的步骤
以下为通过 TiDB Operator 在原有 TiDB 集群中部署启用新架构的 TiCDC 组件的步骤

- 如果现有 TiDB 集群中没有 TiCDC 组件,参考[在现有 TiDB 集群上新增 TiCDC 组件](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-ticdc/#在现有-tidb-集群上新增-ticdc-组件)在集群中扩容新的 TiCDC 节点。操作时,只需在集群配置文件中将 TiCDC 的镜像版本指定为新架构版本即可。
- 如果现有 TiDB 集群中没有 TiCDC 组件,参考[在现有 TiDB 集群上新增 TiCDC 组件](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-ticdc/#在现有-tidb-集群上新增-ticdc-组件)在集群中扩容新的 TiCDC 节点。操作时,只需在集群配置文件中将 TiCDC 的镜像版本指定为新架构版本即可。版本号信息可参考 [TiCDC 新架构版本发布列表](https://github.com/pingcap/ticdc/releases)。

示例如下:

Expand Down Expand Up @@ -239,6 +280,6 @@ cdc cli changefeed query -s --server=http://127.0.0.1:8300 --changefeed-id=simpl

## 监控

目前,TiUP 尚未集成 TiCDC 新架构的监控面板 **TiCDC-New-Arch**。要在 Grafana 中查看该面板,你需要手动导入 [TiCDC 监控指标文件](https://github.com/pingcap/ticdc/blob/master/metrics/grafana/ticdc_new_arch.json)。
TiCDC 新架构的监控面板为 **TiCDC-New-Arch**。对于 v8.5.4 及以上版本的 TiDB 集群,该监控面板已在集群部署或升级时集成到 Grafana,无需手动操作。如果你的集群版本低于 v8.5.4,需手动导入 [TiCDC 监控指标文件](https://github.com/pingcap/ticdc/blob/master/metrics/grafana/ticdc_new_arch.json) 以启用监控

各监控指标的详细说明,请参考 [TiCDC 新架构监控指标](/ticdc/monitor-ticdc.md#ticdc-新架构监控指标)。
导入步骤以及各监控指标的详细说明,请参考 [TiCDC 新架构监控指标](/ticdc/monitor-ticdc.md#ticdc-新架构监控指标)。