reference/system-databases: add 12 new documents for sql diagnosis #2522

reafans · 2020-03-19T06:36:17Z

What is changed, added or deleted? (Required)

Add the user documentation for the new function sql-diagnosis
Add overview file sql-diagnosis.md
List all sys table in sql-diagnosis.md and add the detail and eg of these sys table in single file

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

master (the latest development version, including v4.0 changes for now)
v3.1 (TiDB 3.1 versions)
v3.0 (TiDB 3.0 versions)
v2.1 (TiDB 2.1 versions)

If you select two or more versions from above, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you must add corresponding labels such as needs-cherry-pick-3.1, needs-cherry-pick-3.0, and needs-cherry-pick-2.1.

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

This PR is translated from:
Other reference link(s):

…o sql-dignosis

…dignosis

TomShawn

The first round of review

TomShawn · 2020-03-23T07:27:22Z

reference/system-databases/sql-dignosis.md

+
+# SQL DIAGNOSIS
+
+SQL 诊断功能是由 TiDB 4.0 引入的新特性，主要用于提升 TiDB 问题定位效率，相较于 4.0 版本之前，不同的信息需要使用不同工具获取的异构方式，


的异构方式是什么意思呢？

Suggested change

SQL 诊断功能是由 TiDB 4.0 引入的新特性，主要用于提升 TiDB 问题定位效率，相较于 4.0 版本之前，不同的信息需要使用不同工具获取的异构方式，

SQL 诊断功能是在 TiDB 4.0 版本中引入的特性，用于提升 TiDB 问题定位的效率。TiDB 4.0 版本以前，用户需要使用不同工具获取以异构的方式获取不同信息。

意思就是混杂的，指之前的获取方式比较混杂多样。

reference/system-databases/sql-dignosis.md

reference/system-databases/cluster_hardware.md

TomShawn

The first round of review

reference/system-databases/cluster_info.md

TomShawn · 2020-03-24T04:26:56Z

reference/system-databases/cluster_info.md

+
+* TYPE：节点类型，目前节点的类型为 pd/tikv/tidb，节点类型始终为小写
+* INSTANCE：实例地址，始终为 IP:PORT 格式的字符串
+* STATUS_ADDRESS：HTTP API 服务地址，部分 tikv-ctl / pd-ctl / tidb-ctl 命令会使用到 HTTP API，会使用这个地址，用户也可以通过这个地址获取一些额外的集群信息，具体 HTTP API 参考官方文档


可否提供一下 HTTP API 官方文档的链接？

Suggested change

* STATUS_ADDRESS：HTTP API 服务地址，部分 tikv-ctl / pd-ctl / tidb-ctl 命令会使用到 HTTP API，会使用这个地址，用户也可以通过这个地址获取一些额外的集群信息，具体 HTTP API 参考官方文档

* `STATUS_ADDRESS`：HTTP API 的服务地址。部分 tikv-ctl / pd-ctl / tidb-ctl 命令会使用到 HTTP API 和该地址。用户也可以通过该地址获取一些额外的集群信息，详情可参考 HTTP API 官方文档。

reference/system-databases/cluster_info.md

reference/system-databases/cluster_log.md

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

TOC.md

reference/system-databases/cluster-config.md

Co-Authored-By: Lilian Lee <lilin@pingcap.com>

lilin90 · 2020-04-03T08:37:23Z

TOC.md

@@ -247,6 +247,18 @@
  + 系统数据库
    - [`mysql`](/reference/system-databases/mysql.md)
    - [`information_schema`](/reference/system-databases/information-schema.md)
+    + [`sql-diagnosis`](/reference/system-databases/sql-diagnosis.md)


The PingCAP website does not support this kind of link (link of an item that has sub-items).

kissmydb · 2020-04-03T08:40:28Z

LGTM

lilin90

LGTM

…ingcap#2522) * add sql-dignosis * fmt * fix lint * fix lint * split the sql-dignosis doc * refine doc * fix lint * add meta info * add æ�sql copy * refine doc * Update reference/system-databases/sql-dignosis.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/sql-dignosis.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/sql-dignosis.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/sql-dignosis.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/cluster_hardware.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/cluster_hardware.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/cluster_hardware.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/cluster_info.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/cluster_info.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/sql-dignosis.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/sql-dignosis.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/cluster_info.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/sql-dignosis.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/cluster_info.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/cluster_log.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * Update reference/system-databases/cluster_hardware.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * address comment * refine doc * refine punctuations and wording * add more docs Signed-off-by: crazycs520 <crazycs520@gmail.com> * Update reference/system-databases/sql-dignosis.md Co-Authored-By: Lilian Lee <lilin@pingcap.com> * Update reference/system-databases/sql-dignosis.md Co-Authored-By: Lilian Lee <lilin@pingcap.com> * add sys tables to TOC * fix lint * Update reference/system-databases/sql-diagnosis.md Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> * update metrics_schema docs Signed-off-by: crazycs520 <crazycs520@gmail.com> * add reference links and change file names * fix dead links * Update reference/system-databases/cluster-config.md Co-Authored-By: Lilian Lee <lilin@pingcap.com> * Update TOC.md Co-Authored-By: Lilian Lee <lilin@pingcap.com> * Delete SELECT GREATEST(t1.avg_value,.sql * reference: add summaries for newly added docs * toc: fix a link placement issue Co-authored-by: crazycs <crazycs520@gmail.com> Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> Co-authored-by: TomShawn <1135243111@qq.com> Co-authored-by: Lilian Lee <lilin@pingcap.com>

reafans and others added 10 commits March 16, 2020 10:49

add sql-dignosis

a55b158

fmt

0ceb83a

fix lint

5e0f48a

Merge branch 'master' into sql-dignosis

5640320

fix lint

8d703b7

Merge branch 'sql-dignosis' of https://github.com/reafans/docs-cn int…

ef6f2e8

…o sql-dignosis

split the sql-dignosis doc

879ba0a

refine doc

2934e47

fix lint

a3b172c

Merge branch 'master' into sql-dignosis

1be1aa5

TomShawn added size/large Changes of a large size. v4.0 This PR/issue applies to TiDB v4.0. translation/doing This PR’s assignee is translating this PR. labels Mar 19, 2020

TomShawn self-assigned this Mar 19, 2020

lilin90 requested review from kissmydb and TomShawn March 19, 2020 07:17

reafans added 5 commits March 20, 2020 15:14

add meta info

2545f7a

Merge branch 'sql-dignosis' of https://github.com/reafans/docs-cn int…

e5a55d4

…o sql-dignosis

Merge branch 'master' of https://github.com/pingcap/docs-cn into sql-…

f44276f

…dignosis

add æ�sql copy

fab9543

refine doc

edc30e5

TomShawn reviewed Mar 23, 2020

View reviewed changes

TomShawn reviewed Mar 24, 2020

View reviewed changes

crazycs520 and others added 6 commits March 25, 2020 15:45

Update reference/system-databases/sql-dignosis.md

91e2f47

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update reference/system-databases/sql-dignosis.md

236de52

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update reference/system-databases/sql-dignosis.md

7cbbe98

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update reference/system-databases/sql-dignosis.md

aaf04b6

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update reference/system-databases/cluster_hardware.md

76df3ee

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update reference/system-databases/cluster_hardware.md

76a7273

Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com>

lilin90 reviewed Apr 2, 2020

View reviewed changes

TOC.md Outdated Show resolved Hide resolved

reference/system-databases/cluster-config.md Show resolved Hide resolved

reference/system-databases/cluster-config.md Show resolved Hide resolved

TomShawn changed the title ~~reference/system-databases: add sql-diagnosis user documentation~~ reference/system-databases: add 12 new documents for sql diagnosis Apr 2, 2020

reafans and others added 5 commits April 3, 2020 11:34

Update reference/system-databases/cluster-config.md

5f30f52

Co-Authored-By: Lilian Lee <lilin@pingcap.com>

Update TOC.md

ccb0a64

Co-Authored-By: Lilian Lee <lilin@pingcap.com>

Delete SELECT GREATEST(t1.avg_value,.sql

2f0a3c9

reference: add summaries for newly added docs

0ac939b

Merge branch 'master' into sql-dignosis

3cd1fe6

lilin90 reviewed Apr 3, 2020

View reviewed changes

toc: fix a link placement issue

eac7895

lilin90 approved these changes Apr 3, 2020

View reviewed changes

lilin90 merged commit 6454faf into pingcap:master Apr 3, 2020

TomShawn mentioned this pull request Apr 5, 2020

reference: add sql diagnosis overview pingcap/docs#2172

Merged

5 tasks

sre-bot mentioned this pull request Apr 7, 2020

reference: add sql diagnosis overview (#2172) pingcap/docs#2183

Merged

5 tasks

TomShawn mentioned this pull request Apr 8, 2020

reference/system-databases: add 3 system table docs pingcap/docs#2202

Merged

5 tasks

sre-bot mentioned this pull request Apr 8, 2020

reference/system-databases: add 3 system table docs (#2202) pingcap/docs#2204

Merged

5 tasks

This was referenced Apr 8, 2020

reference/system-databases: add 3 cluster tables (2) pingcap/docs#2212

Merged

reference: add 3 metrics system tables pingcap/docs#2251

Merged

reference: add 2 inspection tables pingcap/docs#2261

Merged

reafans deleted the sql-dignosis branch April 14, 2020 05:47

TomShawn mentioned this pull request Apr 14, 2020

reference: fix typos and refine sql diagnosis related documents #2737

Merged

5 tasks

TomShawn 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 Apr 15, 2020

sre-bot mentioned this pull request Apr 15, 2020

reference: fix typos and refine sql diagnosis related documents (#2737) #2754

Merged

5 tasks

reafans mentioned this pull request Apr 15, 2020

reference: refine sql diagnosis #2756

Merged

5 tasks

This was referenced Apr 21, 2020

reference/system-databases: add 3 cluster tables (2) (#2212) pingcap/docs#2359

Merged

reference: add 3 metrics system tables (#2251) pingcap/docs#2394

Merged

reference: add 2 inspection tables (#2261) pingcap/docs#2395

Merged

sre-bot mentioned this pull request Apr 29, 2020

reference: refine sql diagnosis. (#2756) #2923

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

reference/system-databases: add 12 new documents for sql diagnosis #2522

reference/system-databases: add 12 new documents for sql diagnosis #2522

reafans commented Mar 19, 2020 •

edited by lilin90

Loading

TomShawn left a comment

TomShawn Mar 23, 2020 •

edited

Loading

reafans Mar 25, 2020

TomShawn left a comment

TomShawn Mar 24, 2020

lilin90 Apr 3, 2020

kissmydb commented Apr 3, 2020

lilin90 left a comment


		# SQL DIAGNOSIS

		SQL 诊断功能是由 TiDB 4.0 引入的新特性，主要用于提升 TiDB 问题定位效率，相较于 4.0 版本之前，不同的信息需要使用不同工具获取的异构方式，

	SQL 诊断功能是由 TiDB 4.0 引入的新特性，主要用于提升 TiDB 问题定位效率，相较于 4.0 版本之前，不同的信息需要使用不同工具获取的异构方式，
	SQL 诊断功能是在 TiDB 4.0 版本中引入的特性，用于提升 TiDB 问题定位的效率。TiDB 4.0 版本以前，用户需要使用不同工具获取以异构的方式获取不同信息。

	* STATUS_ADDRESS：HTTP API 服务地址，部分 tikv-ctl / pd-ctl / tidb-ctl 命令会使用到 HTTP API，会使用这个地址，用户也可以通过这个地址获取一些额外的集群信息，具体 HTTP API 参考官方文档
	* `STATUS_ADDRESS`：HTTP API 的服务地址。部分 tikv-ctl / pd-ctl / tidb-ctl 命令会使用到 HTTP API 和该地址。用户也可以通过该地址获取一些额外的集群信息，详情可参考 HTTP API 官方文档。

reference/system-databases: add 12 new documents for sql diagnosis #2522

reference/system-databases: add 12 new documents for sql diagnosis #2522

Conversation

reafans commented Mar 19, 2020 • edited by lilin90 Loading

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)?

TomShawn left a comment

Choose a reason for hiding this comment

TomShawn Mar 23, 2020 • edited Loading

Choose a reason for hiding this comment

reafans Mar 25, 2020

Choose a reason for hiding this comment

TomShawn left a comment

Choose a reason for hiding this comment

TomShawn Mar 24, 2020

Choose a reason for hiding this comment

lilin90 Apr 3, 2020

Choose a reason for hiding this comment

kissmydb commented Apr 3, 2020

lilin90 left a comment

Choose a reason for hiding this comment

reafans commented Mar 19, 2020 •

edited by lilin90

Loading

TomShawn Mar 23, 2020 •

edited

Loading