upstream: support ticdc topology info in tidb dashboard #1209
Conversation
ti-chi-bot
bot
added
do-not-merge/needs-triage-completed
release-note-none
There was a problem hiding this comment.
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
pkg/upstream/upstream.go:358
- The use of 'clientV3.WithLease' here may not be compatible with the updated etcd.Client interface. Consider using the corresponding lease option provided by the new etcd client wrapper to ensure consistency.
_, err = up.etcdCli.Put(ctx, key, string(value), clientV3.WithLease(up.session.Lease()))
pkg/upstream/manager.go:31
- The comment refers to 'CaptureTopologyCfg' while the actual type is named 'NodeTopologyCfg'. Consider updating the comment to match the type name for clarity.
// CaptureTopologyCfg stores the information of the capture topology.
|
/check-issue-triage-complete |
|
Does it conflict with the old TiCDC? |
| } | ||
|
|
||
| // fetchTiDBTopology parses the TiDB topology from etcd. | ||
| func fetchTiDBTopology(ctx context.Context, etcdClient *clientv3.Client) ([]tidbInstance, error) { |
There was a problem hiding this comment.
Does the ticdc topology depend on it?
There was a problem hiding this comment.
For now, no. But we will need it later.
Co-authored-by: nhsmw <[email protected]>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: flowbehappy The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
[LGTM Timeline notifier]Timeline:
|
No. |
…o feat/support-tidb-dashboard
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for registering TiCDC node topology in etcd so the TiDB Dashboard can display cluster node information.
- Introduce an upstream manager to register node topology info with etcd using a lease.
- Update server initialization to wire up the upstream manager.
- Add a new etcd client wrapper helper and a helper for fetching TiDB topology.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| server/server.go | Initialize upstream.Manager with NodeTopologyCfg and register default upstream. |
| pkg/upstream/upstream.go | Add registerTopologyInfo to publish TiCDC node info under /topology/ticdc. |
| pkg/upstream/topo.go | New helper to fetch TiDB topology from etcd for reference. |
| pkg/upstream/manager.go | Pass NodeTopologyCfg into init functions and update signatures. |
| pkg/etcd/client.go | Add NewWrappedClient to simplify creating a wrapped etcd client. |
Comments suppressed due to low confidence (2)
pkg/upstream/upstream.go:342
- There are no tests covering
registerTopologyInfo; consider adding unit tests to verify the etcd key format, TTL behavior, and error cases.
func (up *Upstream) registerTopologyInfo(ctx context.Context, cfg *NodeTopologyCfg) error {
pkg/upstream/upstream.go:358
- Use the correct alias for the imported etcd client: change
clientV3.WithLeasetoclientv3.WithLeaseto match theclientv3import and ensure compilation.
_, err = up.etcdCli.Put(ctx, key, string(value), clientV3.WithLease(up.session.Lease()))
|
/retest |
1 similar comment
|
/retest |
|
/test pull-cdc-mysql-integration-light |
|
/test pull-cdc-mysql-integration-heavy |
|
/test pull-cdc-kafka-integration-light |
|
/test pull-cdc-mysql-integration-heavy |
|
/test pull-cdc-mysql-integration-heavy |
1 similar comment
|
/test pull-cdc-mysql-integration-heavy |
|
/test pull-cdc-mysql-integration-light |
|
/test pull-cdc-mysql-integration-heavy |
|
/test pull-cdc-kafka-integration-heavy |
|
@wlwilliamx: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
What problem does this PR solve?
Issue Number: close #1115
What is changed and how it works?
This PR adds support for showing TiCDC cluster node information in the TiDB Dashboard. It works by writing each TiCDC node’s topology info into etcd under the key
/topology/ticdc/{clusterID}/{ip:port}. The data includes basic node metadata and is registered with a lease so it gets cleaned up automatically if the node goes down.The TiDB Dashboard can read from the
/topology/ticdc/prefix, parse the values, and display the list of active TiCDC nodes along with their details. This helps users get a better view of the CDC cluster status directly from the dashboard without needing to query it separately.Related code in
tidb-dashboardrepo: https://github.com/pingcap/tidb-dashboard/blob/release-9.0-beta.1/pkg/utils/topology/ticdc.go#L22.Check List
Tests
Questions
Will it cause performance regression or break compatibility?
No.
Do you need to update user documentation, design documentation or monitoring documentation?
No.
Release note