✨ add custom units for custom grafana dashboards

Signed-off-by: Jirka Kremser <jiri.kremser@gmail.com>
kubernetes-sigs · Oct 6, 2022 · 2e10ba8 · 2e10ba8
1 parent eec9f37
commit 2e10ba8
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 3 deletions.
diff --git a/docs/book/src/plugins/grafana-v1-alpha.md b/docs/book/src/plugins/grafana-v1-alpha.md
@@ -146,6 +146,7 @@ customMetrics:
 #  - metric: # Raw custom metric (required)
 #    type:   # Metric type: counter/gauge/histogram (required)
 #    expr:   # Prom_ql for the metric (optional)
+#    unit:   # Unit of measurement, examples: s,none,bytes,percent,etc. (optional)
 ```
 
 #### Add Custom Metrics to Config
@@ -159,6 +160,7 @@ Alternatively, you can provide `expr` and the plugin will use the specified one
 customMetrics:
   - metric: memcached_operator_reconcile_total # Raw custom metric (required)
     type: counter # Metric type: counter/gauge/histogram (required)
+    unit: none
   - metric: memcached_operator_reconcile_time_seconds_bucket
     type: histogram
 ```

diff --git a/pkg/plugins/optional/grafana/v1alpha/scaffolds/edit.go b/pkg/plugins/optional/grafana/v1alpha/scaffolds/edit.go
@@ -102,10 +102,11 @@ func validateCustomMetricItems(rawItems []templates.CustomMetricItem) []template
 		}
 	}
 
-	// 2. Fill Expr if missing
+	// 2. Fill Expr and Unit if missing
 	validatedItems := make([]templates.CustomMetricItem, len(filterResult))
 	for i, item := range filterResult {
-		validatedItems[i] = fillMissingExpr(item)
+		item = fillMissingExpr(item)
+		validatedItems[i] = fillMissingUnit(item)
 	}
 
 	return validatedItems
@@ -142,6 +143,21 @@ func fillMissingExpr(item templates.CustomMetricItem) templates.CustomMetricItem
 	return item
 }
 
+func fillMissingUnit(item templates.CustomMetricItem) templates.CustomMetricItem {
+	if item.Unit == "" {
+		name := strings.ToLower(item.Metric)
+		item.Unit = "none"
+		if strings.Contains(name, "second") || strings.Contains(name, "duration") {
+			item.Unit = "s"
+		} else if strings.Contains(name, "byte") {
+			item.Unit = "bytes"
+		} else if strings.Contains(name, "ratio") {
+			item.Unit = "percent"
+		}
+	}
+	return item
+}
+
 // Scaffold implements cmdutil.Scaffolder
 func (s *editScaffolder) Scaffold() error {
 	fmt.Println("Generating Grafana manifests to visualize controller status...")

diff --git a/pkg/plugins/optional/grafana/v1alpha/scaffolds/internal/templates/custom.go b/pkg/plugins/optional/grafana/v1alpha/scaffolds/internal/templates/custom.go
@@ -45,12 +45,14 @@ customMetrics:
 #  - metric: # Raw custom metric (required)
 #    type:   # Metric type: counter/gauge/histogram (required)
 #    expr:   # Prom_ql for the metric (optional)
+#    unit:   # Unit of measurement, examples: s,none,bytes,percent,etc. (optional)
 #
 #
 # Example:
 # ---
 # customMetrics:
 #   - metric: foo_bar
+#     unit: none
 #     type: histogram
 #   	expr: histogram_quantile(0.90, sum by(instance, le) (rate(foo_bar{job=\"$job\", namespace=\"$namespace\"}[5m])))
 `
diff --git a/pkg/plugins/optional/grafana/v1alpha/scaffolds/internal/templates/custom_metrics.go b/pkg/plugins/optional/grafana/v1alpha/scaffolds/internal/templates/custom_metrics.go
@@ -20,6 +20,7 @@ import (
 	"bytes"
 	"fmt"
 	"path/filepath"
+	"strings"
 	"text/template"
 
 	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
@@ -33,6 +34,7 @@ type CustomMetricItem struct {
 	Metric string `json:"metric"`
 	Type   string `json:"type"`
 	Expr   string `json:"expr,omitempty"`
+	Unit   string `json:"unit,omitempty"`
 }
 
 var _ machinery.Template = &CustomMetricsDashManifest{}
@@ -66,6 +68,7 @@ var fns = template.FuncMap{
 	"plus1": func(x int) int {
 		return x + 1
 	},
+	"hasSuffix": strings.HasSuffix,
 }
 
 func (f *CustomMetricsDashManifest) createTemplate() (string, error) {
@@ -173,7 +176,7 @@ const customMetricsDashTemplate = `{
               }
             ]
           },
-          "unit": "s"
+          "unit": "{{ .Unit }}"
         },
         "overrides": []
       },
@@ -208,7 +211,19 @@ const customMetricsDashTemplate = `{
         }
       ],
       "title": "{{ .Metric }} ({{ .Type }})",
+{{- if hasSuffix .Metric "_info" }}
+      "transformations": [
+        {
+          "id": "labelsToFields",
+          "options": {
+            "mode": "rows"
+          }
+        }
+      ],
+      "type": "table"
+{{- else }}
       "type": "timeseries"
+{{- end }}
     }{{ if ne (plus1 $i) $n }},
 		{{end}}{{end}}
   ],

diff --git a/testdata/project-v3-addon-and-grafana/grafana/custom-metrics/config.yaml b/testdata/project-v3-addon-and-grafana/grafana/custom-metrics/config.yaml
@@ -3,11 +3,13 @@ customMetrics:
 #  - metric: # Raw custom metric (required)
 #    type:   # Metric type: counter/gauge/histogram (required)
 #    expr:   # Prom_ql for the metric (optional)
+#    unit:   # Unit of measurement, examples: s,none,bytes,percent,etc. (optional)
 #
 #
 # Example:
 # ---
 # customMetrics:
 #   - metric: foo_bar
+#     unit: none
 #     type: histogram
 #   	expr: histogram_quantile(0.90, sum by(instance, le) (rate(foo_bar{job=\"$job\", namespace=\"$namespace\"}[5m])))
diff --git a/testdata/project-v4-addon-and-grafana/grafana/custom-metrics/config.yaml b/testdata/project-v4-addon-and-grafana/grafana/custom-metrics/config.yaml
@@ -3,11 +3,13 @@ customMetrics:
 #  - metric: # Raw custom metric (required)
 #    type:   # Metric type: counter/gauge/histogram (required)
 #    expr:   # Prom_ql for the metric (optional)
+#    unit:   # Unit of measurement, examples: s,none,bytes,percent,etc. (optional)
 #
 #
 # Example:
 # ---
 # customMetrics:
 #   - metric: foo_bar
+#     unit: none
 #     type: histogram
 #   	expr: histogram_quantile(0.90, sum by(instance, le) (rate(foo_bar{job=\"$job\", namespace=\"$namespace\"}[5m])))