kinto 21.1.0__tar.gz → 22.0.0__tar.gz

{kinto-21.1.0 → kinto-22.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kinto
-Version: 21.1.0
+Version: 22.0.0
 Summary: Kinto Web Service - Store, Sync, Share, and Self-Host.
 Author-email: Mozilla Services <developers@kinto-storage.org>
 License: Copyright 2012 - Mozilla Foundation

{kinto-21.1.0 → kinto-22.0.0}/constraints.txt

@@ -73,7 +73,7 @@ markupsafe==2.1.4
     # via werkzeug
 msgpack==1.0.7
     # via bravado-core
-newrelic==10.9.0
+newrelic==10.11.0
     # via -r constraints.in
 packaging==23.2
     # via
@@ -88,7 +88,7 @@ plaster==1.1.2
     #   pyramid
 plaster-pastedeploy==1.0.1
     # via pyramid
-playwright==1.51.0
+playwright==1.52.0
     # via -r constraints.in
 pluggy==1.5.0
     # via pytest
@@ -96,7 +96,7 @@ prometheus-client==0.21.1
     # via -r constraints.in
 psycopg2-binary==2.9.10
     # via -r constraints.in
-pyee==12.0.0
+pyee==13.0.0
     # via playwright
 pyproject-hooks==1.0.0
     # via build
@@ -149,7 +149,7 @@ rpds-py==0.17.1
     # via
     #   jsonschema
     #   referencing
-ruff==0.11.6
+ruff==0.11.8
     # via -r constraints.in
 sentry-sdk==2.8.0
     # via -r constraints.in

{kinto-21.1.0 → kinto-22.0.0}/docs/configuration/settings.rst

@@ -516,8 +516,8 @@ Prometheus metrics can be enabled with (disabled by default):
     # Expose metrics created time (default: true)
     # kinto.prometheus_created_metrics_enabled = false
 
-    # Exclude certain labels to reduce cardinality (default: none)
-    # kinto.prometheus_exclude_labels = record_id group_id
+    # Control cardinality when URL fields become labels (default: bucket_id collection_id group_id record_id)
+    # kinto.metrics_matchdict_fields = bucket_id collection_id
 
 Metrics can then be crawled from the ``/__metrics__`` endpoint.
 

{kinto-21.1.0 → kinto-22.0.0}/kinto/core/initialization.py

@@ -472,10 +472,18 @@ def setup_metrics(config):
             auth, user_id = user_id.split(":")
             metrics_service.count("users", unique=[("auth", auth), ("userid", user_id)])
 
+        status = event.response.status_code
+
+        if status >= 400:
+            # Prevent random values of 404 responses to become label values.
+            request_matchdict = {}
+        else:
+            request_matchdict = dict(request.matchdict or {})
+
         # Add extra labels to metrics, based on fields extracted from the request matchdict.
         metrics_matchdict_fields = aslist(settings["metrics_matchdict_fields"])
         # Turn the `id` field of object endpoints into `{resource}_id` (eg. `mushroom_id`, `bucket_id`)
-        enhanced_matchdict = dict(request.matchdict or {})
+        enhanced_matchdict = request_matchdict
         try:
             enhanced_matchdict[request.current_resource_name + "_id"] = enhanced_matchdict.get(
                 "id", ""
@@ -487,8 +495,6 @@ def setup_metrics(config):
             (field, enhanced_matchdict.get(field, "")) for field in metrics_matchdict_fields
         ]
 
-        status = event.response.status_code
-
         service = request.current_service
         if service:
             # Use the service name as endpoint if available.
@@ -501,16 +507,14 @@ def setup_metrics(config):
                 "unnamed" if status != 404 else "unknown"
             )  # Do not multiply cardinality for unknown endpoints.
 
+        request_labels = [
+            ("method", request.method.lower()),
+            ("endpoint", endpoint),
+            ("status", str(status)),
+        ] + metrics_matchdict_labels
+
         # Count served requests.
-        metrics_service.count(
-            "request_summary",
-            unique=[
-                ("method", request.method.lower()),
-                ("endpoint", endpoint),
-                ("status", str(status)),
-            ]
-            + metrics_matchdict_labels,
-        )
+        metrics_service.count("request_summary", unique=request_labels)
 
         try:
             current = utils.msec_time()
@@ -518,8 +522,7 @@ def setup_metrics(config):
             metrics_service.timer(
                 "request_duration",
                 value=duration,
-                labels=[("endpoint", endpoint), ("method", request.method.lower())]
-                + metrics_matchdict_labels,
+                labels=request_labels,
             )
         except AttributeError:  # pragma: no cover
             # Logging was not setup in this Kinto app (unlikely but possible)
@@ -527,9 +530,7 @@ def setup_metrics(config):
 
         # Observe response size.
         metrics_service.observe(
-            "request_size",
-            len(event.response.body or b""),
-            labels=[("endpoint", endpoint)] + metrics_matchdict_labels,
+            "request_size", len(event.response.body or b""), labels=request_labels
         )
 
         # Count authentication verifications.

{kinto-21.1.0 → kinto-22.0.0}/kinto/core/metrics.py

@@ -13,7 +13,7 @@ class IMetricsService(Interface):
 
     def timer(key):
         """
-        Watch execution time.
+        Watch execution time in seconds.
         """
 
     def observe(self, key, value, labels=[]):
@@ -68,9 +68,9 @@ def watch_execution_time(metrics_service, obj, prefix="", classname=None):
         method = getattr(obj, name)
         is_method = isinstance(method, types.MethodType)
         if not name.startswith("_") and is_method:
-            statsd_key = f"{prefix}.{classname}"
+            metric_name = f"{prefix}.{classname}.seconds"
             labels = [("method", name)]
-            decorated_method = metrics_service.timer(statsd_key, labels=labels)(method)
+            decorated_method = metrics_service.timer(metric_name, labels=labels)(method)
             setattr(obj, name, decorated_method)
 
 
@@ -88,7 +88,7 @@ def listener_with_timer(config, key, func):
             # not listed in the `initialization_sequence` setting.
             return func(*args, **kwargs)
         # If metrics are enabled, monitor execution time of listeners.
-        with metrics_service.timer(key):
+        with metrics_service.timer(key + ".seconds" if not key.endswith(".seconds") else key):
             return func(*args, **kwargs)
 
     return wrapped

{kinto-21.1.0 → kinto-22.0.0}/kinto/plugins/prometheus.py

@@ -6,7 +6,7 @@ from time import perf_counter as time_now
 
 from pyramid.exceptions import ConfigurationError
 from pyramid.response import Response
-from pyramid.settings import asbool, aslist
+from pyramid.settings import asbool
 from zope.interface import implementer
 
 from kinto.core import metrics
@@ -53,7 +53,7 @@ class Timer:
     """
     A decorator to time the execution of a function. It will use the
     `prometheus_client.Histogram` to record the time taken by the function
-    in milliseconds. The histogram is passed as an argument to the
+    in seconds. The histogram is passed as an argument to the
     constructor.
 
     Main limitation: it does not support `labels` on the decorator.
@@ -78,8 +78,8 @@ class Timer:
             try:
                 return f(*args, **kwargs)
             finally:
-                dt_ms = 1000.0 * (time_now() - start_time)
-                self.histogram.observe(dt_ms)
+                dt_sec = time_now() - start_time
+                self.histogram.observe(dt_sec)
 
         return _wrapped
 
@@ -96,14 +96,14 @@ class Timer:
     def stop(self):
         if self._start_time is None:  # pragma: nocover
             raise RuntimeError("Timer has not started.")
-        dt_ms = 1000.0 * (time_now() - self._start_time)
-        self.histogram.observe(dt_ms)
+        dt_sec = time_now() - self._start_time
+        self.histogram.observe(dt_sec)
         return self
 
 
 @implementer(metrics.IMetricsService)
 class PrometheusService:
-    def __init__(self, prefix="", exclude_labels=None):
+    def __init__(self, prefix=""):
         prefix_clean = ""
         if prefix:
             # In GCP Console, the metrics are grouped by the first
@@ -112,19 +112,10 @@ class PrometheusService:
             # (eg. `remote-settings` -> `remotesettings_`, `kinto_` -> `kinto_`)
             prefix_clean = _fix_metric_name(prefix).replace("_", "") + "_"
         self.prefix = prefix_clean.lower()
-        self.exclude_labels = exclude_labels or []
-
-    def _exclude_labels(self, labels):
-        return [
-            (label_name, label_value)
-            for label_name, label_value in labels
-            if label_name not in self.exclude_labels
-        ]
 
     def timer(self, key, value=None, labels=[]):
         global _METRICS
         key = self.prefix + key
-        labels = self._exclude_labels(labels)
 
         if key not in _METRICS:
             _METRICS[key] = prometheus_module.Histogram(
@@ -154,7 +145,6 @@ class PrometheusService:
     def observe(self, key, value, labels=[]):
         global _METRICS
         key = self.prefix + key
-        labels = self._exclude_labels(labels)
 
         if key not in _METRICS:
             _METRICS[key] = prometheus_module.Summary(
@@ -195,7 +185,6 @@ class PrometheusService:
                 label_name, label_value = unique.rsplit(".", 1)
                 unique = [(label_name, label_value)]
 
-            unique = self._exclude_labels(unique)
             labels = [
                 (_fix_metric_name(label_name), label_value) for label_name, label_value in unique
             ]
@@ -269,11 +258,4 @@ def includeme(config):
 
     prefix = settings.get("prometheus_prefix", settings["project_name"])
 
-    # If we want to reduce the metrics cardinality, we can exclude certain
-    # labels (eg. records_id). This way all metrics will be grouped by the
-    # remaining labels.
-    exclude_labels = aslist(settings.get("prometheus_exclude_labels", ""))
-
-    config.registry.registerUtility(
-        PrometheusService(prefix=prefix, exclude_labels=exclude_labels), metrics.IMetricsService
-    )
+    config.registry.registerUtility(PrometheusService(prefix=prefix), metrics.IMetricsService)

{kinto-21.1.0 → kinto-22.0.0}/kinto.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kinto
-Version: 21.1.0
+Version: 22.0.0
 Summary: Kinto Web Service - Store, Sync, Share, and Self-Host.
 Author-email: Mozilla Services <developers@kinto-storage.org>
 License: Copyright 2012 - Mozilla Foundation

{kinto-21.1.0 → kinto-22.0.0}/tests/core/resource/test_events.py

@@ -511,7 +511,7 @@ class StatsDTest(BaseWebTest, unittest.TestCase):
         with mock.patch.object(metrics_client, "timing") as mocked:
             self.app.post_json(self.plural_url, {"data": {"name": "pouet"}}, headers=self.headers)
             timers = set(c[0][0] for c in mocked.call_args_list)
-            self.assertIn("listeners.test", timers)
+            self.assertIn("listeners.test.seconds", timers)
 
 
 @skip_if_no_prometheus
@@ -529,4 +529,4 @@ class PrometheusTest(BaseWebTest, unittest.TestCase):
         self.app.post_json(self.plural_url, {"data": {"name": "pouet"}}, headers=self.headers)
 
         resp = self.app.get("/__metrics__")
-        self.assertIn("listeners_test_count 1.0", resp.text)
+        self.assertIn("listeners_test_seconds_count 1.0", resp.text)

{kinto-21.1.0 → kinto-22.0.0}/tests/core/test_initialization.py

@@ -433,7 +433,7 @@ class MetricsConfigurationTest(unittest.TestCase):
         self.mocked().observe.assert_any_call(
             "request_size",
             len("{}"),
-            labels=[("endpoint", "heartbeat")],
+            labels=[("method", "get"), ("endpoint", "heartbeat"), ("status", "200")],
         )
 
     def test_statsd_observe_request_duration(self):
@@ -443,7 +443,7 @@ class MetricsConfigurationTest(unittest.TestCase):
         self.mocked().timer.assert_any_call(
             "request_duration",
             value=mock.ANY,
-            labels=[("endpoint", "heartbeat"), ("method", "get")],
+            labels=[("method", "get"), ("endpoint", "heartbeat"), ("status", "200")],
         )
 
     def test_statsd_counts_unknown_urls(self):

{kinto-21.1.0 → kinto-22.0.0}/tests/core/test_metrics.py

@@ -25,7 +25,7 @@ class WatchExecutionTimeTest(unittest.TestCase):
     def test_public_methods_generates_statsd_calls(self):
         self.test_object.test_method()
         self.mocked.timer.assert_called_with(
-            "test.testedclass", labels=[("method", "test_method")]
+            "test.testedclass.seconds", labels=[("method", "test_method")]
         )
 
     def test_private_methods_does_not_generates_statsd_calls(self):
@@ -48,4 +48,4 @@ class ListenerWithTimerTest(unittest.TestCase):
         wrapped = metrics.listener_with_timer(self.config, "key", self.func)
 
         self.assertEqual(wrapped(42), 42)
-        self.config.registry.metrics.timer.assert_called_with("key")
+        self.config.registry.metrics.timer.assert_called_with("key.seconds")

{kinto-21.1.0 → kinto-22.0.0}/tests/plugins/test_history.py

@@ -38,7 +38,7 @@ class MetricsTest(HistoryWebTest):
     def test_a_statsd_timer_is_used_for_history_if_configured(self):
         with mock.patch("kinto.plugins.statsd.StatsDService.timer") as mocked:
             self.app.put("/buckets/test", headers=self.headers)
-            mocked.assert_any_call("plugins.history")
+            mocked.assert_any_call("plugins.history.seconds")
 
 
 class HistoryViewTest(HistoryWebTest):

{kinto-21.1.0 → kinto-22.0.0}/tests/plugins/test_prometheus.py

@@ -174,32 +174,3 @@ class PrometheusNoCreatedTest(PrometheusWebTest):
 
         self.assertIn("TYPE kintoprod_price summary", resp.text)
         self.assertNotIn("TYPE kintoprod_price_created summary", resp.text)
-
-
-@skip_if_no_prometheus
-class PrometheusExcludedLabelsTest(PrometheusWebTest):
-    @classmethod
-    def get_app_settings(cls, extras=None):
-        settings = super().get_app_settings(extras)
-        settings["prometheus_exclude_labels"] = "record_id group_id"
-        return settings
-
-    def test_metrics_excluded_labels(self):
-        headers = get_user_headers("aaa")
-        self.app.put("/buckets/bid", headers=headers)
-        self.app.put("/buckets/bid/collections/cid", headers=headers)
-        self.app.put("/buckets/bid/groups/gid", headers=headers)
-        self.app.put("/buckets/bid/collections/cid/records/rid", headers=headers)
-
-        resp = self.app.get("/__metrics__")
-
-        self.assertNotIn("group_id=", resp.text)
-        self.assertNotIn("record_id=", resp.text)
-        self.assertIn(
-            'kintoprod_request_size_count{bucket_id="bid",collection_id="",endpoint="group-object"}',
-            resp.text,
-        )
-        self.assertIn(
-            'kintoprod_request_size_count{bucket_id="bid",collection_id="cid",endpoint="record-object"}',
-            resp.text,
-        )

{kinto-21.1.0 → kinto-22.0.0}/tests/test_views_metrics.py

@@ -31,13 +31,13 @@ class ViewsMetricsTest(BaseWebTest, unittest.TestCase):
         self.app.get("/buckets/beers/collections/barley/records", headers=self.headers)
 
         resp = self.app.get("/__metrics__")
-        print(resp.text)
+
         self.assertIn(
-            'request_size_sum{bucket_id="beers",collection_id="",endpoint="bucket-object",group_id="",record_id=""}',
+            'request_size_sum{bucket_id="beers",collection_id="",endpoint="bucket-object",group_id="",method="put",record_id="",status="201"}',
             resp.text,
         )
         self.assertIn(
-            'request_size_sum{bucket_id="beers",collection_id="",endpoint="group-object",group_id="amateurs",record_id=""}',
+            'request_size_sum{bucket_id="beers",collection_id="",endpoint="group-object",group_id="amateurs",method="put",record_id="",status="201"}',
             resp.text,
         )
         self.assertIn(
@@ -45,7 +45,7 @@ class ViewsMetricsTest(BaseWebTest, unittest.TestCase):
             resp.text,
         )
         self.assertIn(
-            'request_duration_sum{bucket_id="beers",collection_id="barley",endpoint="record-object",group_id="",method="put",record_id="abc"}',
+            'request_duration_sum{bucket_id="beers",collection_id="barley",endpoint="record-object",group_id="",method="put",record_id="abc",status="201"}',
             resp.text,
         )
 
@@ -61,3 +61,13 @@ class ViewsMetricsTest(BaseWebTest, unittest.TestCase):
             'request_summary_total{bucket_id="beers",collection_id="barley",endpoint="record-plural",group_id="",method="get",record_id="",status="200"}',
             resp.text,
         )
+
+    def test_4xx_do_not_have_matchdict_labels_values(self):
+        self.app.get("/buckets/water", headers=self.headers, status=403)
+
+        resp = self.app.get("/__metrics__")
+
+        self.assertIn(
+            'request_summary_total{bucket_id="",collection_id="",endpoint="bucket-object",group_id="",method="get",record_id="",status="403"}',
+            resp.text,
+        )