From 0c578563daf87d7ed31b68ed1a813d4356cae95b Mon Sep 17 00:00:00 2001 From: Anna Kapuscinska Date: Thu, 22 Aug 2024 20:19:07 +0100 Subject: [PATCH] observer: Improve ringbuf metrics help texts Signed-off-by: Anna Kapuscinska --- docs/content/en/docs/reference/metrics.md | 10 +++++----- pkg/observer/metrics.go | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/content/en/docs/reference/metrics.md b/docs/content/en/docs/reference/metrics.md index 969fa1df677..b38762de52d 100644 --- a/docs/content/en/docs/reference/metrics.md +++ b/docs/content/en/docs/reference/metrics.md @@ -248,23 +248,23 @@ The total number of rate limit Tetragon drops ### `tetragon_ringbuf_perf_event_errors_total` -The total number of errors when reading the Tetragon ringbuf. +Number of errors when reading Tetragon ring buffer. ### `tetragon_ringbuf_perf_event_lost_total` -The total number of Tetragon ringbuf perf events lost. +Number of perf events Tetragon ring buffer lost. ### `tetragon_ringbuf_perf_event_received_total` -The total number of Tetragon ringbuf perf events received. +Number of perf events Tetragon ring buffer received. ### `tetragon_ringbuf_queue_lost_total` -The total number of Tetragon events ring buffer queue lost. +Number of perf events Tetragon ring buffer events queue lost. ### `tetragon_ringbuf_queue_received_total` -The total number of Tetragon events ring buffer queue received. +Number of perf events Tetragon ring buffer events queue received. ### `tetragon_tracingpolicy_loaded` diff --git a/pkg/observer/metrics.go b/pkg/observer/metrics.go index aeb54e36b87..49e8624d513 100644 --- 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, }) )