Skip to content

Commit

Permalink
docs: update metrics description (#988)
Browse files Browse the repository at this point in the history
  • Loading branch information
lidezhu authored Feb 13, 2025
1 parent e5d2376 commit 4991a94
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,26 @@ Go to [pingcap/ticdc/tags](https://github.com/pingcap/ticdc/tags) to find the la
Examples:
```bash
# Scale out some old version TiCDC nodes, if you don't already have some
tiup cluster scale-out test_cluster scale-out.yml
tiup cluster scale-out test-cluster scale-out.yml

#scale-out.yml
#cdc_servers:
# - host: 172.31.10.1

# Patch the new arch TiCDC to the cluster
tiup cluster patch --overwrite test_cluster cdc-v9.0.0-alpha-nightly-linux-amd64.tar.gz -R cdc
# Patch the download binary to the cluster
tiup cluster patch --overwrite test-cluster cdc-v9.0.0-alpha-nightly-linux-amd64.tar.gz -R cdc

# Enable the new architectural TiCDC by setting the "newarch" parameter
tiup cluster edit-config test_cluster
# Enable TiCDC new architecture by setting the "newarch" parameter
tiup cluster edit-config test-cluster
#cdc_servers:
# ...
# config:
# newarch: true

tiup cluster reload test_cluster -R cdc
tiup cluster reload test-cluster -R cdc
```

### Import the new dashboard to grafana to monitor your workloads
Download [ticdc_new_arch.json](https://github.com/pingcap/ticdc/blob/master/metrics/grafana/ticdc_new_arch.json), and use the import button.

![](./docs/media/grafana_import.png)

> Note that TiUP has integrated the monitoring dashboard for TiCDC new architecture into the Grafana page, named `<cluster-name>`-TiCDC-New-Arch.
## How to compile TiCDC from source code

Expand Down

0 comments on commit 4991a94

Please sign in to comment.