From 17c5346e26df76bb0f969d4b4e9e152300fb6b6e Mon Sep 17 00:00:00 2001
From: Anna Kapuscinska <anna@isovalent.com>
Date: Sat, 24 Aug 2024 11:16:29 +0100
Subject: [PATCH] eventmetrics: Rename tetragon_missed_events_total

There are a few places where events be "missed", so let's make it clear in the
metric name that's it's counting kernel misses.

Signed-off-by: Anna Kapuscinska <anna@isovalent.com>
---
 contrib/upgrade-notes/latest.md                |  1 +
 docs/content/en/docs/reference/metrics.md      | 18 +++++++++---------
 .../{collector.go => bpfcollector.go}          |  0
 pkg/metrics/eventmetrics/eventmetrics.go       |  4 ++--
 4 files changed, 12 insertions(+), 11 deletions(-)
 rename pkg/metrics/eventmetrics/{collector.go => bpfcollector.go} (100%)

diff --git a/contrib/upgrade-notes/latest.md b/contrib/upgrade-notes/latest.md
index ae5f0934ac9..0d773927828 100644
--- a/contrib/upgrade-notes/latest.md
+++ b/contrib/upgrade-notes/latest.md
@@ -46,3 +46,4 @@ 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`.
diff --git a/docs/content/en/docs/reference/metrics.md b/docs/content/en/docs/reference/metrics.md
index 95ec3cf038c..969fa1df677 100644
--- a/docs/content/en/docs/reference/metrics.md
+++ b/docs/content/en/docs/reference/metrics.md
@@ -9,6 +9,15 @@ This page is autogenerated via `make metrics-doc` please do not edit directly.
 {{< /comment >}}
 ## Tetragon Health Metrics
 
+### `tetragon_bpf_missed_events_total`
+
+Number of Tetragon perf events that are failed to be sent from the kernel.
+
+| label | values |
+| ----- | ------ |
+| `error` | `EBUSY, ENOSPC, unknown` |
+| `msg_op` | `13, 14, 15, 16, 23, 24, 25, 26, 27, 5, 7` |
+
 ### `tetragon_build_info`
 
 Build information about tetragon
@@ -173,15 +182,6 @@ The number of errors per map.
 | ----- | ------ |
 | `map  ` | `execve_map, tg_execve_joined_info_map` |
 
-### `tetragon_missed_events_total`
-
-The total number of Tetragon events per type that are failed to sent from the kernel.
-
-| label | values |
-| ----- | ------ |
-| `error` | `EBUSY, ENOSPC, unknown` |
-| `msg_op` | `13, 14, 15, 16, 23, 24, 25, 26, 27, 5, 7` |
-
 ### `tetragon_missed_link_probes_total`
 
 The total number of Tetragon probe missed by link.
diff --git a/pkg/metrics/eventmetrics/collector.go b/pkg/metrics/eventmetrics/bpfcollector.go
similarity index 100%
rename from pkg/metrics/eventmetrics/collector.go
rename to pkg/metrics/eventmetrics/bpfcollector.go
diff --git a/pkg/metrics/eventmetrics/eventmetrics.go b/pkg/metrics/eventmetrics/eventmetrics.go
index dc1b45654b7..4bee11f2bda 100644
--- a/pkg/metrics/eventmetrics/eventmetrics.go
+++ b/pkg/metrics/eventmetrics/eventmetrics.go
@@ -42,8 +42,8 @@ var (
 		ConstLabels: nil,
 	}, []string{"type"})
 	MissedEvents = metrics.MustNewCustomCounter(metrics.NewOpts(
-		consts.MetricsNamespace, "", "missed_events_total",
-		"The total number of Tetragon events per type that are failed to sent from the kernel.",
+		consts.MetricsNamespace, "bpf", "missed_events_total",
+		"Number of Tetragon perf events that are failed to be sent from the kernel.",
 		nil, []metrics.ConstrainedLabel{metrics.OpCodeLabel, perfEventErrorLabel}, nil,
 	))
 	FlagCount = prometheus.NewCounterVec(prometheus.CounterOpts{