Correct the description of "Total RU of user resource groups" (#20916) #20982
Conversation
ti-chi-bot
added
contribution
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ti-chi-bot, 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!
Summary of Changes
Hello! Gemini/gemini-code-assist here, providing a summary of this pull request to help everyone quickly understand the changes.
This PR, authored by @ti-chi-bot, is an automated cherry-pick aimed at correcting a specific detail in the documentation regarding the "Total RU of user resource groups" in the TiDB Dashboard's Resource Manager section. The core issue identified was that the description incorrectly stated that an alert is triggered if the total RU is less than the estimated capacity, when it should be more than the estimated capacity. This change ensures the documentation accurately reflects the system's behavior.
In addition to the primary text correction, a minor formatting change was made to remove a trailing newline character in the same file.
Highlights
- Documentation Correction: Corrected the description of "Total RU of user resource groups" in the Resource Manager documentation to accurately state that an alert is triggered if the value is more than (instead of less than) the estimated capacity.
- Formatting Fix: Removed a trailing newline character from the end of the
dashboard/dashboard-resource-manager.mdfile.
Changelog
- dashboard/dashboard-resource-manager.md
- Corrected 'less than' to 'more than' in the description of 'Total RU of user resource groups' (Line 50).
- Removed trailing newline character (Line 82).
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 is currently in preview and 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 to provide feedback.
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. ↩
There was a problem hiding this comment.
Code Review
This pull request makes a crucial correction to the documentation regarding the alert condition for "Total RU of user resource groups" and adds a standard formatting improvement. The changes enhance the clarity and technical accuracy of the document.
The review was conducted following the TiDB Documentation Style Guide, focusing on clarity, technical accuracy, and readability (Style Guide lines 14-17). The changes align well with these principles.
Summary of Findings
- Improved Technical Accuracy: The primary change corrects the condition for an alert related to 'Total RU of user resource groups' from 'less than' to 'more than' the estimated capacity. This is a significant improvement in technical accuracy.
- File Formatting: A newline has been added at the end of the file, which is a standard best practice for text files in version control.
Merge Readiness
The changes in this pull request are accurate and improve the documentation. The correction of the alert condition is particularly important for user understanding. The formatting change is also a welcome addition. While I cannot approve the pull request myself, the changes appear solid and ready for merging pending any further internal checks.
| @@ -47,7 +47,7 @@ Before resource planning, you need to know the overall capacity of the cluster. | |||
|
|
|||
|  | |||
|
|
|||
| The **Total RU of user resource groups** represents the total amount of RU for all user resource groups, excluding the `default` resource group. If this value is less than the estimated capacity, the system triggers an alert. By default, the system allocates unlimited usage to the predefined `default` resource group. When all users belong to the `default` resource group, resources are allocated in the same way as when resource control is disabled. | |||
| The **Total RU of user resource groups** represents the total amount of RU for all user resource groups, excluding the `default` resource group. If this value is more than the estimated capacity, the system triggers an alert. By default, the system allocates unlimited usage to the predefined `default` resource group. When all users belong to the `default` resource group, resources are allocated in the same way as when resource control is disabled. | |||
There was a problem hiding this comment.
This correction from "less than" to "more than" significantly improves the technical accuracy of the description. It's now clear that an alert is triggered when the allocated RUs for user resource groups exceed the cluster's estimated capacity, which is the logical condition for such an alert. This makes the documentation much clearer for users trying to understand resource management alerts. Well spotted!
| - IO MBps: The total I/O throughput of all TiKV instances. |
There was a problem hiding this comment.
Adding a newline at the end of the file is a good practice. It helps prevent issues with diffs in version control systems and ensures file consistency across different tools and platforms.
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lilin90 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 |
This is an automated cherry-pick of #20916
First-time contributors' checklist
What is changed, added or deleted? (Required)
Description of "Total RU of user resource groups" should say "more than" and not "less than"
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?