cloud: document detailed Top SQL I/O dimensions - #23539
Conversation
Signed-off-by: jiong-nba <jiongnba@gmail.com>
|
Skipping CI for Draft Pull Request. |
|
[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 |
📝 WalkthroughWalkthroughThe Top SQL documentation now describes updated TiKV metrics for supported TiDB Cloud Dedicated clusters. It also updates the chart and table analysis step to include the new aggregation dimensions. ChangesTop SQL documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: ⚪ Minimal · up to The documentation update clarifies detailed Top SQL I/O dimensions, but one minor wording issue currently conflates sorting metrics with aggregation dimensions and could briefly mislead readers; the risk is localized and does not indicate a broader merge blocker. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ 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 |
Signed-off-by: jiong-nba <jiongnba@gmail.com>
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: 9bd32a80-9467-4b46-bf85-b7ad7aadb93b
📒 Files selected for processing (1)
tidb-cloud/tidb-cloud-clinic.md
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.
| 3. Select a specific TiDB or TiKV node to observe its workload. You can use the time picker or select a time range in the chart to refine your analysis. | ||
|
|
||
| 4. Analyze the charts and tables displayed by Top SQL. Depending on the selected node and enabled metrics, you can use `Order By` and the available aggregation dimensions to inspect CPU, network, or logical I/O hotspots. | ||
| 4. Analyze the charts and tables displayed by Top SQL. Depending on the selected node, cluster version, and available metrics, you can use `Order By` and the available aggregation dimensions to inspect CPU, network, logical I/O, logical read, logical write, or Read IOPS hotspots. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Separate sort metrics from aggregation dimensions.
Line 114 describes CPU, network, and I/O metrics as aggregation dimensions. These metrics are Order By values. State the aggregation dimensions separately.
Replace the line with:
- Analyze the charts and tables displayed by Top SQL. Depending on the selected node, cluster version, and available metrics, you can use
Order Byto inspect CPU, network, logical I/O, logical read, logical write, or Read IOPS hotspots. You can also use the available aggregation dimensions to analyze the results.
Sources: Coding guidelines, Path instructions
What is changed, added or deleted? (Required)
Logical Read,Logical Write, andRead IOPSreplace the combinedLogical IOsort dimension, whileCPUandNetworkremain available.Read IOPSis a foreground RocksDB block-read attribution signal rather than device-level IOPS.This PR targets
release-8.5because TiDB Cloud documentation is maintained on that branch for content reuse. The documented feature applies to eligible clusters running TiDB v8.5.9 or later.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)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit