You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 and requires no manual operation.
19
+
20
+
If your cluster version is earlier than v8.5.4, you need to manually import the TiCDC monitoring metrics file:
19
21
20
22
1. Download the monitoring metrics file for TiCDC in the new architecture:
Copy file name to clipboardExpand all lines: ticdc/ticdc-architecture.md
+65-2Lines changed: 65 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -219,6 +219,68 @@ To deploy the TiCDC new architecture using TiDB Operator, take the following ste
219
219
</div>
220
220
</SimpleTab>
221
221
222
+
### Deploy a New TiDB Cluster with TiCDC New Architecture Enabled
223
+
224
+
<SimpleTab>
225
+
<div label="TiUP">
226
+
227
+
When deploying a new TiDB cluster of v8.5.4 or later using TiUP, you can deploy and enable the new architecture of the TiCDC component simultaneously. You need to add the TiCDC component-related section to the TiUP configuration file when starting the TiDB cluster and set `newarch: true` to enable the new architecture. The following is an example:
228
+
229
+
```yaml
230
+
cdc_servers:
231
+
- host: 10.0.1.20
232
+
config:
233
+
newarch: true
234
+
- host: 10.0.1.21
235
+
config:
236
+
newarch: true
237
+
```
238
+
239
+
For more TiCDC deployment information, refer to [Deploy a New TiDB Cluster with TiCDC Using TiUP](/ticdc/deploy-ticdc.md#deploy-a-new-tidb-cluster-with-ticdc-using-tiup).
240
+
241
+
</div>
242
+
<divlabel="TiDB Operator">
243
+
244
+
When deploying a new TiDB cluster of v8.5.4 or later using TiDB Operator, you can deploy and enable the new architecture of the TiCDC component simultaneously. You need to add the TiCDC component-related section to the cluster configuration file and set `newarch: true` to enable the new architecture. The following is an example:
245
+
246
+
```yaml
247
+
spec:
248
+
ticdc:
249
+
baseImage: pingcap/ticdc
250
+
version: v8.5.4
251
+
replicas: 3
252
+
config:
253
+
newarch = true
254
+
```
255
+
256
+
For more TiCDC deployment information, refer to [Deploy a New TiDB Cluster with TiCDC](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-ticdc/#deploy-a-new-tidb-cluster-with-ticdc).
257
+
258
+
</div>
259
+
</SimpleTab>
260
+
261
+
### Deploy TiCDC with New Architecture in an Existing TiDB Cluster
262
+
263
+
<SimpleTab>
264
+
<div label="TiUP">
265
+
266
+
The following are the steps to deploy TiCDC with the new architecture in an existing TiDB cluster using TiUP:
267
+
268
+
1. If your TiDB cluster does not have TiCDC nodes, refer to [Scale Out TiCDC Nodes](/scale-tidb-using-tiup.md#scale-out-ticdc-nodes) to scale out new TiCDC nodes in the cluster; otherwise, skip this step.
269
+
270
+
2. If your TiDB cluster is an earlier version than v8.5.4, you need to manually download the TiCDC new architecture offline package in the following way and dynamically replace the downloaded TiCDC binary file to your TiDB cluster; otherwise, skip this step.
271
+
272
+
The offline package download link format is `https://tiup-mirrors.pingcap.com/cdc-${version}-${os}-${arch}.tar.gz`. Among them, `${version}` is the TiCDC version number (for version number information, refer to [TiCDC New Architecture Version Release List](https://github.com/pingcap/ticdc/releases)), `${os}` is your operating system, and `${arch}` is the platform on which the component runs (`amd64` or `arm64`).
273
+
274
+
For example, you can use the following command to download the offline package of TiCDC v8.5.4-release.1 for the Linux system x86-64 architecture:
3. If there are already Changefeeds in the cluster, refer to [Stop a replication task](/ticdc/ticdc-manage-changefeed.md#stop-a-replication-task) to pause all Changefeed synchronization tasks. For example:
281
+
282
+
```shell
283
+
222
284
## Use the new architecture
223
285
224
286
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.
@@ -239,6 +301,7 @@ For more command usage methods and details, see [Manage Changefeeds](/ticdc/ticd
239
301
240
302
## Monitoring
241
303
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).
304
+
The monitoring dashboard for the TiCDC new architecture is **TiCDC-New-Arch**. For TiDB clusters of v8.5.4 and later versions, this monitoring dashboard has been integrated into Grafana during cluster deployment or upgrade and does not require manual operation. 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.
305
+
306
+
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).
243
307
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