Update grafana tikv dashboard doc by Win-Man · Pull Request #3042 · pingcap/docs

Win-Man · 2020-06-26T15:32:24Z

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

This PR is translated from: Update grafana tikv dashboard doc docs-cn#3150
Other reference link(s):

CLAassistant · 2020-06-26T15:32:29Z

All committers have signed the CLA.

TomShawn · 2020-06-28T02:49:10Z

-This section shows images of the service panels on the TiKV dashboard.
-
-### Cluster
+# The metrics description of TiKV


Please also change Line 2 and Line 3 accordingly.

Suggested change

# The metrics description of TiKV

# Description of TiKV Monitoring Metrics

TomShawn · 2020-06-28T02:50:52Z

+
+If you use TiUP to deploy the TiDB cluster, the monitoring system (Prometheus/Grafana) is deployed at the same time. For more information, see [Overview of the Monitoring Framework](/tidb-monitoring-framework.md).
+
+The Grafana dashboard is divided into a series of sub dashboards which include Overview, PD, TiDB, TiKV, Node\_exporter, and so on. A lot of metrics are there to help you diagnose.


Suggested change

The Grafana dashboard is divided into a series of sub dashboards which include Overview, PD, TiDB, TiKV, Node\_exporter, and so on. A lot of metrics are there to help you diagnose.

The Grafana dashboard is divided into a series of sub dashboards which include Overview, PD, TiDB, TiKV, Node_exporter, and so on. A lot of metrics are there to help you diagnose.

TomShawn · 2020-06-28T02:55:59Z

+
+The Grafana dashboard is divided into a series of sub dashboards which include Overview, PD, TiDB, TiKV, Node\_exporter, and so on. A lot of metrics are there to help you diagnose.
+
+You can get an overview of the component TiKV status from the TiKV dashboard, where the key metrics are displayed. According to the [Performance Map](https://asktug.com/_/tidb-performance-map/#/), you can check whether the status of the cluster is as expected.


Suggested change

You can get an overview of the component TiKV status from the TiKV dashboard, where the key metrics are displayed. According to the [Performance Map](https://asktug.com/_/tidb-performance-map/#/), you can check whether the status of the cluster is as expected.

You can get an overview of the component TiKV status from the **TiKV-Details** dashboard, where the key metrics are displayed. According to the [Performance Map](https://asktug.com/_/tidb-performance-map/#/), you can check whether the status of the cluster is as expected.

TomShawn · 2020-06-28T02:56:50Z

+
+You can get an overview of the component TiKV status from the TiKV dashboard, where the key metrics are displayed. According to the [Performance Map](https://asktug.com/_/tidb-performance-map/#/), you can check whether the status of the cluster is as expected.
+
+This document provides a detailed description of these key metrics.


Suggested change

This document provides a detailed description of these key metrics.

This document provides a detailed description of these key metrics on the **TiKV-Details** dashboard.

TomShawn · 2020-06-28T03:05:11Z

+- IO utilization：The I/O utilization per TiKV instance
+- MBps：The total bytes of read and write in each TiKV instance
+- QPS：The QPS per command in each TiKV instance
+- Errps：The total number of gRPC message failures


Suggested change

- Errps：The total number of gRPC message failures

- Errps：The rate of gRPC message failures

TomShawn · 2020-06-28T03:20:44Z

+- Channel full：The number of Channel Full errors per TiKV instance. It should be `0` in normal case.
+- Active written leaders：The number of leaders being written on each TiKV instance
+- Approximate Region size：The approximate Region size
+- Approximate Region size Histogram：The histogram of approximate Region size


Suggested change

- Approximate Region size Histogram：The histogram of approximate Region size

- Approximate Region size Histogram：The histogram of each approximate Region size

TomShawn · 2020-06-28T04:39:10Z

+- Flush messages per server：The number of Raft messages flushed by each TiKV instance
+- Receive messages per server：The number of Raft messages received by each TiKV instance
+- Messages：The number of Raft messages sent per type
+- Vote：The number of Vote messages sent in Raft


Suggested change

- Vote：The number of Vote messages sent in Raft

- Vote：The number of Vote messages sent in Raft per second

TomShawn · 2020-06-28T04:39:28Z

+- Receive messages per server：The number of Raft messages received by each TiKV instance
+- Messages：The number of Raft messages sent per type
+- Vote：The number of Vote messages sent in Raft
+- Raft dropped messages：The number of dropped Raft messages per type


The Chinese version says ops, which means operations per second. So please check and align.

Suggested change

- Raft dropped messages：The number of dropped Raft messages per type

- Raft dropped messages：The number of dropped Raft messages per type per second

TomShawn · 2020-06-28T04:50:54Z

+- Raft apply proposals per ready：The number of Raft proposals of all Regions per ready handled bucket
+- Raft read/write proposals：The number of proposals per type
+- Raft read proposals per server：The number of read proposals made by each TiKV instance
+- Raft write proposals per server：The number of write proposals made by each TiKV instance
+- Propose wait duration：The wait time of each proposal
+- Propose wait duration per server：The wait time of each proposal per TiKV instance
+- Apply wait duration：The apply time of each proposal
+- Apply wait duration per server：The apply time of each proposal per TiKV instance
+- Raft log speed：The rate at which peers propose logs


@Win-Man This part is not consistent with the Chinese version. Please check and align.

TomShawn · 2020-06-28T05:30:05Z

+## 面板常见参数的解释
+
+### gRPC 消息类型
+
+1. 使用事务型接口的命令：


Please translate the Chinese text.

TomShawn · 2020-06-28T05:30:15Z

+    - kv_gc：The command of GC
+    - kv_delete_range：The command of deleting a continuous piece of data from TiKV
+
+2. 非事务型的裸命令：


TomShawn

This first round of review.
Please address the comments first and I'll review for the second round.
@Win-Man

Win-Man · 2020-06-28T11:26:44Z

@TomShawn Thanks for your review, I've fixed what you commented.

Win-Man · 2020-06-29T00:12:33Z

@TomShawn PTAL

ti-srebot · 2020-06-30T05:34:48Z

@TomShawn, @hunterlxt, PTAL.

ti-srebot · 2020-06-30T15:06:07Z

@Win-Man, please update your pull request.

hunterlxt · 2020-07-01T06:46:06Z

+1. Transactional API：
+
+    - kv_get：The command of getting the latest version of data specified by ts
+    - kv_scan：The command of scanning a continuous piece of data


use "a range of data"

hunterlxt · 2020-07-01T06:46:28Z

+    - kv_scan_lock：The command of scanning all locks with a version number before `max_version` to clean up expired transactions
+    - kv_resolve_lock：The command of committing or rollback the transaction lock, according to the transaction status.
+    - kv_gc：The command of GC
+    - kv_delete_range：The command of deleting a continuous piece of data from TiKV


hunterlxt · 2020-07-01T06:46:34Z

+
+    - raw_get：The command of getting the value of key
+    - raw_batch_get：The command of getting the value of batch keys
+    - raw_scan：The command of scanning a continuous piece of data


hunterlxt · 2020-07-01T06:46:41Z

+    - raw_batch_put：The command of writing a batch of key/value pairs
+    - raw_delete：The command of deleting a key/value pair
+    - raw_batch_delete：The command of a batch of key/value pairs
+    - raw_delete_range：The command of deleting a continuous interval


ditto, use data rather than inerval

ti-srebot · 2020-07-02T15:05:21Z

@Win-Man, please update your pull request.

ti-srebot · 2020-07-03T06:48:28Z

@TomShawn, @hunterlxt, PTAL.

…into tikv-monitor-metrics

ti-srebot · 2020-07-05T06:48:37Z

@TomShawn, @hunterlxt, PTAL.

ti-srebot · 2020-07-05T15:46:36Z

@Win-Man, please update your pull request.

ti-srebot · 2020-07-08T02:25:05Z

@Win-Man, please update your pull request.

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

ti-srebot · 2020-07-09T07:53:05Z

@TomShawn, @hunterlxt, PTAL.

ti-srebot · 2020-07-10T14:48:53Z

@Win-Man, please update your pull request.

ti-srebot · 2020-07-11T07:52:53Z

@TomShawn, @hunterlxt, PTAL.

TomShawn

LGTM
@hunterlxt PTAL

ti-srebot · 2020-07-16T07:49:15Z

@TomShawn, @hunterlxt, PTAL.

ti-srebot · 2020-07-16T07:49:18Z

@Win-Man, please update your pull request.

hunterlxt

Rest LGTM

ti-srebot · 2020-07-18T07:49:14Z

@Win-Man, please update your pull request.

Win-Man · 2020-07-18T13:58:23Z

@hunterlxt PTAL

ti-srebot · 2020-07-18T18:10:22Z

@hunterlxt,Thanks for your review. However, LGTM is restricted to Reviewers or higher roles.See the corresponding SIG page for more information. Related SIGs: docs(slack).

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot · 2020-07-20T02:37:15Z

cherry pick to release-4.0 in PR #3333

Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Win-Man <825895587@qq.com>

Update grafana tikv dashboard doc

38caf95

fix lint

e06f91c

yikeke requested review from TomShawn and hunterlxt June 28, 2020 02:05

yikeke added needs-cherry-pick-4.0 status/PTAL This PR is ready for reviewing. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. labels Jun 28, 2020

TomShawn reviewed Jun 28, 2020

View reviewed changes

TomShawn added size/large Changes of a large size. status/require-change Needs the author to address comments. and removed status/PTAL This PR is ready for reviewing. labels Jun 28, 2020

Win-Man added 2 commits June 28, 2020 19:18

Fix first round of review

763e69d

fix

ba0a764

Fix some errors like ops

ffe3c1b

Merge branch 'master' into tikv-monitor-metrics

f442cf1

hunterlxt reviewed Jul 1, 2020

View reviewed changes

Win-Man added 2 commits July 3, 2020 23:41

fix ditto

a85ad8c

Merge branch 'tikv-monitor-metrics' of https://github.com/Win-Man/docs …

017fda1

…into tikv-monitor-metrics

Merge branch 'master' into tikv-monitor-metrics

c219bc0

Win-Man and others added 4 commits July 8, 2020 12:53

Update grafana-tikv-dashboard.md

bf2881a

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update grafana-tikv-dashboard.md

2d21f20

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update grafana-tikv-dashboard

0e9613d

Merge branch 'master' into tikv-monitor-metrics

d06947c

Merge branch 'master' into tikv-monitor-metrics

e248917

TomShawn reviewed Jul 14, 2020

View reviewed changes

Comment thread grafana-tikv-dashboard.md

TomShawn added 2 commits July 14, 2020 14:34

Update grafana-tikv-dashboard.md

b672b2a

fix typos and refine format

0546baf

TomShawn reviewed Jul 14, 2020

View reviewed changes

Comment thread grafana-tikv-dashboard.md Outdated

Update grafana-tikv-dashboard.md

3c91884

TomShawn approved these changes Jul 14, 2020

View reviewed changes

ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Jul 14, 2020

hunterlxt reviewed Jul 17, 2020

View reviewed changes

Comment thread grafana-tikv-dashboard.md Outdated

add content

9b8d7f2

hunterlxt approved these changes Jul 18, 2020

View reviewed changes

Merge branch 'master' into tikv-monitor-metrics

5cef3a7

TomShawn merged commit 5b1a811 into pingcap:master Jul 20, 2020

ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Jul 20, 2020

cherry pick pingcap#3042 to release-4.0

65f03bd

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot mentioned this pull request Jul 20, 2020

Update grafana tikv dashboard doc (#3042) #3333

Merged

5 tasks

TomShawn pushed a commit that referenced this pull request Jul 20, 2020

cherry pick #3042 to release-4.0 (#3333)

2b2db29

Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Win-Man <825895587@qq.com>

	# The metrics description of TiKV
	# Description of TiKV Monitoring Metrics


		If you use TiUP to deploy the TiDB cluster, the monitoring system (Prometheus/Grafana) is deployed at the same time. For more information, see [Overview of the Monitoring Framework](/tidb-monitoring-framework.md).

		The Grafana dashboard is divided into a series of sub dashboards which include Overview, PD, TiDB, TiKV, Node\_exporter, and so on. A lot of metrics are there to help you diagnose.


		The Grafana dashboard is divided into a series of sub dashboards which include Overview, PD, TiDB, TiKV, Node\_exporter, and so on. A lot of metrics are there to help you diagnose.

		You can get an overview of the component TiKV status from the TiKV dashboard, where the key metrics are displayed. According to the [Performance Map](https://asktug.com/_/tidb-performance-map/#/), you can check whether the status of the cluster is as expected.


		You can get an overview of the component TiKV status from the TiKV dashboard, where the key metrics are displayed. According to the [Performance Map](https://asktug.com/_/tidb-performance-map/#/), you can check whether the status of the cluster is as expected.

		This document provides a detailed description of these key metrics.

	- Errps：The total number of gRPC message failures
	- Errps：The rate of gRPC message failures

	- Approximate Region size Histogram：The histogram of approximate Region size
	- Approximate Region size Histogram：The histogram of each approximate Region size

	- Vote：The number of Vote messages sent in Raft
	- Vote：The number of Vote messages sent in Raft per second

	- Raft dropped messages：The number of dropped Raft messages per type
	- Raft dropped messages：The number of dropped Raft messages per type per second

Conversation

Win-Man commented Jun 26, 2020

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!

CLAassistant commented Jun 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

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!

TomShawn left a comment • 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!

Win-Man commented Jun 28, 2020

Uh oh!

Win-Man commented Jun 29, 2020

Uh oh!

ti-srebot commented Jun 30, 2020

Uh oh!

ti-srebot commented Jun 30, 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!

ti-srebot commented Jul 2, 2020

Uh oh!

ti-srebot commented Jul 3, 2020

Uh oh!

ti-srebot commented Jul 5, 2020

Uh oh!

ti-srebot commented Jul 5, 2020

Uh oh!

ti-srebot commented Jul 8, 2020

Uh oh!

ti-srebot commented Jul 9, 2020

Uh oh!

ti-srebot commented Jul 10, 2020

Uh oh!

ti-srebot commented Jul 11, 2020

Uh oh!

Uh oh!

Uh oh!

TomShawn left a comment • 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!

ti-srebot commented Jul 16, 2020

Uh oh!

ti-srebot commented Jul 16, 2020

Uh oh!

hunterlxt left a comment

Choose a reason for hiding this comment

Uh oh!

CLAassistant commented Jun 26, 2020 •

edited

Loading

TomShawn left a comment •

edited

Loading

TomShawn left a comment •

edited

Loading