fix: timeseries panels with bytes should set decimals=2 (#1934)

Thanks to Mamoep for raising on Discord
NetApp · Apr 14, 2023 · 83dba01 · 83dba01
1 parent 3a9ebdd
commit 83dba01
Show file tree

Hide file tree

Showing 13 changed files with 122 additions and 41 deletions.
diff --git a/cmd/tools/grafana/dashboard_test.go b/cmd/tools/grafana/dashboard_test.go
@@ -920,3 +920,47 @@ func checkHeatmapSettings(t *testing.T, path string, data []byte) {
 		}
 	})
 }
+
+func TestBytePanelsHave2Decimals(t *testing.T) {
+	visitDashboards(
+		[]string{"../../../grafana/dashboards/cmode", "../../../grafana/dashboards/storagegrid"},
+		func(path string, data []byte) {
+			checkBytePanelsHave2Decimals(t, path, data)
+		})
+}
+
+func checkBytePanelsHave2Decimals(t *testing.T, path string, data []byte) {
+	dashPath := shortPath(path)
+	byteTypes := map[string]bool{
+		"bytes":     true,
+		"decbytes":  true,
+		"bits":      true,
+		"decbits":   true,
+		"kbytes":    true,
+		"deckbytes": true,
+		"mbytes":    true,
+		"decmbytes": true,
+		"gbytes":    true,
+		"decgbytes": true,
+		"tbytes":    true,
+		"dectbytes": true,
+		"pbytes":    true,
+		"decpbytes": true,
+	}
+
+	visitAllPanels(data, func(path string, key, value gjson.Result) {
+		panelType := value.Get("type").String()
+		if panelType != "timeseries" {
+			return
+		}
+		defaultUnit := value.Get("fieldConfig.defaults.unit").String()
+		if !byteTypes[defaultUnit] {
+			return
+		}
+		decimals := value.Get("fieldConfig.defaults.decimals").String()
+		if decimals != "2" {
+			t.Errorf(`dashboard=%s path=%s panel="%s" got decimals=%s, want decimals=2`,
+				dashPath, path, value.Get("title").String(), decimals)
+		}
+	})
+}
diff --git a/grafana/dashboards/cmode/aggregate.json b/grafana/dashboards/cmode/aggregate.json
@@ -1025,7 +1025,8 @@
               }
             ]
           },
-          "unit": "bytes"
+          "unit": "bytes",
+          "decimals": 2
         },
         "overrides": []
       },
@@ -1115,7 +1116,8 @@
               }
             ]
           },
-          "unit": "bytes"
+          "unit": "bytes",
+          "decimals": 2
         },
         "overrides": []
       },
@@ -1206,7 +1208,8 @@
               }
             ]
           },
-          "unit": "bytes"
+          "unit": "bytes",
+          "decimals": 2
         },
         "overrides": []
       },
@@ -1296,7 +1299,8 @@
               }
             ]
           },
-          "unit": "bytes"
+          "unit": "bytes",
+          "decimals": 2
         },
         "overrides": []
       },
@@ -1386,7 +1390,8 @@
               }
             ]
           },
-          "unit": "bytes"
+          "unit": "bytes",
+          "decimals": 2
         },
         "overrides": []
       },
@@ -1857,7 +1862,8 @@
               }
             ]
           },
-          "unit": "bytes"
+          "unit": "bytes",
+          "decimals": 2
         },
         "overrides": []
       },
@@ -2599,7 +2605,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -2682,7 +2689,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -2765,7 +2773,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -2848,7 +2857,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -2932,7 +2942,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -3015,7 +3026,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -3581,7 +3593,6 @@
                   "mode": "off"
                 }
               },
-              "decimals": 0,
               "mappings": [],
               "min": 0,
               "thresholds": {
@@ -3593,7 +3604,8 @@
                   }
                 ]
               },
-              "unit": "kbytes"
+              "unit": "kbytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -3936,7 +3948,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -4124,7 +4137,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },

diff --git a/grafana/dashboards/cmode/cluster.json b/grafana/dashboards/cmode/cluster.json
@@ -3112,7 +3112,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -3194,7 +3195,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -3276,7 +3278,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -3358,7 +3361,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -3441,7 +3445,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -3523,7 +3528,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },

diff --git a/grafana/dashboards/cmode/disk.json b/grafana/dashboards/cmode/disk.json
@@ -1189,7 +1189,8 @@
               }
             ]
           },
-          "unit": "kbytes"
+          "unit": "kbytes",
+          "decimals": 2
         },
         "overrides": []
       },
@@ -1284,7 +1285,8 @@
               }
             ]
           },
-          "unit": "kbytes"
+          "unit": "kbytes",
+          "decimals": 2
         },
         "overrides": []
       },

diff --git a/grafana/dashboards/cmode/fsa.json b/grafana/dashboards/cmode/fsa.json
@@ -494,7 +494,8 @@
               }
             ]
           },
-          "unit": "bytes"
+          "unit": "bytes",
+          "decimals": 2
         },
         "overrides": []
       },

diff --git a/grafana/dashboards/cmode/lun.json b/grafana/dashboards/cmode/lun.json
@@ -4423,7 +4423,8 @@
                   }
                 ]
               },
-              "unit": "deckbytes"
+              "unit": "deckbytes",
+              "decimals": 2
             },
             "overrides": []
           },

diff --git a/grafana/dashboards/cmode/metadata.json b/grafana/dashboards/cmode/metadata.json
@@ -2367,7 +2367,8 @@
                   }
                 ]
               },
-              "unit": "deckbytes"
+              "unit": "deckbytes",
+              "decimals": 2
             },
             "overrides": [
               {
@@ -2493,7 +2494,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },
@@ -2815,7 +2817,8 @@
                   }
                 ]
               },
-              "unit": "bytes"
+              "unit": "bytes",
+              "decimals": 2
             },
             "overrides": []
           },

diff --git a/grafana/dashboards/cmode/qtree.json b/grafana/dashboards/cmode/qtree.json
@@ -504,7 +504,8 @@
                   }
                 ]
               },
-              "unit": "kbytes"
+              "unit": "kbytes",
+              "decimals": 2
             },
             "overrides": []
           },

diff --git a/grafana/dashboards/cmode/s3ObjectStorage.json b/grafana/dashboards/cmode/s3ObjectStorage.json
@@ -452,7 +452,8 @@
               }
             ]
           },
-          "unit": "bytes"
+          "unit": "bytes",
+          "decimals": 2
         },
         "overrides": []
       },

diff --git a/grafana/dashboards/cmode/snapmirror.json b/grafana/dashboards/cmode/snapmirror.json
@@ -1043,7 +1043,6 @@
               "mode": "off"
             }
           },
-          "decimals": 0,
           "links": [],
           "mappings": [],
           "thresholds": {
@@ -1059,7 +1058,8 @@
               }
             ]
           },
-          "unit": "bytes"
+          "unit": "bytes",
+          "decimals": 2
         },
         "overrides": []
       },