Skip to content

Conversation

@wlwilliamx
Copy link
Collaborator

What problem does this PR solve?

Issue Number: close #2128

What is changed and how it works?

Support TiDB Dashboard query ticdc config and shows ticdc instance info.

Check List

Tests

  • Unit test
  • Integration test
  • Manual test
CleanShot 2026-01-05 at 18 36 57 CleanShot 2026-01-05 at 18 36 16 CleanShot 2026-01-05 at 18 36 35

Questions

Will it cause performance regression or break compatibility?

None

Do you need to update user documentation, design documentation or monitoring documentation?

None

Release note

None

@ti-chi-bot ti-chi-bot bot added the release-note-none Denotes a PR that doesn't merit a release note. label Jan 5, 2026
@gemini-code-assist
Copy link

Summary of Changes

Hello @wlwilliamx, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the TiCDC API by adding a new endpoint that provides access to the instance's global configuration. This feature is crucial for integrating TiCDC with the TiDB Dashboard, allowing users to easily view and monitor the configuration of their TiCDC deployments directly from the dashboard. The change improves the overall manageability and transparency of TiCDC instances.

Highlights

  • New API Endpoint: A new GET endpoint /config has been introduced to expose the global server configuration of the TiCDC instance.
  • TiDB Dashboard Integration: This change enables the TiDB Dashboard to query and display detailed configuration information for TiCDC instances, improving observability.
  • Unit Testing: A dedicated unit test has been added for the new /config endpoint to ensure its correct functionality and data integrity.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ti-chi-bot ti-chi-bot bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 5, 2026
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new API endpoint /config to expose the TiCDC server configuration, which is intended for use by the TiDB Dashboard. The implementation is straightforward and includes a new unit test for the endpoint.

My main concern is a critical security vulnerability. The new endpoint exposes the entire server configuration, including potentially sensitive security credentials, without authentication. I've provided a suggestion to mitigate this by masking the sensitive data before returning it.

Additionally, I've recommended enhancing the new unit test to verify that sensitive information is indeed stripped from the response, preventing future regressions.

@wlwilliamx
Copy link
Collaborator Author

/CC @lidezhu @wk989898

@ti-chi-bot ti-chi-bot bot requested review from lidezhu and wk989898 January 5, 2026 10:41
@wlwilliamx wlwilliamx mentioned this pull request Jan 5, 2026
4 tasks
@ti-chi-bot ti-chi-bot bot added needs-1-more-lgtm Indicates a PR needs 1 more LGTM. approved labels Jan 5, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 5, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lidezhu, wk989898

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jan 5, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 5, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-01-05 11:02:43.0645617 +0000 UTC m=+613718.882870132: ☑️ agreed by wk989898.
  • 2026-01-05 14:09:58.370772635 +0000 UTC m=+624954.189081067: ☑️ agreed by lidezhu.

@lidezhu
Copy link
Collaborator

lidezhu commented Jan 5, 2026

/hold

@ti-chi-bot ti-chi-bot bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 5, 2026
@lidezhu
Copy link
Collaborator

lidezhu commented Jan 6, 2026

/unhold

@ti-chi-bot ti-chi-bot bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 6, 2026
@wlwilliamx
Copy link
Collaborator Author

/retest

7 similar comments
@wlwilliamx
Copy link
Collaborator Author

/retest

@wlwilliamx
Copy link
Collaborator Author

/retest

@wlwilliamx
Copy link
Collaborator Author

/retest

@wlwilliamx
Copy link
Collaborator Author

/retest

@wlwilliamx
Copy link
Collaborator Author

/retest

@wlwilliamx
Copy link
Collaborator Author

/retest

@wlwilliamx
Copy link
Collaborator Author

/retest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

TiDB Dashboard Compatibility

3 participants