Skip to content

Commit

Permalink
Updates for Top SQL GA (#8701)
Browse files Browse the repository at this point in the history
  • Loading branch information
qiancai authored Mar 21, 2022
1 parent 16ec173 commit 56eb08b
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 24 deletions.
26 changes: 9 additions & 17 deletions dashboard/top-sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,16 @@ summary: 本文介绍如何使用 Top SQL 找到消耗负载较大的 SQL 查询

# Top SQL

> **警告:**
>
> Top SQL 目前为实验特性,不建议在生产环境中使用。
本文介绍如何使用 Top SQL 找到一段时间内对某个 TiDB 或 TiKV 节点消耗负载较大的 SQL 查询。例如,你可以通过 Top SQL 找出一个低负载的数据库上执行的一条消耗 99% 负载的分析查询。
本文介绍如何在 Top SQL 页面找到一段时间内对某个 TiDB 或 TiKV 节点消耗负载较大的 SQL 查询。例如,你可以通过 Top SQL 找出一个低负载的数据库上执行的一条消耗 99% 负载的分析查询。

针对指定的 TiDB 或 TiKV 节点,Top SQL 可以提供以下功能:

* 展示指定时间范围内消耗负载最多的 5 类 SQL 查询。
* 展示某一查询的 CPU 使用量、每秒请求数、平均延迟、查询计划等信息,作为改善业务的潜在性能优化点。

## 启用 Top SQL

Top SQL 功能默认关闭。你可以通过以下方法在整个集群范围内启用该功能:

- 方法一:登录 TiDB Dashboard,点击左侧面板中的 **Top SQL**,然后点击页面右上角的齿轮按钮,并打开 Top SQL 功能开关。
- 方法二:配置 TiDB 系统变量 [`tidb_enable_top_sql`](/system-variables.md#tidb_enable_top_sql-从-v540-版本开始引入)的值为 `ON`

> **注意:**
>
> 启用 Top SQL 会对集群的性能产生轻微的影响。
## 使用 Top SQL

开启 Top SQL 后,只需要登录 TiDB Dashboard,然后点击左侧面板中的 **Top SQL** 即可使用 Top SQL
Top SQL 功能默认开启。要使用该功能查看消耗负载较大的 SQL 查询,只需在登录 TiDB Dashboard 后点击左侧面板中的 **Top SQL** 即可

![Top SQL](/media/dashboard/top-sql-overview.png)

Expand All @@ -41,3 +26,10 @@ Top SQL 功能默认关闭。你可以通过以下方法在整个集群范围内
* 点击选中列表中的某个查询类型,可以查看这类查询在这个节点上的执行计划,以及详细执行信息,例如 Call/sec (平均每秒请求数)、 Scan Rows/sec (平均每秒扫描行数)、 Scan Indexes/sec (平均每秒扫描索引数)、Latency/call (平均延迟)。

![Top SQL Details](/media/dashboard/top-sql-details.png)

## 关闭 Top SQL

Top SQL 会对集群的性能产生轻微的影响。如需在整个集群范围内关闭该功能,你可以使用以下任一方法:

- 方法一:登录 TiDB Dashboard,点击左侧面板中的 **Top SQL**,然后点击页面右上角的齿轮按钮,关闭 Top SQL 功能开关。
- 方法二:配置 TiDB 系统变量 [`tidb_enable_top_sql`](/system-variables.md#tidb_enable_top_sql-从-v540-版本开始引入)的值为 `OFF`
1 change: 0 additions & 1 deletion experimental-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,3 @@ aliases: ['/docs-cn/dev/experimental-features-4.0/','/zh/tidb/dev/experimental-f
+ [集群诊断](/dashboard/dashboard-diagnostics-access.md)。(v4.0 实验特性)
+ [在线有损恢复](/online-unsafe-recovery.md)。(v5.3 实验特性)
+ [持续性能分析](/dashboard/continuous-profiling.md)。(v5.3 实验特性)
+ [Top SQL](/dashboard/top-sql.md)。(v5.4 实验特性)
2 changes: 1 addition & 1 deletion glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ PD 中的 Store 指的是集群中的存储节点,也就是 tikv-server 实例

### Top SQL

从 v5.4 起引入的实验特性,用于找到一段时间内对某个 TiDB 或 TiKV 节点消耗负载较大的 SQL 查询。详情参见 [Top SQL 用户文档](/dashboard/top-sql.md)
Top SQL 用于找到一段时间内对某个 TiDB 或 TiKV 节点消耗负载较大的 SQL 查询。详情参见 [Top SQL 用户文档](/dashboard/top-sql.md)

### TSO

Expand Down
6 changes: 1 addition & 5 deletions system-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -1507,13 +1507,9 @@ set tidb_slow_log_threshold = 200;
### `tidb_enable_top_sql` <span class="version-mark">从 v5.4.0 版本开始引入</span>
- 作用域:GLOBAL
- 默认值:`OFF`
- 默认值:`ON`
- 这个变量用控制是否开启 [Top SQL 特性](/dashboard/top-sql.md)。
> **警告:**
>
> Top SQL 目前为实验特性,不建议在生产环境中使用。
### `tidb_store_limit` <span class="version-mark">从 v3.0.4 和 v4.0 版本开始引入</span>
- 作用域:GLOBAL
Expand Down

0 comments on commit 56eb08b

Please sign in to comment.