add doc on top of info metrics

Signed-off-by: Rajat Jindal <[email protected]>
spinkube · Mar 1, 2024 · b18aa69 · b18aa69
1 parent fb91987
commit b18aa69
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/internal/controller/spinapp_executor_metrics.go b/internal/controller/spinapp_executor_metrics.go
@@ -6,6 +6,9 @@ import (
 )
 
 type spinAppExecutorMetrics struct {
+	// Record executor metadata as info metric.
+	// This is particularly useful for querying
+	// available executor names for creating dashboards
 	infoGauge *prometheus.GaugeVec
 }
 

diff --git a/internal/controller/spinapp_metrics.go b/internal/controller/spinapp_metrics.go
@@ -6,6 +6,9 @@ import (
 )
 
 type spinAppMetrics struct {
+	// Record spinapp metadata as info metric.
+	// This is particularly useful for querying
+	// available app names for creating dashboards
 	infoGauge *prometheus.GaugeVec
 }