tidb-cloud: add Top RU user guide (web console, Premium + Essential)#22989
Merged
ti-chi-bot[bot] merged 15 commits intoJun 2, 2026
Merged
Conversation
ti-chi-bot
Bot
added
first-time-contributor
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a new documentation page for the "Top RU" feature in TiDB Cloud, which ranks SQL statements by their Request Unit (RU) consumption, and updates the table of contents to include this new page. The review feedback focuses on improving the documentation's clarity, style, and consistency by suggesting active voice rewrites to replace passive constructions, refining terminology (such as using "left navigation pane" and "SQL statement"), correcting link targets, and clarifying specific steps in the workflow and limitations sections.
| |---|---| | ||
| | SQL Statement | Normalized SQL template | | ||
| | Total RU | Total RU consumed by this SQL in the selected time range | | ||
| | RU Share % | Percentage of total cluster RU consumed by this SQL. The top N SQLs together account for less than 100%; adding the **Others** row gives 100%. | |
Contributor
There was a problem hiding this comment.
Use "SQL statement" and "SQL statements" instead of "SQL" and "SQLs" to be more precise and professional.
Suggested change
| | RU Share % | Percentage of total cluster RU consumed by this SQL. The top N SQLs together account for less than 100%; adding the **Others** row gives 100%. | | |
| | RU Share % | Percentage of total cluster RU consumed by this SQL statement. The top N SQL statements together account for less than 100%; adding the **Others** row gives 100%. | |
References
- Use consistent terminology and avoid unnecessary words. (link)
| | Total RU | Total RU consumed by this SQL in the selected time range | | ||
| | RU Share % | Percentage of total cluster RU consumed by this SQL. The top N SQLs together account for less than 100%; adding the **Others** row gives 100%. | | ||
| | Execution Count | Number of times this SQL was executed in the selected time range | | ||
| | User | Database user(s) that ran this SQL (Premium only). A single SQL digest may be executed by multiple users. | |
Contributor
There was a problem hiding this comment.
Rewrite the passive sentence "A single SQL digest may be executed by multiple users" to active voice to improve readability and adhere to the style guide.
Suggested change
| | User | Database user(s) that ran this SQL (Premium only). A single SQL digest may be executed by multiple users. | | |
| | User | Database user(s) that ran this SQL (Premium only). Multiple users can execute a single SQL digest. | |
References
- Avoid passive voice overuse. (link)
|
|
||
| ### Rank by Users panel | ||
|
|
||
| The **Overview** tab includes a **Rank by Users** panel that shows a ranked list of database users by their total RU consumption for the selected time range. Use this to quickly determine whether the RU spike is driven by a specific user or application. |
Contributor
There was a problem hiding this comment.
Avoid passive voice ("is driven by") by rewriting the sentence to active voice.
Suggested change
| The **Overview** tab includes a **Rank by Users** panel that shows a ranked list of database users by their total RU consumption for the selected time range. Use this to quickly determine whether the RU spike is driven by a specific user or application. | |
| The **Overview** tab includes a **Rank by Users** panel that shows a ranked list of database users by their total RU consumption for the selected time range. Use this to quickly determine whether a specific user or application drives the RU spike. |
References
- Avoid passive voice overuse. (link)
| - **TopN grouping**: SQL statements with lower RU may be grouped into **Others** rather than shown individually. | ||
| - **Data freshness**: 15 seconds. | ||
| - **Maximum query window**: 24 hours per time range selection. | ||
| - **Essential limitations**: The Sliced by Users tab and Rank by Users panel are not available for Essential clusters. |
Contributor
There was a problem hiding this comment.
Bold the UI elements (Sliced by Users tab and Rank by Users panel) and use active voice.
Suggested change
| - **Essential limitations**: The Sliced by Users tab and Rank by Users panel are not available for Essential clusters. | |
| - **Essential limitations**: Essential clusters do not support the **Sliced by Users** tab and the **Rank by Users** panel. |
| ### Why is there no data in Top RU? | ||
|
|
||
| - Make sure the selected time range contains actual SQL workload. | ||
| - Refresh the page after running workload for at least 15 seconds. |
Contributor
There was a problem hiding this comment.
Add "your" before "workload" to make the instruction more natural.
Suggested change
| - Refresh the page after running workload for at least 15 seconds. | |
| - Refresh the page after running your workload for at least 15 seconds. |
Contributor
|
Warning Gemini encountered an error creating the review. You can try again by commenting |
hfxsd
added
translation/no-need
zhoucai-pingcap
approved these changes
Jun 2, 2026
|
@zhoucai-pingcap: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn 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: 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>
huoyao1125
commented
Jun 2, 2026
Add the Top RU TOC link to the Essential and Premium TOCs and remove it from the main TiDB Cloud TOC to avoid duplication. This places the Top RU page under the Monitor and Alert section for tier-specific documentation. Files changed: TOC-tidb-cloud-essential.md, TOC-tidb-cloud-premium.md, TOC-tidb-cloud.md.
hfxsd
reviewed
Jun 2, 2026
hfxsd
reviewed
Jun 2, 2026
hfxsd
reviewed
Jun 2, 2026
hfxsd
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
Oreoxmt
reviewed
Jun 2, 2026
|
|
||
| - Make sure the selected time range contains actual SQL workload. | ||
| - Refresh the page after running workload for at least 1 min. | ||
| - Check [TiDB Cloud Release Notes](/tidb-cloud/releases/tidb-cloud-release-notes.md) to confirm that Top RU is available for your instance version and region. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Check [TiDB Cloud Release Notes](/tidb-cloud/releases/tidb-cloud-release-notes.md) to confirm that Top RU is available for your instance version and region. | |
| - Check [TiDB Cloud Release Notes](/tidb-cloud/releases/tidb-cloud-release-notes.md) to confirm that Top RU is available for your {{{ .essential }}} or {{{ .premium }}} instance version and region. |
Oreoxmt
reviewed
Jun 2, 2026
Co-authored-by: Aolin <aolinz@outlook.com>
hfxsd
approved these changes
Jun 2, 2026
ti-chi-bot
Bot
added
lgtm
and removed
needs-1-more-lgtm
github-actions Bot
pushed a commit
to doc-claw-bot/pingcap-docsite-preview
that referenced
this pull request
Jun 2, 2026
hfxsd
reviewed
Jun 2, 2026
Collaborator
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hfxsd 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is changed, added or deleted?
This PR adds a complete user guide for the Top RU feature in the TiDB Cloud web console, targeting both Premium and Essential product tiers.
Changes:
tidb-cloud/top-ru.md: full user-facing documentation for Top RUTOC-tidb-cloud.md: add Top RU entry under Monitor and AlertWhy this PR
PR #22760 attempted to document Top RU but has several critical issues:
This PR addresses all of the above. See issue #22988 for full details.
What this doc covers
Which TiDB version(s) do your changes apply to?
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?