Skip to content

Commit 644f112

Browse files
author
Docsite Preview Bot
committed
Preview PR pingcap/docs#22031 and this preview is triggered from commit pingcap/docs@f6c6447
1 parent c174953 commit 644f112

File tree

2 files changed

+58
-14
lines changed

2 files changed

+58
-14
lines changed

markdown-pages/en/tidb/master/ticdc/monitor-ticdc.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ cdc cli changefeed create --server=http://10.0.10.25:8300 --sink-uri="mysql://ro
1515

1616
## Metrics for TiCDC in the new architecture
1717

18-
The monitoring dashboard **TiCDC-New-Arch** for [TiCDC New Architecture](/ticdc/ticdc-architecture.md) is not managed by TiUP yet. To view the related monitoring data on Grafana, you need to manually import the TiCDC monitoring metrics file:
18+
The monitoring dashboard for TiCDC in the new architecture is **TiCDC-New-Arch**. For TiDB clusters of v8.5.4 and later versions, this monitoring dashboard is integrated into Grafana during cluster deployment or upgrade, so no manual operation is required.
19+
20+
If your cluster version is earlier than v8.5.4, you need to manually import the TiCDC monitoring metrics file:
1921

2022
1. Download the monitoring metrics file for TiCDC in the new architecture:
2123

@@ -125,7 +127,7 @@ The description of each metric in the **Sink** panel is as follows:
125127

126128
## Metrics for TiCDC in the classic architecture
127129

128-
If you use TiUP to deploy the TiDB cluster, you can see a sub-dashboard for TiCDC in the monitoring system which is deployed at the same time.
130+
If you use TiUP to deploy the TiDB cluster, you can see a sub-dashboard for TiCDC in the [classic architecture](/ticdc/ticdc-classic-architecture.md) on Grafana, which is deployed at the same time as TiDB.
129131

130132
The description of each panel is as follows:
131133

markdown-pages/en/tidb/master/ticdc/ticdc-architecture.md

Lines changed: 54 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -100,22 +100,63 @@ The new TiCDC architecture incorporates all functionalities of the classic archi
100100

101101
In addition, the new TiCDC architecture currently does not support splitting large transactions into multiple batches for downstream replication. As a result, there is still a risk of OOM when processing extremely large transactions. Make sure to evaluate and mitigate this risk appropriately before using the new architecture.
102102

103-
## Deployment steps
103+
## Upgrade guide
104104

105-
The TiCDC new architecture can only be deployed in TiDB clusters of v7.5.0 or later versions. Before deployment, make sure your TiDB cluster meets this version requirement.
105+
The TiCDC new architecture can only be deployed in TiDB clusters of v7.5.0 or later versions. Before deployment, make sure your TiDB cluster meets this requirement.
106106

107-
You can deploy the TiCDC new architecture using TiUP or TiDB Operator.
107+
You can deploy TiCDC nodes in the new architecture using TiUP or TiDB Operator.
108+
109+
### Deploy a new TiDB cluster with TiCDC nodes in the new architecture
110+
111+
<SimpleTab>
112+
<div label="TiUP">
113+
114+
When deploying a new TiDB cluster of v8.5.4 or later using TiUP, you can also deploy TiCDC nodes in the new architecture at the same time. To do so, you only need to add the TiCDC-related section and set `newarch: true` in the configuration file that TiUP uses to start the TiDB cluster. The following is an example:
115+
116+
```yaml
117+
cdc_servers:
118+
- host: 10.0.1.20
119+
config:
120+
newarch: true
121+
- host: 10.0.1.21
122+
config:
123+
newarch: true
124+
```
125+
126+
For more TiCDC deployment information, see [Deploy a new TiDB cluster that includes TiCDC using TiUP](/ticdc/deploy-ticdc.md#deploy-a-new-tidb-cluster-that-includes-ticdc-using-tiup).
127+
128+
</div>
129+
<div label="TiDB Operator">
130+
131+
When deploying a new TiDB cluster of v8.5.4 or later using TiDB Operator, you can also deploy TiCDC nodes in the new architecture at the same time. To do so, you only need to add the TiCDC-related section and set `newarch = true` in the cluster configuration file. The following is an example:
132+
133+
```yaml
134+
spec:
135+
ticdc:
136+
baseImage: pingcap/ticdc
137+
version: v8.5.4
138+
replicas: 3
139+
config:
140+
newarch = true
141+
```
142+
143+
For more TiCDC deployment information, see [Fresh TiCDC deployment](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-ticdc/#fresh-ticdc-deployment).
144+
145+
</div>
146+
</SimpleTab>
147+
148+
### Deploy TiCDC nodes in the new architecture in an existing TiDB cluster
108149
109150
<SimpleTab>
110151
<div label="TiUP">
111152
112-
To deploy the TiCDC new architecture using TiUP, take the following steps:
153+
To deploy TiCDC nodes in the new architecture using TiUP, take the following steps:
113154
114155
1. If your TiDB cluster does not have TiCDC nodes yet, refer to [Scale out a TiCDC cluster](/scale-tidb-using-tiup.md#scale-out-a-ticdc-cluster) to add new TiCDC nodes in the cluster. Otherwise, skip this step.
115156
116-
2. Download the TiCDC binary package for the new architecture.
157+
2. If your TiDB cluster version is earlier than v8.5.4, you need to manually download the TiCDC binary package of new architecture, and then patch the downloaded file to your TiDB cluster. Otherwise, skip this step.
117158
118-
The download link follows this format: `https://tiup-mirrors.pingcap.com/cdc-${version}-${os}-${arch}.tar.gz`, where `${version}` is the TiCDC version, `${os}` is your operating system, and `${arch}` is the platform the component runs on (`amd64` or `arm64`).
159+
The download link follows this format: `https://tiup-mirrors.pingcap.com/cdc-${version}-${os}-${arch}.tar.gz`, where `${version}` is the TiCDC version (see [TiCDC releases for the new architecture](https://github.com/pingcap/ticdc/releases) for available versions), `${os}` is your operating system, and `${arch}` is the platform the component runs on (`amd64` or `arm64`).
119160

120161
For example, to download the binary package of TiCDC v8.5.4-release.1 for Linux (x86-64), run the following command:
121162

@@ -158,9 +199,9 @@ To deploy the TiCDC new architecture using TiUP, take the following steps:
158199
</div>
159200
<div label="TiDB Operator">
160201

161-
To deploy the TiCDC new architecture using TiDB Operator, take the following steps:
202+
To deploy TiCDC nodes in the new architecture in an existing TiDB cluster using TiDB Operator, take the following steps:
162203

163-
- If your TiDB cluster does not include a TiCDC component, refer to [Add TiCDC to an existing TiDB cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-ticdc/#add-ticdc-to-an-existing-tidb-cluster) to add new TiCDC nodes. When doing so, specify the TiCDC image version as the new architecture version in the cluster configuration file.
204+
- If your TiDB cluster does not include a TiCDC component, refer to [Add TiCDC to an existing TiDB cluster](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-ticdc/#add-ticdc-to-an-existing-tidb-cluster) to add new TiCDC nodes. When doing so, specify the TiCDC image version as the new architecture version in the cluster configuration file. For available versions, see [TiCDC releases for the new architecture](https://github.com/pingcap/ticdc/releases).
164205

165206
For example:
166207

@@ -205,7 +246,7 @@ To deploy the TiCDC new architecture using TiDB Operator, take the following ste
205246
kubectl apply -f ${cluster_name} -n ${namespace}
206247
```
207248

208-
3. Resume all replication tasks:
249+
3. Resume all replication tasks of the changefeeds:
209250

210251
```shell
211252
kubectl exec -it ${pod_name} -n ${namespace} -- sh
@@ -223,7 +264,7 @@ To deploy the TiCDC new architecture using TiDB Operator, take the following ste
223264

224265
After deploying the TiCDC nodes with the new architecture, you can continue using the same commands as in the classic architecture. There is no need to learn new commands or modify the commands used in the classic architecture.
225266

226-
For example, to create a replication task in a new architecture TiCDC node, run the following command:
267+
For example, to create a replication task for a new TiCDC node in the new architecture, run the following command:
227268

228269
```shell
229270
cdc cli changefeed create --server=http://127.0.0.1:8300 --sink-uri="mysql://root:[email protected]:3306/" --changefeed-id="simple-replication-task"
@@ -239,6 +280,7 @@ For more command usage methods and details, see [Manage Changefeeds](/ticdc/ticd
239280

240281
## Monitoring
241282

242-
Currently, the monitoring dashboard **TiCDC-New-Arch** for the TiCDC new architecture is not managed by TiUP yet. To view this dashboard on Grafana, you need to manually import the [TiCDC monitoring metrics file](https://github.com/pingcap/ticdc/blob/master/metrics/grafana/ticdc_new_arch.json).
283+
The monitoring dashboard for TiCDC in the new architecture is **TiCDC-New-Arch**. For TiDB clusters of v8.5.4 and later versions, this monitoring dashboard is integrated into Grafana during cluster deployment or upgrade, so no manual operation is required. If your cluster version is earlier than v8.5.4, you need to manually import the [TiCDC monitoring metrics file](https://github.com/pingcap/ticdc/blob/master/metrics/grafana/ticdc_new_arch.json) to enable monitoring.
284+
285+
For importing steps and detailed descriptions of each monitoring metric, see [Metrics for TiCDC in the new architecture](/ticdc/monitor-ticdc.md#metrics-for-ticdc-in-the-new-architecture).
243286

244-
For detailed descriptions of each monitoring metric, see [Metrics for TiCDC in the new architecture](/ticdc/monitor-ticdc.md#metrics-for-ticdc-in-the-new-architecture).

0 commit comments

Comments
 (0)