Add description for overview dashboard #908

YangKeao · 2019-08-22T06:05:25Z

Add description for grafana overview dashboard.

This json file was generated by grafana, and some fields like "scopedVars" was removed.

zhouqiang-cl · 2019-08-22T12:01:36Z

metric addr is http://172.16.4.253:3000/login

YangKeao · 2019-08-27T04:51:00Z

Now only description related change was left.

breezewish · 2019-08-27T03:12:02Z

scripts/overview.json

@@ -56,9 +56,9 @@
  },
  "editable": true,
  "gnetId": null,
-  "graphTooltip": 1,
+  "graphTooltip": 0,


Why is graph tooltip turned off?

breezewish · 2019-08-27T03:13:33Z

scripts/overview.json

@@ -2471,6 +2508,7 @@
          "dashLength": 10,
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": " \tthe number of executed KV commands",


unnecessary \t.

sticnarf · 2019-08-27T06:00:11Z

scripts/overview.json

@@ -689,6 +694,7 @@
            "rgba(50, 172, 45, 0.97)"
          ],
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the total number of Regions of the current cluster",


I think the "R" in the word "Region" needn't be capitalized.

sticnarf · 2019-08-27T06:00:26Z

scripts/overview.json

@@ -850,6 +858,7 @@
            "#d44a3a"
          ],
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the Region ratio difference of the nodes with the biggest Region ratio and the smallest Region ratio",


sticnarf · 2019-08-27T06:04:28Z

scripts/overview.json

@@ -769,6 +776,7 @@
            "#d44a3a"
          ],
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the leader ratio difference of the nodes with the biggest leader ratio and the smallest leader ratio",


Suggested change

"description": "the leader ratio difference of the nodes with the biggest leader ratio and the smallest leader ratio",

"description": "the leader ratio difference between the node with the most leaders and that with the least leaders",

sticnarf · 2019-08-27T06:09:12Z

scripts/overview.json

@@ -1039,6 +1054,7 @@
          "dashLength": 10,
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the 99th percentile duration to complete a pd-server request",


pd-server request -> PD request?

to complete -> of?

sticnarf · 2019-08-27T06:12:25Z

scripts/overview.json

@@ -2561,6 +2588,7 @@
          "dashLength": 10,
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the execution time of the KV command",


99 percentile

sticnarf · 2019-08-27T06:12:38Z

scripts/overview.json

@@ -2652,6 +2680,7 @@
          "dashLength": 10,
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the number of TSO that TiDB obtains from PD",


sticnarf · 2019-08-27T06:14:22Z

scripts/overview.json

@@ -2747,6 +2776,7 @@
          "dashLength": 10,
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the time consumed when TiDB obtains TSO from PD",


Could you please confirm what it really means from TiDB developers?

sticnarf · 2019-08-27T06:15:06Z

scripts/overview.json

@@ -2852,6 +2882,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 2,
+          "description": "the number of Region related errors returned by TiKV",


sticnarf · 2019-08-27T06:16:52Z

scripts/overview.json

@@ -2943,6 +2974,7 @@
          "dashLength": 10,
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the number of transaction related conflicts",


The description is not accurate. Lock resolving doesn't mean conflicts. If you must add description to it, I prefer just use its literal meaning.

sticnarf · 2019-08-27T06:17:35Z

scripts/overview.json

@@ -3130,6 +3163,7 @@
          "dashLength": 10,
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the number of errors returned by TiKV (such as transaction conflicts )",


unnecessary space

sticnarf · 2019-08-27T06:17:51Z

scripts/overview.json

@@ -3035,6 +3067,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": null,
+          "description": "the time consumed when TiDB obtains Schema from TiKV",


schema is not obtained from tikv...

sticnarf · 2019-08-27T06:19:39Z

scripts/overview.json

@@ -3986,6 +4028,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 1,
+          "description": "the number of commits on queue",


Suggested change

"description": "the number of commits on queue",

"description": "the number of commands in queue",

sticnarf · 2019-08-27T06:20:17Z

scripts/overview.json

@@ -4166,6 +4210,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 5,
+          "description": "the time consumed by TiKV queries",


TiKV queries -> TiDB queries?

The handle time of each Coprocessor request

sticnarf · 2019-08-27T06:21:09Z

scripts/overview.json

@@ -4471,6 +4518,7 @@
        {
          "columns": [],
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": " \tthe number of CPU cores",


unnecessary \t

sticnarf · 2019-08-27T06:22:00Z

scripts/overview.json

@@ -5036,6 +5089,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 1,
+          "description": " \tthe statistics about network monitoring and TCP",


remove leading \t

sticnarf · 2019-08-27T06:22:48Z

scripts/overview.json

@@ -5126,6 +5180,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 0,
+          "description": "the disk usage ratio, 100% at a maximum; generally you need to consider adding a new node when the usage ratio is up to 80% ~ 90%",


What's the source of 80% ~ 90%?

sticnarf · 2019-08-27T06:24:47Z

Actually, I think we don't need to add descriptions to all panels. For example, panel names like CPU usage or memory available are quite clear enough.

YangKeao · 2019-08-27T06:26:35Z

@sticnarf All these descriptions are copied from here. As you have pointed out there are many mistakes. Maybe I could modify both places 😢 .

breezewish · 2019-08-28T09:55:19Z

scripts/overview.json

@@ -79,6 +79,7 @@
            }
          ],
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the online nodes number of each service",


The number of online nodes

breezewish · 2019-08-28T09:55:26Z

scripts/overview.json

@@ -250,6 +251,7 @@
            }
          ],
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the offline nodes number of each service",


The number of ...

breezewish · 2019-08-28T09:56:25Z

scripts/overview.json

@@ -522,6 +524,7 @@
          ],
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": null,
+          "description": "the total storage capacity of the TiDB cluster",


of TiKV nodes?

breezewish · 2019-08-28T10:04:14Z

scripts/overview.json

@@ -606,6 +609,7 @@
          ],
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 1,
+          "description": "the occupied storage capacity of the TiDB cluster",


The data size?

breezewish · 2019-08-28T10:05:26Z

scripts/overview.json

@@ -1039,6 +1054,7 @@
          "dashLength": 10,
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the 99th percentile duration to complete a pd-server request",


to complete -> of?

breezewish · 2019-08-28T10:10:20Z

scripts/overview.json

@@ -3702,6 +3741,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 1,
+          "description": "the data amount on different CFs in the cluster",


breezewish · 2019-08-28T10:11:45Z

scripts/overview.json

@@ -4075,6 +4118,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 1,
+          "description": "the number of various query operations",


The total number of Coprocessor executors in received requests per second

breezewish · 2019-08-28T10:13:18Z

scripts/overview.json

@@ -4166,6 +4210,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 5,
+          "description": "the time consumed by TiKV queries",


The handle time of each Coprocessor request

breezewish · 2019-08-28T10:15:25Z

scripts/overview.json

@@ -4559,6 +4607,7 @@
        {
          "columns": [],
          "datasource": "${DS_TEST-CLUSTER}",
+          "description": "the total memory",


The total memory of each node

breezewish · 2019-08-28T10:15:58Z

scripts/overview.json

@@ -4765,6 +4815,7 @@
          "dashes": false,
          "datasource": "${DS_TEST-CLUSTER}",
          "decimals": 1,
+          "description": "the overload within 1 minute",


YangKeao added 2 commits August 22, 2019 13:07

Add description on overview.json

0f5db5c

Remove scopedVars

3691db8

YangKeao requested a review from mahjonp August 22, 2019 09:02

YangKeao added 4 commits August 23, 2019 11:14

Reformat json file with jq

9af23dd

refractor to suit original json

3eafaf0

left only description related commit

d4bb25d

change some y value

18842c8

breezewish reviewed Aug 27, 2019

View reviewed changes

sticnarf reviewed Aug 27, 2019

View reviewed changes

breezewish reviewed Aug 28, 2019

View reviewed changes

	"description": "the leader ratio difference of the nodes with the biggest leader ratio and the smallest leader ratio",
	"description": "the leader ratio difference between the node with the most leaders and that with the least leaders",

	"description": "the number of commits on queue",
	"description": "the number of commands in queue",

Add description for overview dashboard #908

Are you sure you want to change the base?

Add description for overview dashboard #908

Conversation

YangKeao commented Aug 22, 2019

zhouqiang-cl commented Aug 22, 2019 • edited Loading

YangKeao commented Aug 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sticnarf Aug 27, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sticnarf commented Aug 27, 2019

YangKeao commented Aug 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhouqiang-cl commented Aug 22, 2019 •

edited

Loading

sticnarf Aug 27, 2019 •

edited

Loading