Rename a metric to _total

Rename a metric to _total because grafana now warns when you use a metric that does not match this pattern as you would a counter.
ties · Apr 23, 2024 · 3498f4e · 3498f4e
1 parent e6b5774
commit 3498f4e
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 2024-xx-yy (v0.x.y)
+
+  * Add `modem_downstream_errors_total` that will replace
+    `modem_downstream_errors` metric (clearer name).
+  * **deprecated** the `modem_downstream_errors` metric. Will be removed on or after 1-7-2024.
 
 ## 2024-03-09 (v0.5.0)
 

diff --git a/sagemcom_f3896_client/exporter.py b/sagemcom_f3896_client/exporter.py
@@ -335,6 +335,13 @@ async def __update_downstream_channel_metrics(
 
         # Technically a counter, but counter value can not be set
         metric_downstream_errors = Gauge(
+            "modem_downstream_errors_total",
+            "Downstream errors",
+            ["channel", "channel_type", "error_type"],
+            registry=registry,
+        )
+        # added on 23-4-2024
+        metric_downstream_errors_legacy = Gauge(
             "modem_downstream_errors",
             "Downstream errors",
             ["channel", "channel_type", "error_type"],
@@ -390,6 +397,16 @@ async def __update_downstream_channel_metrics(
                 channel_type=ch.channel_type,
                 error_type="uncorrected",
             ).set(ch.uncorrected_errors)
+            metric_downstream_errors_legacy.labels(
+                channel=ch.channel_id,
+                channel_type=ch.channel_type,
+                error_type="corrected",
+            ).set(ch.corrected_errors)
+            metric_downstream_errors_legacy.labels(
+                channel=ch.channel_id,
+                channel_type=ch.channel_type,
+                error_type="uncorrected",
+            ).set(ch.uncorrected_errors)
 
             match ch.channel_type:
                 case "sc_qam":