Merge pull request #74 from autometrics-dev/rename-metrics

Rename metrics

CHANGELOG.md

@@ -16,7 +16,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Changed
 
--
+- Renamed the `function.calls.count` metric to `function.calls` (which is exported
+  to Prometheus as `function_calls_total`) to be in line with OpenTelemetry and
+  OpenMetrics naming conventions. **Dashboards and alerting rules must be updated.**
+- When the `function.calls.duration` histogram is exported to Prometheus, it now
+  includes the units (`function_calls_duration_seconds`) to be in line with
+  Prometheus/OpenMetrics naming conventions. **Dashboards and alerting rules must be updated.**
 
 ### Deprecated
 

src/autometrics/constants.py

@@ -1,6 +1,6 @@
 """Constants used by autometrics"""
 
-COUNTER_NAME = "function.calls.count"
+COUNTER_NAME = "function.calls"
 HISTOGRAM_NAME = "function.calls.duration"
 CONCURRENCY_NAME = "function.calls.concurrent"
 # NOTE - The Rust implementation does not use `build.info`, instead opts for just `build_info`

src/autometrics/test_caller.py

@@ -38,6 +38,6 @@ def bar():
     assert blob is not None
     data = blob.decode("utf-8")
 
-    expected = """function_calls_count_total{caller="test_caller_detection.<locals>.bar",function="test_caller_detection.<locals>.foo",module="autometrics.test_caller",objective_name="",objective_percentile="",result="ok"} 1.0"""
+    expected = """function_calls_total{caller="test_caller_detection.<locals>.bar",function="test_caller_detection.<locals>.foo",module="autometrics.test_caller",objective_name="",objective_percentile="",result="ok"} 1.0"""
     assert "wrapper" not in data
     assert expected in data

src/autometrics/tracker/opentelemetry.py

@@ -64,6 +64,7 @@ def __init__(self):
         self.__histogram_instance = meter.create_histogram(
             name=HISTOGRAM_NAME,
             description=HISTOGRAM_DESCRIPTION,
+            unit="seconds",
         )
         self.__up_down_counter_build_info_instance = meter.create_up_down_counter(
             name=BUILD_INFO_NAME,

src/autometrics/tracker/prometheus.py

@@ -50,6 +50,7 @@ class PrometheusTracker:
             OBJECTIVE_PERCENTILE_PROMETHEUS,
             OBJECTIVE_LATENCY_THRESHOLD_PROMETHEUS,
         ],
+        unit="seconds",
     )
     prom_gauge_build_info = Gauge(
         BUILD_INFO_NAME, BUILD_INFO_DESCRIPTION, [COMMIT_KEY, VERSION_KEY, BRANCH_KEY]

src/autometrics/tracker/test_format.py

@@ -0,0 +1,25 @@
+from prometheus_client.exposition import generate_latest
+import pytest
+
+from . import init_tracker, TrackerType
+from .opentelemetry import OpenTelemetryTracker
+from ..decorator import autometrics
+
+
+@pytest.mark.parametrize("tracker", TrackerType)
+def test_metrics_format(tracker):
+    """Test that the metrics are formatted correctly."""
+    init_tracker(tracker)
+
+    @autometrics
+    def test_function():
+        pass
+
+    test_function()
+
+    blob = generate_latest()
+    assert blob is not None
+    data = blob.decode("utf-8")
+
+    assert "function_calls_total{" in data
+    assert "function_calls_duration_seconds_bucket{" in data