docs: document Calibrate Resource for TiDB Cloud Dedicated - #23467
docs: document Calibrate Resource for TiDB Cloud Dedicated#23467xboxeer wants to merge 1 commit into
Conversation
Add a new Calibrate Resource page for TiDB Cloud Dedicated, and update the limited SQL features matrix, the resource control guide, and the TiDB Cloud TOC so that the console feature is discoverable. The CALIBRATE RESOURCE statement remains unsupported on TiDB Cloud Dedicated; the console provides the equivalent estimation feature.
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
missing-translation-status
📝 WalkthroughWalkthroughAdded a TiDB Cloud Dedicated Calibrate Resource guide. Updated the table of contents, SQL limitation references, resource-group documentation, and monitoring guidance. ChangesTiDB Cloud resource calibration
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: f3e93e58-74da-4a3d-9dd9-439f8cd4e445
📒 Files selected for processing (4)
TOC-tidb-cloud.mdtidb-cloud/calibrate-resource.mdtidb-cloud/limited-sql-features.mdtidb-resource-control-ru-groups.md
| > **Note:** | ||
| > | ||
| > This section is only applicable to TiDB Self-Managed. Currently, TiDB Cloud does not provide resource control metrics. | ||
| > This section describes the Grafana dashboards, which are only available for TiDB Self-Managed. For TiDB Cloud Dedicated, you can view the resource control metrics, including **Total RU Consumed** and **RU Consumed by Resource Groups**, in the [Calibrate Resource](/tidb-cloud/calibrate-resource.md) page of the TiDB Cloud console. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Remove or scope the remaining Grafana guidance for TiDB Cloud Dedicated.
The note on Line 411 says Grafana dashboards are available only for TiDB Self-Managed. However, Lines 413-415 still state that TiDB Cloud users receive resource-control metrics in Grafana. Keep those paragraphs in a Self-Managed-specific block, or remove them from the TiDB Cloud block. Otherwise, Dedicated users receive contradictory monitoring instructions.
1 participant
What is changed, added or deleted? (Required)
Add documentation for the Calibrate Resource feature on TiDB Cloud Dedicated:
tidb-cloud/calibrate-resource.md: describes how to estimate the RU capacity of a TiDB Cloud Dedicated cluster using the Calibrate Resource feature in the console (calibrate by hardware or by workload), the estimation result cards, the RU consumption charts, and how to change the resource allocation of a resource group.tidb-cloud/limited-sql-features.md: keepCALIBRATE RESOURCEas not supported (the statement is not available on TiDB Cloud) and add a footnote pointing users to the console feature.tidb-resource-control-ru-groups.md: replace the statement thatCALIBRATE RESOURCEis inapplicable on TiDB Cloud with guidance to use the console feature; update the note about resource control metrics on TiDB Cloud.TOC-tidb-cloud.md: add the new page under the Resource Manager section.Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit