Skip to content

tidb-cloud: add TopRU user guide in TiDB Cloud Clinic (Premium)#22760

Open
zimulala wants to merge 2 commits intopingcap:masterfrom
zimulala:codex/topru-cloud-premium-doc-master
Open

tidb-cloud: add TopRU user guide in TiDB Cloud Clinic (Premium)#22760
zimulala wants to merge 2 commits intopingcap:masterfrom
zimulala:codex/topru-cloud-premium-doc-master

Conversation

@zimulala
Copy link
Copy Markdown
Contributor

What is changed, added or deleted? (Required)

This PR adds full TopRU user documentation for TiDB Cloud Clinic (Premium/Dedicated scope), instead of only adding a link.

Changes include:

  • Add a new doc page: tidb-cloud/premium/top-ru-in-clinic-premium.md
    • Feature overview and recommended scenarios
    • Prerequisites
    • Page views and usage workflow
    • Observation dimensions and granularity
    • Limitations and FAQ
  • Update navigation:
    • TOC-tidb-cloud-premium.md
    • tidb-cloud/premium/_index.md
  • Update tidb-cloud/tidb-cloud-clinic.md to include TopRU entry and section.
  • Add TopRU screenshots under media/tidb-cloud/.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Apr 15, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign icemap for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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 missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 15, 2026
Copy link
Copy Markdown
Contributor

@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 documentation for the TopRU feature in TiDB Cloud Clinic, including a new detailed guide and updates to the Table of Contents and main Clinic documentation. The feature allows users to identify high resource unit (RU) consumption by SQL statements and database users. The review feedback focuses on improving the documentation's clarity and adherence to the style guide by suggesting the use of active voice, removing redundant phrasing, and ensuring technical terms like TopN and sql_digest are properly formatted with backticks.

Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Comment thread tidb-cloud/premium/top-ru-in-clinic-premium.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant