add doc on top of info metrics

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

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/internal/controller/spinapp_executor_metrics.go b/internal/controller/spinapp_executor_metrics.go
@@ -6,6 +6,10 @@ import (
 )
 
 type spinAppExecutorMetrics struct {
+	// Record executor metadata as info metric.
+	// This is particularly useful for query
+	// 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,10 @@ import (
 )
 
 type spinAppMetrics struct {
+	// Record spinapp metadata as info metric.
+	// This is particularly useful for query
+	// available app names for creating
+	// dashboards
 	infoGauge *prometheus.GaugeVec
 }