Skip to content

Commit 70c1cee

Browse files
josedev-unionmattiekat
josedev-union
and
mattiekat
authoredAug 18, 2023
chore: Use templating for datasource in grafana dashboard file (hyperlane-xyz#2542)
### Description This PR uses templating for datasource. i.e. no need to keep <prometheus> inside the dashboard json file which should be manually replaced by users. ### Drive-by changes <!-- Are there any minor or drive-by changes also included? --> ### Related issues <!-- - Fixes #[issue number here] --> ### Backward compatibility <!-- Are these changes backward compatible? Are there any infrastructure implications, e.g. changes that would prohibit deploying older commits using this infra tooling? Yes/No --> ### Testing <!-- What kind of testing have these changes undergone? None/Manual/Unit Tests --> Co-authored-by: josedev-union <[email protected]> Co-authored-by: Mattie Conover <[email protected]>
·
zksyncbetaagents-2023-08-23
1 parent ff2a495 commit 70c1cee

File tree

2 files changed

+51
-33
lines changed

2 files changed

+51
-33
lines changed
 

‎tools/grafana/README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@ updated when we want to update our published templates.
55

66
## Importing
77

8-
1. replace all instances of `<prometheus>` with your prometheus deployment name in grafana
9-
2. Create a new dashboard in grafana
10-
3. Select the gear icon "dashboard settings"
11-
4. Select "JSON Model"
12-
5. Copy/paste from the "\*.json" file
8+
1. Create a new dashboard in grafana
9+
2. Select the gear icon "dashboard settings"
10+
3. Select "JSON Model"
11+
4. Copy/paste from the "\*.json" file
1312

1413
## Exporting
1514

‎tools/grafana/validator-dashboard.json

+47-28
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
{
4343
"datasource": {
4444
"type": "prometheus",
45-
"uid": "<prometheus>"
45+
"uid": "$datasource"
4646
},
4747
"description": "Seconds between blocks for each chain",
4848
"fieldConfig": {
@@ -119,7 +119,7 @@
119119
{
120120
"datasource": {
121121
"type": "prometheus",
122-
"uid": "<prometheus>"
122+
"uid": "$datasource"
123123
},
124124
"editorMode": "code",
125125
"expr": "1 / avg by(chain)(rate(hyperlane_block_height{hyperlane_deployment=~\"$deployment\",chain=~\"$chain\",agent=\"validator\"}[$__rate_interval]))",
@@ -135,7 +135,7 @@
135135
{
136136
"datasource": {
137137
"type": "prometheus",
138-
"uid": "<prometheus>"
138+
"uid": "$datasource"
139139
},
140140
"fieldConfig": {
141141
"defaults": {
@@ -181,7 +181,7 @@
181181
{
182182
"datasource": {
183183
"type": "prometheus",
184-
"uid": "<prometheus>"
184+
"uid": "$datasource"
185185
},
186186
"editorMode": "code",
187187
"expr": "max(hyperlane_block_height{agent=\"validator\", }) by (chain)",
@@ -196,7 +196,7 @@
196196
{
197197
"datasource": {
198198
"type": "prometheus",
199-
"uid": "<prometheus>"
199+
"uid": "$datasource"
200200
},
201201
"fieldConfig": {
202202
"defaults": {
@@ -242,7 +242,7 @@
242242
{
243243
"datasource": {
244244
"type": "prometheus",
245-
"uid": "<prometheus>"
245+
"uid": "$datasource"
246246
},
247247
"editorMode": "code",
248248
"exemplar": false,
@@ -260,7 +260,7 @@
260260
{
261261
"datasource": {
262262
"type": "prometheus",
263-
"uid": "<prometheus>"
263+
"uid": "$datasource"
264264
},
265265
"description": "Count of messages signed per time window",
266266
"fieldConfig": {
@@ -333,7 +333,7 @@
333333
{
334334
"datasource": {
335335
"type": "prometheus",
336-
"uid": "<prometheus>"
336+
"uid": "$datasource"
337337
},
338338
"editorMode": "code",
339339
"expr": "max by (chain)(hyperlane_latest_checkpoint{agent=\"validator\", chain=~\"$chain\", phase=\"validator_processed\"}) - max by (chain)(hyperlane_latest_checkpoint{agent=\"validator\", chain=~\"$chain\", phase=\"validator_processed\"} offset $bucket)",
@@ -349,7 +349,7 @@
349349
{
350350
"datasource": {
351351
"type": "prometheus",
352-
"uid": "<prometheus>"
352+
"uid": "$datasource"
353353
},
354354
"description": "If running multiple validator instances, the difference between the latest and earliest observed checkpoints for each chain.",
355355
"fieldConfig": {
@@ -424,7 +424,7 @@
424424
{
425425
"datasource": {
426426
"type": "prometheus",
427-
"uid": "<prometheus>"
427+
"uid": "$datasource"
428428
},
429429
"editorMode": "code",
430430
"expr": "max by(chain) (hyperlane_latest_checkpoint{agent=\"validator\", chain=~\"$chain\", phase=\"validator_observed\"}) - min by (chain)(hyperlane_latest_checkpoint{agent=\"validator\", chain=~\"$chain\", phase=\"validator_observed\"})",
@@ -440,7 +440,7 @@
440440
{
441441
"datasource": {
442442
"type": "prometheus",
443-
"uid": "<prometheus>"
443+
"uid": "$datasource"
444444
},
445445
"fieldConfig": {
446446
"defaults": {
@@ -523,7 +523,7 @@
523523
{
524524
"datasource": {
525525
"type": "prometheus",
526-
"uid": "<prometheus>"
526+
"uid": "$datasource"
527527
},
528528
"editorMode": "code",
529529
"exemplar": false,
@@ -541,7 +541,7 @@
541541
{
542542
"datasource": {
543543
"type": "prometheus",
544-
"uid": "<prometheus>"
544+
"uid": "$datasource"
545545
},
546546
"fieldConfig": {
547547
"defaults": {
@@ -612,7 +612,7 @@
612612
{
613613
"datasource": {
614614
"type": "prometheus",
615-
"uid": "<prometheus>"
615+
"uid": "$datasource"
616616
},
617617
"editorMode": "code",
618618
"exemplar": false,
@@ -629,7 +629,7 @@
629629
{
630630
"datasource": {
631631
"type": "prometheus",
632-
"uid": "<prometheus>"
632+
"uid": "$datasource"
633633
},
634634
"description": "Total number of contract calls made by chain for a period",
635635
"fieldConfig": {
@@ -706,7 +706,7 @@
706706
{
707707
"datasource": {
708708
"type": "prometheus",
709-
"uid": "<prometheus>"
709+
"uid": "$datasource"
710710
},
711711
"editorMode": "code",
712712
"expr": "sum by (chain)(increase(hyperlane_contract_call_count{ chain=~\"$chain\", agent=\"validator\"}[$bucket]))",
@@ -722,7 +722,7 @@
722722
{
723723
"datasource": {
724724
"type": "prometheus",
725-
"uid": "<prometheus>"
725+
"uid": "$datasource"
726726
},
727727
"description": "The rate at which we are making contract calls.",
728728
"fieldConfig": {
@@ -799,7 +799,7 @@
799799
{
800800
"datasource": {
801801
"type": "prometheus",
802-
"uid": "<prometheus>"
802+
"uid": "$datasource"
803803
},
804804
"editorMode": "code",
805805
"expr": "sum by (chain) (rate(hyperlane_contract_call_count{agent=\"validator\"}[$__rate_interval]))",
@@ -815,7 +815,7 @@
815815
{
816816
"datasource": {
817817
"type": "prometheus",
818-
"uid": "<prometheus>"
818+
"uid": "$datasource"
819819
},
820820
"description": "The average contract call duration by chain",
821821
"fieldConfig": {
@@ -892,7 +892,7 @@
892892
{
893893
"datasource": {
894894
"type": "prometheus",
895-
"uid": "<prometheus>"
895+
"uid": "$datasource"
896896
},
897897
"editorMode": "code",
898898
"expr": "avg by (chain)(rate(hyperlane_contract_call_count{agent=\"validator\",chain=~\"$chain\"}[$__rate_interval]) - rate(hyperlane_contract_call_duration_seconds{agent=\"validator\",chain=~\"$chain\"}[$__rate_interval]))",
@@ -918,7 +918,7 @@
918918
{
919919
"datasource": {
920920
"type": "prometheus",
921-
"uid": "<prometheus>"
921+
"uid": "$datasource"
922922
},
923923
"description": "",
924924
"fieldConfig": {
@@ -994,7 +994,7 @@
994994
{
995995
"datasource": {
996996
"type": "prometheus",
997-
"uid": "<prometheus>"
997+
"uid": "$datasource"
998998
},
999999
"editorMode": "code",
10001000
"expr": "sum by (contract_name, function_name)(increase(hyperlane_contract_call_count{ chain=~\"$chain\", agent=\"validator\"}[$bucket]))",
@@ -1010,7 +1010,7 @@
10101010
{
10111011
"datasource": {
10121012
"type": "prometheus",
1013-
"uid": "<prometheus>"
1013+
"uid": "$datasource"
10141014
},
10151015
"description": "",
10161016
"fieldConfig": {
@@ -1086,7 +1086,7 @@
10861086
{
10871087
"datasource": {
10881088
"type": "prometheus",
1089-
"uid": "<prometheus>"
1089+
"uid": "$datasource"
10901090
},
10911091
"editorMode": "code",
10921092
"expr": "sum by (function_name,contract_name)(rate(hyperlane_contract_call_count{agent=\"validator\",chain=~\"$chain\"}[$__rate_interval]))",
@@ -1102,7 +1102,7 @@
11021102
{
11031103
"datasource": {
11041104
"type": "prometheus",
1105-
"uid": "<prometheus>"
1105+
"uid": "$datasource"
11061106
},
11071107
"description": "",
11081108
"fieldConfig": {
@@ -1178,7 +1178,7 @@
11781178
{
11791179
"datasource": {
11801180
"type": "prometheus",
1181-
"uid": "<prometheus>"
1181+
"uid": "$datasource"
11821182
},
11831183
"editorMode": "code",
11841184
"expr": "avg by (function_name,contract_name)(rate(hyperlane_contract_call_count{agent=\"validator\",chain=~\"$chain\"}[$__rate_interval]) - rate(hyperlane_contract_call_duration_seconds{agent=\"validator\",chain=~\"$chain\"}[$__rate_interval]))",
@@ -1204,6 +1204,25 @@
12041204
"tags": [],
12051205
"templating": {
12061206
"list": [
1207+
{
1208+
"current": {
1209+
"selected": true,
1210+
"text": "default",
1211+
"value": "default"
1212+
},
1213+
"hide": 0,
1214+
"includeAll": false,
1215+
"label": "Data Source",
1216+
"multi": false,
1217+
"name": "datasource",
1218+
"options": [],
1219+
"query": "prometheus",
1220+
"queryValue": "",
1221+
"refresh": 1,
1222+
"regex": "",
1223+
"skipUrlSync": false,
1224+
"type": "datasource"
1225+
},
12071226
{
12081227
"auto": true,
12091228
"auto_count": 30,
@@ -1277,7 +1296,7 @@
12771296
},
12781297
"datasource": {
12791298
"type": "prometheus",
1280-
"uid": "<prometheus>"
1299+
"uid": "$datasource"
12811300
},
12821301
"definition": "label_values(hyperlane_block_height, hyperlane_deployment)",
12831302
"hide": 0,
@@ -1308,7 +1327,7 @@
13081327
},
13091328
"datasource": {
13101329
"type": "prometheus",
1311-
"uid": "<prometheus>"
1330+
"uid": "$datasource"
13121331
},
13131332
"definition": "label_values(hyperlane_block_height{hyperlane_deployment=~\"$deployment\"}, chain)",
13141333
"hide": 0,

0 commit comments

Comments
 (0)
Please sign in to comment.