Merge pull request #342 from nuclearcat/feature/metrics-json-sessionsHEADmaster

metrics: expose session details in JSON output

1 files changed, 25 insertions, 4 deletions

diff --git a/tests/accel-pppd/general/test_metrics.py b/tests/accel-pppd/general/test_metrics.py
index 6344d3d0..aa90a13a 100644
--- a/tests/accel-pppd/general/test_metrics.py
+++ b/tests/accel-pppd/general/test_metrics.py
@@ -7,7 +7,7 @@ import pytest
 PROM_PORT = 9099
 
 
-def _config(fmt):
+def _config(fmt, sessions=False):
     return f"""
     [modules]
     metrics
@@ -25,6 +25,7 @@ def _config(fmt):
     [metrics]
     address=127.0.0.1:{PROM_PORT}
     format={fmt}
+    sessions={int(sessions)}
     """
 
 
@@ -33,7 +34,8 @@ def _request(path, method="GET"):
     try:
         conn.request(method, path)
         resp = conn.getresponse()
-        body = resp.read().decode("utf-8", "replace")
+        # strict: the renderer must never emit a body that is not valid UTF-8
+        body = resp.read().decode("utf-8")
         headers = {k.lower(): v for k, v in resp.getheaders()}
         return resp.status, headers, body
     finally:
@@ -43,7 +45,8 @@ def _request(path, method="GET"):
 class TestPrometheus:
     @pytest.fixture()
     def accel_pppd_config(self):
-        return _config("prometheus")
+        # sessions=1 must stay a no-op here: prometheus output is aggregate only
+        return _config("prometheus", sessions=True)
 
     def test_metrics_prometheus(self, accel_pppd_instance):
         assert accel_pppd_instance
@@ -55,6 +58,7 @@ class TestPrometheus:
         assert "accel_ppp_build_info{version=" in body
         assert "# TYPE accel_ppp_uptime_seconds gauge" in body
         assert 'accel_ppp_sessions{state="active"}' in body
+        assert "session_details" not in body
 
     def test_metrics_404_unknown_path(self, accel_pppd_instance):
         assert accel_pppd_instance
@@ -74,7 +78,7 @@ class TestPrometheus:
 class TestJson:
     @pytest.fixture()
     def accel_pppd_config(self):
-        return _config("json")
+        return _config("json", sessions=True)
 
     def test_metrics_json(self, accel_pppd_instance):
         assert accel_pppd_instance
@@ -84,8 +88,25 @@ class TestJson:
         assert status == 200
         assert headers.get("content-type") == "application/json"
 
+        assert int(headers["content-length"]) == len(body.encode("utf-8"))
+
         doc = json.loads(body)
         assert "build" in doc and "version" in doc["build"]
         assert "uptime_seconds" in doc
         assert "active" in doc["sessions"]
         assert "threads" in doc["core"]
+        assert doc["session_details"] == []
+
+
+class TestJsonNoSessions:
+    @pytest.fixture()
+    def accel_pppd_config(self):
+        return _config("json")
+
+    def test_metrics_json_without_sessions(self, accel_pppd_instance):
+        assert accel_pppd_instance
+
+        status, _, body = _request("/metrics")
+
+        assert status == 200
+        assert "session_details" not in json.loads(body)