Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jiong-nba wants to merge 4 commits into
base: release-8.5
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
353b146
cloud: document detailed Top SQL I/O dimensions
jiong-nba Aug 17, 2026
97ce95c
cloud: correct detailed I/O availability version
jiong-nba Aug 28, 2026
ebea13d
cloud: simplify detailed Top SQL I/O description
jiong-nba Aug 31, 2026
dfe449e
cloud: retain detailed I/O version requirement
jiong-nba Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions tidb-cloud/tidb-cloud-clinic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,11 @@ For more information, see [Slow Queries in TiDB Dashboard](https://docs.pingcap.

## Monitor Top SQL

TiDB Cloud Clinic provides Top SQL information to help you visually analyze the most resource-intensive queries on a specific TiDB or TiKV node over a period of time. By default, Top SQL continuously collects CPU load data. For TiKV nodes, if TiKV network IO collection is enabled, you can also inspect `Network Bytes` and `Logical IO Bytes`, and analyze hotspots by `Query`, `Table`, `DB`, or `Region`. This helps you identify and troubleshoot performance issues across multiple resource dimensions, not just CPU.
TiDB Cloud Clinic provides Top SQL information to help you visually analyze the most resource-intensive queries on a specific TiDB or TiKV node over a period of time. By default, Top SQL continuously collects CPU load data. For TiKV nodes, if TiKV network IO collection is enabled, you can also inspect network and logical I/O metrics, and analyze hotspots by `Query`, `Table`, `DB`, or `Region`. This helps you identify and troubleshoot performance issues across multiple resource dimensions, not just CPU.

Detailed TiKV I/O dimensions are available for clusters running TiDB v8.5.9 or later.

After you enable **TiKV Network IO collection (multi-dimensional)**, the **Enable detailed TiKV IO dimensions** switch appears in the Top SQL settings. Enable the switch and save the settings to replace the combined `Logical IO` sort dimension with `Logical Read`, `Logical Write`, and `Read IOPS`. The `CPU` and `Network` dimensions are unaffected. If you disable the switch, the three detailed I/O dimensions are hidden and the combined `Logical IO` dimension is restored.
Comment thread
coderabbitai[bot] marked this conversation as resolved.

To view Top SQL, take the following steps:

Expand All @@ -103,7 +107,7 @@ To view Top SQL, take the following steps:

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 and enabled metrics, you can use `Order By` and the available aggregation dimensions to inspect CPU, network, or logical I/O hotspots. When detailed TiKV I/O dimensions are enabled, you can inspect logical read, logical write, and Read IOPS hotspots separately.

For more information, see [Top SQL in TiDB Dashboard](https://docs.pingcap.com/tidb/stable/top-sql).

Expand Down