Skip to content

cloud: document detailed Top SQL I/O dimensions - #23539

Open
jiong-nba wants to merge 2 commits into
pingcap:release-8.5from
jiong-nba:codex/clinic-detailed-io-docs
Open

cloud: document detailed Top SQL I/O dimensions#23539
jiong-nba wants to merge 2 commits into
pingcap:release-8.5from
jiong-nba:codex/clinic-detailed-io-docs

Conversation

@jiong-nba

@jiong-nba jiong-nba commented Aug 17, 2026

Copy link
Copy Markdown

What is changed, added or deleted? (Required)

  • Document the detailed Top SQL I/O dimensions available in TiDB Cloud Clinic for TiDB Cloud Dedicated clusters hosted on AWS and running TiDB v8.5.9 or later.
  • Explain that Logical Read, Logical Write, and Read IOPS replace the combined Logical IO sort dimension, while CPU and Network remain available.
  • Clarify that Read IOPS is a foreground RocksDB block-read attribution signal rather than device-level IOPS.
  • Update the Top SQL usage step to include the detailed I/O dimensions.

This PR targets release-8.5 because 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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 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)

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • Documentation
    • Updated the TiDB Cloud Clinic Top SQL guidance for TiKV nodes.
    • Added information about the Logical Read, Logical Write, and Read IOPS metrics.
    • Clarified metric availability by cluster type, cloud platform, and TiDB version.
    • Clarified that Read IOPS represents an attribution signal, not physical storage-device IOPS.
    • Updated chart and table analysis instructions to reflect available aggregation dimensions.

Signed-off-by: jiong-nba <jiongnba@gmail.com>
@ti-chi-bot

ti-chi-bot Bot commented Aug 17, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Aug 17, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 17, 2026

Copy link
Copy Markdown

[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 kissmydb 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

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The 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.

Changes

Top SQL documentation

Layer / File(s) Summary
Top SQL metrics and analysis guidance
tidb-cloud/tidb-cloud-clinic.md
The documentation replaces Network Bytes and Logical IO Bytes with Logical Read, Logical Write, and Read IOPS for applicable TiKV nodes. It retains CPU and Network, clarifies Read IOPS attribution, and updates the available analysis dimensions.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 97ce9

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)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change: adding detailed Top SQL I/O dimensions for TiDB Cloud.
Description check ✅ Passed The description covers the required change, affected TiDB version, related links, AI involvement, and applicable change classifications. The documented scope matches the pull request objectives.
Docstring Coverage ✅ Passed 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…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

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)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 17, 2026
Signed-off-by: jiong-nba <jiongnba@gmail.com>
@jiong-nba
jiong-nba marked this pull request as ready for review August 28, 2026 09:25
Copilot AI lite review requested due to automatic review settings August 28, 2026 09:25
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 28, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd3daa5 and 97ce95c.

📒 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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 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:

  1. Analyze the charts and tables displayed by Top SQL. Depending on the selected node, cluster version, and available metrics, you can use Order By to 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants