refresh TopSQL docs and screenshots by yibin87 · Pull Request #21431 · pingcap/docs-cn

yibin87 · 2026-03-11T08:04:05Z

What is changed, added or deleted? (Required)

Refresh dashboard/top-sql.md to match the current pingcap/tidb-dashboard master behavior.
Update the Top SQL doc to cover Top 5/20/100, CPU/Network/Logical IO ordering, TiKV By Query / By Table / By DB / By Region, and the enable/disable behavior for TiKV network IO collection.
Re-shoot and replace the Top SQL screenshots with the current UI, including the TiKV Order By Network and Order By Logical IO views.
Add two new screenshots to explicitly show the Order By dropdown and the Top SQL settings drawer for enabling TiKV Network IO collection.

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s):
- https://github.com/pingcap/tidb-dashboard/tree/master

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

yibin87 · 2026-03-11T08:30:27Z

/cc @zhaoshangzi

ti-chi-bot · 2026-03-11T08:30:31Z

@yibin87: GitHub didn't allow me to request PR reviews from the following users: zhaoshangzi.

Note that only pingcap members and repo collaborators can review this PR, and authors cannot review their own PRs.

Details

In response to this:

/cc @zhaoshangzi

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

ti-chi-bot · 2026-03-11T11:40:41Z

@nolouch: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

dashboard/top-sql.md

ti-chi-bot · 2026-03-12T07:20:37Z

@zhaoshangzi: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Signed-off-by: yibin87 <huyibin@pingcap.com>

ti-chi-bot · 2026-03-12T07:39:31Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ti-chi-bot · 2026-03-12T08:16:12Z

@zhaoshangzi: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

dashboard/top-sql.md

tikv-configuration-file.md

dashboard/top-sql.md

tikv-configuration-file.md

dashboard/top-sql.md

…n87/docs-cn into pr/21431

Oreoxmt · 2026-04-03T03:48:40Z

/cc @Oreoxmt

Oreoxmt · 2026-04-03T04:07:05Z

dashboard/top-sql.md

 ---
 title: TiDB Dashboard Top SQL 页面
-summary: 使用 Top SQL 找到 CPU 开销较大的 SQL 语句
+summary: 使用 Top SQL 找到消耗 CPU、网络和逻辑 IO 资源较多的查询


Suggested change

summary: 使用 Top SQL 找到消耗 CPU、网络和逻辑 IO 资源较多的查询

summary: 使用 Top SQL 找到消耗 CPU、网络和逻辑 I/O 资源较多的查询。

Oreoxmt · 2026-04-03T04:08:17Z

dashboard/top-sql.md

-* 通过图表及表格，可视化地展示 CPU 开销最多的 5 类 SQL 语句。
-* 展示每秒请求数、平均延迟、查询计划等详细执行信息。
+* 通过图表和表格展示当前时间范围内资源消耗最高的 Top `5`、`20` 或 `100` 类 SQL 查询，其余记录自动汇总为 `Others`。
+* 支持按 CPU 耗时、网络字节数排序查看资源消耗热点；选择 TiKV 节点时，还支持按逻辑 IO 字节数排序。


Suggested change

* 支持按 CPU 耗时、网络字节数排序查看资源消耗热点；选择 TiKV 节点时，还支持按逻辑 IO 字节数排序。

* 支持按 CPU 耗时、网络字节数排序查看资源消耗热点；选择 TiKV 节点时，还支持按逻辑 I/O 字节数排序。

Oreoxmt · 2026-04-03T04:08:27Z

dashboard/top-sql.md

+* 通过监控发现个别 TiDB 或 TiKV 节点 CPU 负载很高，希望快速定位是哪类 SQL 正在消耗大量 CPU 资源。
+* 集群整体查询变慢，希望找出当前最消耗资源的 SQL，或者对比负载变化前后最主要的查询差异。
+* 需要从更高维度定位热点，希望按 `Table`、`DB` 或 `Region` 聚合查看 TiKV 侧的资源消耗。
+* 需要从网络流量或逻辑 IO 角度排查 TiKV 热点，而不仅仅局限于 CPU 维度。


Suggested change

* 需要从网络流量或逻辑 IO 角度排查 TiKV 热点，而不仅仅局限于 CPU 维度。

* 需要从网络流量或逻辑 I/O 角度排查 TiKV 热点，而不仅仅局限于 CPU 维度。

dashboard: refresh top sql docs and screenshots

d1475dd

ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 11, 2026

dashboard: add top sql order by and settings screenshots

f11aa36

yibin87 requested review from hfxsd and nolouch March 11, 2026 09:19

dashboard: align top sql enable text with screenshots

a412fd7

nolouch approved these changes Mar 11, 2026

View reviewed changes

hfxsd added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Mar 12, 2026

hfxsd assigned qiancai Mar 12, 2026

hfxsd added translation/doing This PR’s assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. labels Mar 12, 2026

zhaoshangzi suggested changes Mar 12, 2026

View reviewed changes

dashboard/top-sql.md Outdated Show resolved Hide resolved

Address comments

70911c9

Signed-off-by: yibin87 <huyibin@pingcap.com>

zhaoshangzi approved these changes Mar 12, 2026

View reviewed changes

yibin87 mentioned this pull request Mar 13, 2026

refresh TopSQL docs and screenshots pingcap/docs#22559

Open

13 tasks

qiancai reviewed Mar 16, 2026

View reviewed changes

dashboard/top-sql.md Outdated Show resolved Hide resolved

qiancai reviewed Mar 16, 2026

View reviewed changes

dashboard/top-sql.md Outdated Show resolved Hide resolved

qiancai reviewed Mar 16, 2026

View reviewed changes

yibin87 and others added 5 commits March 17, 2026 11:11

docs: address Top SQL review feedback

86c5835

media: update dashboard screenshot versions

6b31f9a

tikv config: add resource-metering.enable-network-io-collection

af81e88

Apply suggestion from @yibin87

ddebafe

tikv config: replace 网络 I/O wording with 网络流量

8088ab6

yibin87 and others added 2 commits March 17, 2026 12:14

tikv config: remove flaky GitHub links from config doc

a3d58cf

revert two changes caused by false link check results

51149ab

yibin87 mentioned this pull request Mar 17, 2026

tikv config: 补充 resource-metering.enable-network-io-collection 配置项说明 #21424

Closed

13 tasks

qiancai reviewed Mar 27, 2026

View reviewed changes

dashboard/top-sql.md Outdated Show resolved Hide resolved

tikv-configuration-file.md Outdated Show resolved Hide resolved

tikv-configuration-file.md Outdated Show resolved Hide resolved

Apply suggestions from code review

daf34b2

qiancai changed the title ~~dashboard: refresh Top SQL docs and screenshots~~ refresh TopSQL docs and screenshots Mar 30, 2026

qiancai reviewed Mar 30, 2026

View reviewed changes

dashboard/top-sql.md Outdated Show resolved Hide resolved

qiancai reviewed Mar 30, 2026

View reviewed changes

dashboard/top-sql.md Outdated Show resolved Hide resolved

qiancai reviewed Mar 30, 2026

View reviewed changes

tikv-configuration-file.md Outdated Show resolved Hide resolved

qiancai reviewed Mar 30, 2026

View reviewed changes

tikv-configuration-file.md Outdated Show resolved Hide resolved

qiancai added 2 commits March 30, 2026 11:05

Apply suggestions from code review

9a3e718

Update tikv-configuration-file.md

b50f6c0

qiancai added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Mar 30, 2026

实例 -> 节点

0ae4493

qiancai reviewed Mar 30, 2026

View reviewed changes

dashboard/top-sql.md Outdated Show resolved Hide resolved

qiancai added 5 commits March 30, 2026 11:51

Update dashboard/top-sql.md

853f328

add v8.5 to image names to avoid replacing images in old branches

b8f735e

Merge branch 'update_topsql_functionality' of https://github.com/yibi…

0619fdc

…n87/docs-cn into pr/21431

add v8.5 to image names

4eaeaf7

add v9.0.0

7f2d477

ti-chi-bot bot requested a review from Oreoxmt April 3, 2026 03:48

Oreoxmt reviewed Apr 3, 2026

View reviewed changes

	summary: 使用 Top SQL 找到消耗 CPU、网络和逻辑 IO 资源较多的查询
	summary: 使用 Top SQL 找到消耗 CPU、网络和逻辑 I/O 资源较多的查询。

	* 支持按 CPU 耗时、网络字节数排序查看资源消耗热点；选择 TiKV 节点时，还支持按逻辑 IO 字节数排序。
	* 支持按 CPU 耗时、网络字节数排序查看资源消耗热点；选择 TiKV 节点时，还支持按逻辑 I/O 字节数排序。

	* 需要从网络流量或逻辑 IO 角度排查 TiKV 热点，而不仅仅局限于 CPU 维度。
	* 需要从网络流量或逻辑 I/O 角度排查 TiKV 热点，而不仅仅局限于 CPU 维度。

Conversation

yibin87 commented Mar 11, 2026 • edited by hfxsd Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

Uh oh!

yibin87 commented Mar 11, 2026

Uh oh!

ti-chi-bot bot commented Mar 11, 2026

Uh oh!

ti-chi-bot bot commented Mar 11, 2026

Uh oh!

Uh oh!

ti-chi-bot bot commented Mar 12, 2026

Uh oh!

ti-chi-bot bot commented Mar 12, 2026

Uh oh!

ti-chi-bot bot commented Mar 12, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Oreoxmt commented Apr 3, 2026

Uh oh!

Oreoxmt Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

Oreoxmt Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

Oreoxmt Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

yibin87 commented Mar 11, 2026 •

edited by hfxsd

Loading