Skip to content

config: add scan limit debug config#1637

Merged
ti-chi-bot[bot] merged 1 commit into
pingcap:masterfrom
asddongmen:add-scan-limit-config
Aug 13, 2025
Merged

config: add scan limit debug config#1637
ti-chi-bot[bot] merged 1 commit into
pingcap:masterfrom
asddongmen:add-scan-limit-config

Conversation

@asddongmen
Copy link
Copy Markdown
Collaborator

@asddongmen asddongmen commented Aug 12, 2025

What problem does this PR solve?

Issue Number: close #1638

What is changed and how it works?

When starting the CDC server, you can use the following configuration to limit the scanning speed of the eventBroker.

[debug]
[debug.event-service]
scan-limit-in-bytes = 1048576

Check List

Tests

  • Manual test (add detailed scripts or steps below)

Questions

Will it cause performance regression or break compatibility?
Do you need to update user documentation, design documentation or monitoring documentation?

Release note

Please refer to [Release Notes Language Style Guide](https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/release-notes-style-guide.html) to write a quality release note.

If you don't think this PR needs a release note then fill it with `None`.

Signed-off-by: dongmen <414110582@qq.com>
@ti-chi-bot ti-chi-bot Bot added do-not-merge/needs-linked-issue release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Aug 12, 2025
Copy link
Copy Markdown

@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.

Summary of Changes

Hello @asddongmen, 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 introduces a new debug configuration option to control the scan limit for the event service. Previously, this limit was a hardcoded constant, but now it can be configured, providing more flexibility for debugging and performance tuning of the event processing.

Highlights

  • Configuration: Added a new "ScanLimitInBytes" field to the "EventServiceConfig" struct in "pkg/config/debug.go", allowing the scan limit for the event service to be configured.
  • Event Service Rate Limiting: Modified the "newEventBroker" function in "pkg/eventservice/event_broker.go" to initialize the "scanRateLimiter" using the newly introduced "ScanLimitInBytes" from the debug configuration, replacing a previously hardcoded value.
  • Constant Removal: Removed the "maxScanLimitInBytesPerSecond" constant from "pkg/eventservice/dispatcher_stat.go" as its value is now sourced from the configuration.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 12, 2025
Copy link
Copy Markdown

@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 debug configuration ScanLimitInBytes to make the event service scan rate limit configurable, replacing a hardcoded constant. The implementation is straightforward and correct. My only suggestion is to improve the naming of the new configuration field for better clarity, as it represents a rate (bytes per second).

Comment thread pkg/config/debug.go
@ti-chi-bot ti-chi-bot Bot added the lgtm label Aug 12, 2025
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Aug 12, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-08-12 10:32:01.528385511 +0000 UTC m=+349920.562968738: ☑️ agreed by lidezhu.

@asddongmen
Copy link
Copy Markdown
Collaborator Author

/check-issue-triage-complete

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Aug 13, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: flowbehappy, hongyunyan, lidezhu

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 the approved label Aug 13, 2025
@ti-chi-bot ti-chi-bot Bot merged commit 534c630 into pingcap:master Aug 13, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

config: add scan limit config

4 participants