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

TomShawn · 2020-04-08T13:35:37Z

What is changed, added or deleted? (Required)

Add the cluster_load, cluster_systeminfo and cluster_log system tables.

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

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-4.0, 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: reference/system-databases: add 12 new documents for sql diagnosis docs-cn#2522
Other reference link(s):

reference/system-databases/cluster-systeminfo.md

reafans · 2020-04-09T02:33:01Z

reference/system-databases/cluster-load.md

+Field description:
+
+* `TYPE`: Corresponds to the `TYPE` field in the [`information_schema.cluster_info`](/reference/system-databases/cluster-info.md) table. The optional values are `tidb`, `pd`, and `tikv`.
+* `INSTANCE`: Corresponds to the `STATUS_ADDRESS` field in the [`information_schema.cluster_info`](/reference/system-databases/cluster-info.md) cluster information table.


@reafans I see that the Chinese version still uses STATUS_ADDRESS in cluster-load.md. Would you please check and update all necessary places for docs-cn?

We have tested some place in sql-diagnosis and fixed some unreasonable detail recently. And i will check and update the Chinese version recently。

lilin90 · 2020-04-09T08:03:36Z

reference/system-databases/cluster-load.md

+
+# CLUSTER_LOAD
+
+The `CLUSTER_LOAD` cluster load table provides the current load information of the server where each node of the TiDB cluster is located.


@reafans Please help confirm whether it's instance or node here.

Suggested change

The `CLUSTER_LOAD` cluster load table provides the current load information of the server where each node of the TiDB cluster is located.

The `CLUSTER_LOAD` cluster load table provides the current load information of the server where each instance of the TiDB cluster is located.

It is instance here.

reference/system-databases/cluster-load.md

reference/system-databases/cluster-log.md

lilin90 · 2020-04-09T08:10:25Z

reference/system-databases/cluster-log.md

+
+> **Note:**
+>
+> + All fields of the cluster log table are pushed down to the corresponding node for execution. So to reduce the overhead of using the cluster log table, specify as many conditions as possible. For example, the `select * from cluter_log where instance='tikv-1'` statement only executes the log search on the `tikv-1` node.


ditto. @reafans PTAL It seems that it should be instance. @TomShawn Please pay attention to all nodes in this PR after @reafans confirms.

The format of instance is ip:port, which represent a TiDB or TiKV instance.

The node is not accurate, maybe host is better, it represents a physical node, which contains some instance, and its format like ip.

A host only contains one instance in produciton environment mostly , and there are also some situations in which a host contains several instance. So use instance may be more accurate. All the node in this pr need be changed to instance.

All node is replaced in the recently added system table documents.

reference/system-databases/cluster-log.md

TomShawn · 2020-04-10T08:41:27Z

@reafans @lilin90 Comments addressed, PTAL again, thanks!

lilin90

LGTM

sre-bot · 2020-04-16T10:16:15Z

@reafans, @lilin90, PTAL.

sre-bot · 2020-04-18T10:15:54Z

@reafans, @lilin90, PTAL.

lilin90 · 2020-04-21T06:39:15Z

reference/system-databases/cluster-load.md

+desc cluster_load;
+```
+
+```


Adding sql to the results can also make it looks better with colors at the website.

Suggested change

```

```sql

lilin90 · 2020-04-21T06:39:44Z

reference/system-databases/cluster-load.md

+select * from cluster_load where device_type='cpu' and device_name='cpu';
+```
+
+```


Suggested change

```

```sql

lilin90 · 2020-04-21T06:40:05Z

reference/system-databases/cluster-log.md

+
+You can query cluster logs on the `CLUSTER_LOG` cluster log table. By pushing down query conditions to each instance, the impact of the query on cluster performance is less than that of the `grep` command.
+
+To get the logs of the TiDB cluster before v4.0, you need to log in to each instance to summarize logs. This cluster log table in 4.0 provides the global and time-ordered log search result, which makes it easier to track full-link events. For example, by searching logs according to the `region id`, you can query all logs in the life cycle of this Region; similarly, by searching the full link log through the slow log's `txn id`, you can query the flow and the number of keys scanned by this transaction at each instance.


Suggested change

To get the logs of the TiDB cluster before v4.0, you need to log in to each instance to summarize logs. This cluster log table in 4.0 provides the global and time-ordered log search result, which makes it easier to track full-link events. For example, by searching logs according to the `region id`, you can query all logs in the life cycle of this Region; similarly, by searching the full link log through the slow log's `txn id`, you can query the flow and the number of keys scanned by this transaction at each instance.

To get the logs of the TiDB cluster before v4.0, you need to log in to each instance to summarize logs. This cluster log table in 4.0 provides the global and time-ordered log search result, which makes it easier to track full-link events. For example, by searching logs according to the `region id`, you can query all logs in the life cycle of this Region. Similarly, by searching the full link log through the slow log's `txn id`, you can query the flow and the number of keys scanned by this transaction at each instance.

lilin90 · 2020-04-21T06:40:14Z

reference/system-databases/cluster-log.md

+desc cluster_log;
+```
+
+```


Suggested change

```

```sql

lilin90 · 2020-04-21T06:40:22Z

reference/system-databases/cluster-log.md

+select * from `CLUSTER_LOG` where message like '%ddl%' and message like '%job%58%' and type='tidb' and time > '2020-03-27 15:39:00';
+```
+
+```


Suggested change

```

```sql

lilin90 · 2020-04-21T06:40:31Z

reference/system-databases/cluster-systeminfo.md

+desc cluster_systeminfo;
+```
+
+```


Suggested change

```

```sql

lilin90 · 2020-04-21T06:40:42Z

reference/system-databases/cluster-systeminfo.md

+select * from CLUSTER_SYSTEMINFO where name like '%kernel.osrelease%'
+```
+
+```


Suggested change

```

```sql

reafans

LGTM

* reference/system-databases: add 3 cluster tables (2) * replace node with instance and address comments * change field name * add `sql` to results Co-authored-by: Lilian Lee <lilin@pingcap.com>

sre-bot · 2020-04-21T08:18:51Z

cherry pick to release-4.0 in PR #2359

* reference/system-databases: add 3 cluster tables (2) * replace node with instance and address comments * change field name * add `sql` to results Co-authored-by: Lilian Lee <lilin@pingcap.com> Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> Co-authored-by: Lilian Lee <lilin@pingcap.com>

reference/system-databases: add 3 cluster tables (2)

36f0fcd

TomShawn added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. v4.0 This PR/issue applies to TiDB v4.0. size/large Changes of a large size. needs-cherry-pick-4.0 labels Apr 8, 2020

TomShawn requested review from lilin90 and reafans April 8, 2020 13:35

reafans reviewed Apr 9, 2020

View reviewed changes

reference/system-databases/cluster-systeminfo.md Outdated Show resolved Hide resolved

reafans reviewed Apr 9, 2020

View reviewed changes

lilin90 reviewed Apr 9, 2020

View reviewed changes

TomShawn added 2 commits April 10, 2020 16:28

replace node with instance and address comments

2df80fa

change field name

179c778

yikeke added the status/PTAL This PR is ready for reviewing. label Apr 14, 2020

lilin90 reviewed Apr 14, 2020

View reviewed changes

Merge branch 'master' into cluster-table2

9b374d2

lilin90 reviewed Apr 21, 2020

View reviewed changes

add sql to results

2bb1c6e

reafans approved these changes Apr 21, 2020

View reviewed changes

Merge branch 'master' into cluster-table2

0ed1106

lilin90 merged commit 425e111 into pingcap:master Apr 21, 2020

sre-bot mentioned this pull request Apr 21, 2020

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

Merged

5 tasks

TomShawn deleted the cluster-table2 branch April 21, 2020 08:35


		# CLUSTER_LOAD

		The `CLUSTER_LOAD` cluster load table provides the current load information of the server where each node of the TiDB cluster is located.


		You can query cluster logs on the `CLUSTER_LOG` cluster log table. By pushing down query conditions to each instance, the impact of the query on cluster performance is less than that of the `grep` command.

		To get the logs of the TiDB cluster before v4.0, you need to log in to each instance to summarize logs. This cluster log table in 4.0 provides the global and time-ordered log search result, which makes it easier to track full-link events. For example, by searching logs according to the `region id`, you can query all logs in the life cycle of this Region; similarly, by searching the full link log through the slow log's `txn id`, you can query the flow and the number of keys scanned by this transaction at each instance.

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

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

Uh oh!

Conversation

TomShawn commented Apr 8, 2020 • edited 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)?

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lilin90 Apr 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reafans Apr 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TomShawn commented Apr 10, 2020

Uh oh!

lilin90 left a comment

Choose a reason for hiding this comment

Uh oh!

sre-bot commented Apr 16, 2020

Uh oh!

sre-bot commented Apr 18, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reafans left a comment

Choose a reason for hiding this comment

Uh oh!

sre-bot commented Apr 21, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

TomShawn commented Apr 8, 2020 •

edited

Loading

lilin90 Apr 9, 2020 •

edited

Loading

reafans Apr 10, 2020 •

edited

Loading