tiflash: add a config named graceful_shutdown_wait_timeout
#21734
Conversation
Signed-off-by: gengliqi <[email protected]>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @gengliqi, 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 configuration option to TiFlash, enhancing its graceful shutdown mechanism. The change allows administrators to define a timeout period during which the TiFlash server will complete ongoing analytical tasks before fully shutting down, preventing data loss or interruption of long-running queries during planned maintenance.
Highlights
- New TiFlash Configuration Parameter: A new configuration parameter, graceful_wait_shutdown_timeout, has been added to TiFlash. This parameter specifies the duration (in seconds) that the TiFlash server will wait during shutdown for existing MPP tasks to complete, without accepting new tasks. The default value is 600 seconds.
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
-
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
bot
added
missing-translation-status
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the new TiFlash configuration parameter graceful_shutdown_wait_timeout. My review focuses on improving the clarity and correctness of the added documentation, including correcting a potential typo in the parameter name and rephrasing the description for better readability, in line with the documentation style guide.
tiflash/tiflash-configuration.md
Outdated
| ##### `graceful_wait_shutdown_timeout` | ||
|
|
||
| - Specifies the number of seconds that the TiFlash server waits for when you shut down the TiFlash server, which allows the remaining MPP tasks to execute and does not accept any new MPP tasks. If all the MPP tasks are finished before this timeout, TiFlash will shut down immediately. | ||
| - Default value: 600 | ||
| - When one TiFlash server is waiting for shutdown (in the grace period), the TiDB will not send any new task to this TiFlash server. |
There was a problem hiding this comment.
I have a few suggestions to improve the clarity and correctness of this new configuration documentation:
- Parameter Name: The parameter name
graceful_wait_shutdown_timeoutseems to have a typo. Based on the PR title, it should begraceful_shutdown_wait_timeout. Please verify and correct it. - Clarity and Conciseness: The description can be rephrased to be more direct and easier to understand, following the style guide's principles of clarity and active voice.1
Here is a suggested revision for the entire block.
| ##### `graceful_wait_shutdown_timeout` | |
| - Specifies the number of seconds that the TiFlash server waits for when you shut down the TiFlash server, which allows the remaining MPP tasks to execute and does not accept any new MPP tasks. If all the MPP tasks are finished before this timeout, TiFlash will shut down immediately. | |
| - Default value: 600 | |
| - When one TiFlash server is waiting for shutdown (in the grace period), the TiDB will not send any new task to this TiFlash server. | |
| ##### `graceful_shutdown_wait_timeout` | |
| - Specifies the timeout in seconds for a graceful shutdown of the TiFlash server. During this period, TiFlash finishes executing any remaining MPP tasks but does not accept any new MPP tasks. If all the MPP tasks are completed before this timeout, TiFlash shuts down immediately. | |
| - Default value: 600 | |
| - During this graceful shutdown period, TiDB does not send any new tasks to this TiFlash server. |
Style Guide References
Footnotes
-
The suggestion aims for better clarity, simplicity, and uses active voice to be easier to understand for users. ↩
Signed-off-by: gengliqi <[email protected]>
Signed-off-by: gengliqi <[email protected]>
qiancai
added
translation/done
|
@windtalker: adding LGTM is restricted to approvers and reviewers in OWNERS files. In response to this:
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. |
Co-authored-by: Grace Cai <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?