Skip to content

master: correct Top SQL multi-dimensional metrics support to v8.5.7 #21716

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
yibin87 wants to merge 3 commits into
base: master
Choose a base branch
from
+6 −6
Open

master: correct Top SQL multi-dimensional metrics support to v8.5.7 #21716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
564a1f8
docs: correct Top SQL multi-dimensional metrics support to v8.5.7
yibin87 Jun 15, 2026
e460443
docs: keep v8.5.6 internal packet variables
yibin87 Jun 15, 2026
2180e7f
docs: use v8.5 screenshot for Top SQL instance selector
yibin87 Jun 15, 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
10 changes: 5 additions & 5 deletions dashboard/top-sql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ summary: 使用 Top SQL 找到消耗 CPU、网络和逻辑 I/O 资源较多的
在 TiDB Dashboard 的 Top SQL 页面，你可以查看和分析指定的 TiDB 或 TiKV 节点在一段时间内资源消耗最高的 SQL 查询。

- 开启 Top SQL 后，该功能会持续采集现有 TiDB 和 TiKV 节点的 CPU 负载数据，并最多保留 30 天。
- 从 v8.5.6 和 v9.0.0 起，你还可以在 Top SQL 设置中开启 **TiKV 网络 IO 采集（多维度）**，以进一步查看指定 TiKV 节点的 `Network Bytes`、`Logical IO Bytes` 等指标，并按 `By Query`、`By Table`、`By DB` 或 `By Region` 维度进行聚合分析。
- 从 v8.5.7 和 v9.0.0 起，你还可以在 Top SQL 设置中开启 **TiKV 网络 IO 采集（多维度）**，以进一步查看指定 TiKV 节点的 `Network Bytes`、`Logical IO Bytes` 等指标，并按 `By Query`、`By Table`、`By DB` 或 `By Region` 维度进行聚合分析。

Top SQL 具有以下功能：

Expand Down Expand Up @@ -65,7 +65,7 @@ Top SQL 开启后会对集群性能产生轻微的影响（平均 3% 以内）
SET GLOBAL tidb_enable_top_sql = 1;
```

### 开启 TiKV 网络 IO 采集（可选）<span class="version-mark">从 v8.5.6 和 v9.0.0 开始引入</span>
### 开启 TiKV 网络 IO 采集（可选）<span class="version-mark">从 v8.5.7 和 v9.0.0 开始引入</span>

针对 TiKV 节点，如需按照 `Order By Network`、`Order By Logical IO` 查看 Top SQL，或者使用 `By Region` 聚合，请在 Top SQL 设置面板中打开 **开启 TiKV 网络 IO 采集（多维度）** (Enable TiKV Network IO collection (multi-dimensional)) 开关并保存。

Expand Down Expand Up @@ -96,7 +96,7 @@ server_configs:

2. 选择一个你想要观察负载的具体 TiDB 或 TiKV 节点。

![选择 TiDB 或 TiKV 节点](/media/dashboard/top-sql-usage-select-instance.png)
![选择 TiDB 或 TiKV 节点](/media/dashboard/v8.5-top-sql-usage-select-instance.png)

如果你不知道要观察哪一个节点，可以先从 Grafana 或 [TiDB Dashboard 概况页面](/dashboard/dashboard-overview.md)中定位负载异常的节点，再返回 Top SQL 页面进一步分析。

Expand All @@ -117,13 +117,13 @@ server_configs:

![选择聚合维度](/media/dashboard/v8.5-top-sql-usage-select-agg-by.png)

- 默认的排序方式是 `Order By CPU`（按 CPU 耗时排序）。如果当前选择的是 TiKV 节点且已[开启 TiKV 网络 IO 采集（多维度）](#开启-tikv-网络-io-采集可选从-v856-和-v900-开始引入)，还可以选择 `Order By Network`（按网络字节数排序） 或 `Order By Logical IO`（按逻辑 IO 字节数排序）。
- 默认的排序方式是 `Order By CPU`（按 CPU 耗时排序）。如果当前选择的是 TiKV 节点且已[开启 TiKV 网络 IO 采集（多维度）](#开启-tikv-网络-io-采集可选从-v857-和-v900-开始引入)，还可以选择 `Order By Network`（按网络字节数排序） 或 `Order By Logical IO`（按逻辑 IO 字节数排序）。

![选择排序方式](/media/dashboard/v8.5-top-sql-usage-select-order-by.png)

> **注意**
>
> `By Region` 以及 `Order By Network`、`Order By Logical IO` 仅在 [TiKV 网络 IO 采集（多维度）](#开启-tikv-网络-io-采集可选从-v856-和-v900-开始引入)开启时可选。若该功能未开启，但历史数据仍然存在，页面会继续展示历史数据，并提示新数据无法完整采集。
> `By Region` 以及 `Order By Network`、`Order By Logical IO` 仅在 [TiKV 网络 IO 采集（多维度）](#开启-tikv-网络-io-采集可选从-v857-和-v900-开始引入)开启时可选。若该功能未开启，但历史数据仍然存在，页面会继续展示历史数据，并提示新数据无法完整采集。

5. 观察图表和表格中的资源消耗热点记录。

Expand Down
2 changes: 1 addition & 1 deletion tikv-configuration-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2696,7 +2696,7 @@ Raft Engine 相关的配置项。

资源计量 (Resource Metering) 相关的配置项。

### `enable-network-io-collection` <span class="version-mark">从 v8.5.6 和 v9.0.0 版本开始引入</span>
### `enable-network-io-collection` <span class="version-mark">从 v8.5.7 和 v9.0.0 版本开始引入</span>

+ 是否在 [Top SQL](/dashboard/top-sql.md) 中除了采集 CPU 数据外，还额外采集 TiKV 的网络流量和逻辑 I/O 信息。
+ 开启后，TiKV 在处理请求时会额外记录这些指标：网络入站字节数、网络出站字节数、逻辑读字节数和逻辑写字节数。
Expand Down
Loading