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

Draft
jiong-nba wants to merge 1 commit into
base: release-8.5
Choose a base branch
from
+10 −2
Draft

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 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,15 @@ 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.

For TiDB Cloud Dedicated clusters hosted on AWS and running TiDB v9.0.0 or later, Top SQL replaces the combined `Logical IO` sort dimension with the following detailed I/O dimensions:

- `Logical Read`: the number of logical bytes read or processed by TiKV requests at the storage layer.
- `Logical Write`: the number of logical bytes written by TiKV write requests.
- `Read IOPS`: the number of RocksDB block reads recorded in foreground TiKV request contexts.

`CPU` and `Network` remain available. `Read IOPS` is an attribution signal for Top SQL and is not the actual IOPS of the underlying storage device.

To view Top SQL, take the following steps:

Expand All @@ -103,7 +111,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, 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.

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

Expand Down