From 302bcfae484ad659b224372fdc7a0e59a431f717 Mon Sep 17 00:00:00 2001 From: yibin87 Date: Mon, 15 Jun 2026 16:28:43 +0800 Subject: [PATCH 1/2] docs: correct Top SQL v8.5.7 version markers --- dashboard/top-sql.md | 8 ++++---- tikv-configuration-file.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/dashboard/top-sql.md b/dashboard/top-sql.md index 112c8b9cd5fee..e29807891208c 100644 --- a/dashboard/top-sql.md +++ b/dashboard/top-sql.md @@ -8,7 +8,7 @@ summary: Use Top SQL to identify queries that consume the most CPU, network, and On the Top SQL page of TiDB Dashboard, you can view and analyze the most resource-consuming SQL queries on a specified TiDB or TiKV node over a period of time. - After you enable Top SQL, this feature continuously collects CPU workload data from existing TiDB and TiKV nodes and retains the data for up to 30 days. -- Starting from v8.5.6 and v9.0.0, you can also enable **TiKV Network IO collection (multi-dimensional)** in the Top SQL settings to further view metrics such as `Network Bytes` and `Logical IO Bytes` for specified TiKV nodes, and perform aggregation analysis in dimensions of `By Query`, `By Table`, `By DB`, and `By Region`. +- Starting from v8.5.7 and v9.0.0, you can also enable **TiKV Network IO collection (multi-dimensional)** in the Top SQL settings to further view metrics such as `Network Bytes` and `Logical IO Bytes` for specified TiKV nodes, and perform aggregation analysis in dimensions of `By Query`, `By Table`, `By DB`, and `By Region`. Top SQL provides the following features: @@ -65,7 +65,7 @@ In addition to the UI, you can also enable the Top SQL feature by setting the Ti SET GLOBAL tidb_enable_top_sql = 1; ``` -### (Optional) Enable TiKV Network IO collection New in v8.5.6 and v9.0.0 +### (Optional) Enable TiKV Network IO collection New in v8.5.7 and v9.0.0 To view Top SQL by `Order By Network` or `Order By Logical IO` for TiKV nodes, or to use the `By Region` aggregation, you can enable the **Enable TiKV Network IO collection (multi-dimensional)** switch in Top SQL settings and save the changes. @@ -117,13 +117,13 @@ The following are the common steps to use Top SQL. ![Select aggregation dimension](/media/dashboard/v8.5-top-sql-usage-select-agg-by.png) - - The default sort order is `Order By CPU` (sorted by CPU time). If you select a TiKV node and have [enabled TiKV Network IO collection (multi-dimensional)](#optional-enable-tikv-network-io-collection-new-in-v856-and-v900), you can also select `Order By Network` (sorted by network bytes) or `Order By Logical IO` (sorted by logical IO bytes). + - The default sort order is `Order By CPU` (sorted by CPU time). If you select a TiKV node and have [enabled TiKV Network IO collection (multi-dimensional)](#optional-enable-tikv-network-io-collection-new-in-v857-and-v900), you can also select `Order By Network` (sorted by network bytes) or `Order By Logical IO` (sorted by logical IO bytes). ![Select order by](/media/dashboard/v8.5-top-sql-usage-select-order-by.png) > **Note** > - > `By Region` and `Order By Network`, `Order By Logical IO` are only available when [TiKV Network IO collection (multi-dimensional)](#optional-enable-tikv-network-io-collection-new-in-v856-and-v900) is enabled. If this feature is not enabled but historical data still exists, the page will continue to display historical data and prompt that new data cannot be fully collected. + > `By Region` and `Order By Network`, `Order By Logical IO` are only available when [TiKV Network IO collection (multi-dimensional)](#optional-enable-tikv-network-io-collection-new-in-v857-and-v900) is enabled. If this feature is not enabled but historical data still exists, the page will continue to display historical data and prompt that new data cannot be fully collected. 5. Observe the resource consumption hotspot records in the chart and table. diff --git a/tikv-configuration-file.md b/tikv-configuration-file.md index 2a5b2572be8bf..01e311f13c180 100644 --- a/tikv-configuration-file.md +++ b/tikv-configuration-file.md @@ -2693,7 +2693,7 @@ To reduce write latency, TiKV periodically fetches and caches a batch of timesta Configuration items related to resource metering. -### `enable-network-io-collection` New in v8.5.6 and v9.0.0 +### `enable-network-io-collection` New in v8.5.7 and v9.0.0 + Controls whether to collect TiKV network traffic and logical I/O information in [Top SQL](/dashboard/top-sql.md) in addition to CPU data. + When enabled, TiKV additionally records inbound network bytes, outbound network bytes, logical read bytes, and logical write bytes during request processing. From e8696c1f30f31ff42ca4c4d35bf010adfe339111 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Tue, 16 Jun 2026 17:00:51 +0800 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- dashboard/top-sql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dashboard/top-sql.md b/dashboard/top-sql.md index e29807891208c..55dce1c7a6e4a 100644 --- a/dashboard/top-sql.md +++ b/dashboard/top-sql.md @@ -123,7 +123,7 @@ The following are the common steps to use Top SQL. > **Note** > - > `By Region` and `Order By Network`, `Order By Logical IO` are only available when [TiKV Network IO collection (multi-dimensional)](#optional-enable-tikv-network-io-collection-new-in-v857-and-v900) is enabled. If this feature is not enabled but historical data still exists, the page will continue to display historical data and prompt that new data cannot be fully collected. + > `By Region`, `Order By Network`, and `Order By Logical IO` are only available when [TiKV Network IO collection (multi-dimensional)](#optional-enable-tikv-network-io-collection-new-in-v857-and-v900) is enabled. If this feature is not enabled but historical data still exists, the page will continue to display historical data and prompt that new data cannot be fully collected. 5. Observe the resource consumption hotspot records in the chart and table.