api: add ineligibleTables/eligible tables info when creating/updating changefeed #3932
Conversation
ti-chi-bot
bot
added
release-note
Summary of ChangesHello @wk989898, 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 significantly improves the transparency and user experience when managing changefeeds. It introduces the capability to identify and report tables that are ineligible for replication during both creation and update operations. This is achieved by enhancing the API to return detailed table eligibility information and by integrating a verification and warning system into the CLI, allowing users to make informed decisions about replicating tables without primary keys. Highlights
🧠 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 AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds information about eligible and ineligible tables to the logs and CLI output when creating or updating a changefeed. The changes in the API handlers look good. However, I've found a critical bug in the CLI output where table counts are printed incorrectly. Additionally, there's significant code duplication between the create and update changefeed CLI commands that should be refactored.
| return | ||
| } | ||
|
|
||
| log.Info("Update changefeed successfully!", |
There was a problem hiding this comment.
Please also add cost time in this log.
There was a problem hiding this comment.
The LogMiddleware will print the cost time
ti-chi-bot
bot
added
size/L
ti-chi-bot
bot
added
size/XXL
wk989898
added
the
do-not-merge/hold
|
@wk989898: The following tests failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. |
|
/gemini summary |
Summary of ChangesThis pull request significantly enhances the user's ability to understand and manage table replication within TiCDC changefeeds. By integrating detailed 'eligibleTables' and 'ineligibleTables' information directly into the API responses and logs, and by exposing this data through a new dedicated API endpoint, users gain clearer insights into which tables will or will not be replicated. The command-line interface (CLI) has been updated to leverage this new information, providing immediate feedback, warnings for potential issues with ineligible tables, and a verbose option for in-depth analysis. Furthermore, the inclusion of table count metrics in Grafana dashboards allows for better monitoring of changefeed operations. Highlights
🧠 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. Changelog
Activity
|
|
Please add manual test result in the PR description. |
wk989898
removed
the
do-not-merge/hold
Signed-off-by: wk989898 <nhsmwk@gmail.com>
Signed-off-by: wk989898 <nhsmwk@gmail.com>
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request adds functionality to provide information about eligible and ineligible tables when creating or updating a changefeed. It introduces a new API endpoint /api/v2/get_all_tables and updates the corresponding CLI commands to display this information, including a new --verbose flag. The changes are a good improvement for user experience. However, I've found a critical bug related to variable shadowing in the resume command, an error handling issue in a new API handler, and several instances of code duplication and misleading CLI output that should be addressed.
| if overwriteCheckpointTs { | ||
| sinkURIParsed, err := url.Parse(cfInfo.SinkURI) | ||
| if err != nil { | ||
| _ = c.Error(errors.WrapError(errors.ErrSinkURIInvalid, err, cfInfo.SinkURI)) | ||
| return | ||
| } | ||
| scheme := sinkURIParsed.Scheme | ||
| topic := "" | ||
| if config.IsMQScheme(scheme) { | ||
| topic, err = helper.GetTopic(sinkURIParsed) | ||
| if err != nil { | ||
| _ = c.Error(errors.WrapError(errors.ErrSinkURIInvalid, err, cfInfo.SinkURI)) | ||
| return | ||
| } | ||
| } | ||
| protocol, _ := config.ParseSinkProtocolFromString(util.GetOrZero(cfInfo.Config.Sink.Protocol)) | ||
|
|
||
| keyspaceManager := appcontext.GetService[keyspace.Manager](appcontext.KeyspaceManager) | ||
| kvStorage, err := keyspaceManager.GetStorage(ctx, keyspaceName) | ||
| if err != nil { | ||
| _ = c.Error(err) | ||
| return | ||
| } | ||
| ineligibleTables, eligibleTables, err = getVerifiedTables(ctx, cfInfo.Config, kvStorage, newCheckpointTs, scheme, topic, protocol) | ||
| if err != nil { | ||
| _ = c.Error(err) | ||
| return | ||
| } | ||
| } |
There was a problem hiding this comment.
This block of code for getting verified tables is very similar to the logic in CreateChangefeed, UpdateChangefeed, and the new GetAllTables handler. To improve maintainability and reduce code duplication, consider extracting this logic into a shared helper function.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…nto changefeed-info Signed-off-by: wk989898 <nhsmwk@gmail.com>
|
/gemini summary |
Summary of ChangesThis pull request significantly enhances TiCDC's changefeed management by improving transparency and user control over table replication. It introduces new API capabilities to expose detailed information about eligible and ineligible tables during changefeed creation, updates, and resumption. The command-line interface is updated to leverage this information, offering clearer feedback, warnings for potential issues with ineligible tables, and a verbose option for in-depth analysis. Additionally, new Grafana dashboard panels provide better monitoring of table counts within changefeeds. Highlights
🧠 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. Changelog
Activity
|
Signed-off-by: wk989898 <nhsmwk@gmail.com>
Signed-off-by: wk989898 <nhsmwk@gmail.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: asddongmen The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
[LGTM Timeline notifier]Timeline:
|
2 participants
What problem does this PR solve?
Issue Number: close #3888
What is changed and how it works?
It introduces a new API endpoint /api/v2/get_all_tables and updates the corresponding CLI commands to display this information, including a new --verbose flag. However, I've found a critical bug related to variable shadowing in the resume command, an error handling issue in a new API handler, and several instances of code duplication and misleading CLI output that should be addressed.
Check List
Tests
Questions
Will it cause performance regression or break compatibility?
Do you need to update user documentation, design documentation or monitoring documentation?
Release note