Skip to content

topsql: document detailed TiKV I/O dimensions - #21886

Draft
jiong-nba wants to merge 3 commits into
pingcap:masterfrom
jiong-nba:codex/topsql-detailed-io-docs
Draft

topsql: document detailed TiKV I/O dimensions#21886
jiong-nba wants to merge 3 commits into
pingcap:masterfrom
jiong-nba:codex/topsql-detailed-io-docs

Conversation

@jiong-nba

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

Copy link
Copy Markdown

What is changed, added or deleted? (Required)

  • Document the new detailed TiKV I/O dimensions in Top SQL, including the switch dependency, UI behavior, compatibility fallback, overhead, and troubleshooting.
  • Document resource-metering.enable-detailed-io-collection in the TiKV configuration reference.
  • Clarify that Read IOPS is a foreground RocksDB block-read attribution signal rather than device-level IOPS.
  • Refresh six Top SQL screenshots with the Chinese Dashboard UI to cover the detailed I/O setting, aggregation and sorting controls, chart, SQL details, and database aggregation result.
  • The target release has not been confirmed yet, so this PR targets master only and does not add a "New in vX.Y.Z" marker.

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 (in Chinese).

  • 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

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

ti-chi-bot Bot commented Aug 14, 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 do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. labels Aug 14, 2026
@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 58657a49-accf-49f9-b805-da01ed171eb9

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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 commented Aug 14, 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 jackysp 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/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 14, 2026
@pingcap-cla-assistant

pingcap-cla-assistant Bot commented Aug 14, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@pingcap-cla-assistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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

jiong-nba commented Aug 17, 2026

Copy link
Copy Markdown
Author

Screenshot and end-to-end validation update

The PR description and validation notes remain in English. Only the six documentation screenshots have been refreshed to use the Chinese Dashboard UI.

This update remains aligned with the English documentation PR pingcap/docs#23532:

  • Retain the two historical v8.5 screenshots because other versions still reference them.
  • Add and reference six v9.0 Top SQL screenshots covering the detailed I/O setting, aggregation dimension, sorting dimension, chart, SQL details, and By DB aggregation result.
  • Replace the earlier English-UI screenshots with Chinese-UI screenshots generated from a sustained mixed workload.

The local validation used TiKV d14cd3194, ng-monitoring d295da59, and TiDB Dashboard a70560af:

  • Six concurrent read/write patterns ran continuously in two back-to-back runs and completed 23,605 statements.
  • The leading query reached 23.26 GiB of Logical Read.
  • The leading update reached 1.06 GiB of Logical Write.
  • The leading query reached 6.57M Read IOPS.
  • The charts contain dense per-second samples across the rolling five-minute window.

Logical Read

Sustained Logical Read workload in the Chinese Dashboard UI

Logical Write

Sustained Logical Write workload in the Chinese Dashboard UI

Read IOPS

Sustained Read IOPS workload in the Chinese Dashboard UI

Signed-off-by: jiong-nba <jiongnba@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. 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/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant