observer: Improve ringbuf metrics help texts

Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
cilium · Aug 30, 2024 · 0c57856 · 0c57856
1 parent b7d73b6
commit 0c57856
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/docs/content/en/docs/reference/metrics.md b/docs/content/en/docs/reference/metrics.md
diff --git a/pkg/observer/metrics.go b/pkg/observer/metrics.go
@@ -16,32 +16,32 @@ var (
 	RingbufReceived = prometheus.NewCounter(prometheus.CounterOpts{
 		Namespace:   consts.MetricsNamespace,
 		Name:        "ringbuf_perf_event_received_total",
-		Help:        "The total number of Tetragon ringbuf perf events received.",
+		Help:        "Number of perf events Tetragon ring buffer received.",
 		ConstLabels: nil,
 	})
 	RingbufLost = prometheus.NewCounter(prometheus.CounterOpts{
 		Namespace:   consts.MetricsNamespace,
 		Name:        "ringbuf_perf_event_lost_total",
-		Help:        "The total number of Tetragon ringbuf perf events lost.",
+		Help:        "Number of perf events Tetragon ring buffer lost.",
 		ConstLabels: nil,
 	})
 	RingbufErrors = prometheus.NewCounter(prometheus.CounterOpts{
 		Namespace:   consts.MetricsNamespace,
 		Name:        "ringbuf_perf_event_errors_total",
-		Help:        "The total number of errors when reading the Tetragon ringbuf.",
+		Help:        "Number of errors when reading Tetragon ring buffer.",
 		ConstLabels: nil,
 	})
 
 	queueReceived = prometheus.NewCounter(prometheus.CounterOpts{
 		Namespace:   consts.MetricsNamespace,
 		Name:        "ringbuf_queue_received_total",
-		Help:        "The total number of Tetragon events ring buffer queue received.",
+		Help:        "Number of perf events Tetragon ring buffer events queue received.",
 		ConstLabels: nil,
 	})
 	queueLost = prometheus.NewCounter(prometheus.CounterOpts{
 		Namespace:   consts.MetricsNamespace,
 		Name:        "ringbuf_queue_lost_total",
-		Help:        "The total number of Tetragon events ring buffer queue lost.",
+		Help:        "Number of perf events Tetragon ring buffer events queue lost.",
 		ConstLabels: nil,
 	})
 )