Skip to content

Commit

Permalink
observer: Rename ringbuf metrics
Browse files Browse the repository at this point in the history
Use more consistent names for easier querying.

Signed-off-by: Anna Kapuscinska <[email protected]>
  • Loading branch information
lambdanis committed Aug 30, 2024
1 parent 333719a commit ed28783
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 25 deletions.
6 changes: 6 additions & 0 deletions contrib/upgrade-notes/latest.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,9 @@ tetragon:
* `tetragon_policyfilter_metrics_total` metric is renamed to `tetragon_policyfilter_operations_total`, and its `op`
label is renamed to `operation`.
* `tetragon_missed_events_total` metric is renamed to `tetragon_bpf_missed_events_total`.
* Metrics related to ring buffer and events queue are renamed:
* `tetragon_ringbuf_perf_event_errors_total` -> `tetragon_observer_ringbuf_errors_total`
* `tetragon_ringbuf_perf_event_received_total` -> `tetragon_observer_ringbuf_events_received_total`
* `tetragon_ringbuf_perf_event_lost_total` -> `tetragon_observer_ringbuf_events_lost_total`
* `tetragon_ringbuf_queue_received_total` -> `tetragon_observer_ringbuf_queue_events_received_total`
* `tetragon_ringbuf_queue_lost_total` -> `tetragon_observer_ringbuf_queue_events_lost_total`
40 changes: 20 additions & 20 deletions docs/content/en/docs/reference/metrics.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 14 additions & 5 deletions pkg/observer/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,47 @@ import (
"github.com/prometheus/client_golang/prometheus"
)

const (
subsystem = "observer"
)

var (
// TODO: These metrics are also stored as Observer struct fields. We could
// collect them only once: https://github.com/cilium/tetragon/issues/2834

RingbufReceived = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: consts.MetricsNamespace,
Name: "ringbuf_perf_event_received_total",
Subsystem: subsystem,
Name: "ringbuf_events_received_total",
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",
Subsystem: subsystem,
Name: "ringbuf_events_lost_total",
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",
Subsystem: subsystem,
Name: "ringbuf_errors_total",
Help: "Number of errors when reading Tetragon ring buffer.",
ConstLabels: nil,
})

queueReceived = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: consts.MetricsNamespace,
Name: "ringbuf_queue_received_total",
Subsystem: subsystem,
Name: "ringbuf_queue_events_received_total",
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",
Subsystem: subsystem,
Name: "ringbuf_queue_events_lost_total",
Help: "Number of perf events Tetragon ring buffer events queue lost.",
ConstLabels: nil,
})
Expand Down

0 comments on commit ed28783

Please sign in to comment.