kinto 21.1.0__py3-none-any.whl → 22.0.0__py3-none-any.whl

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/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/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.dist-info → kinto-22.0.0.dist-info}/METADATA

@@ -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.dist-info → kinto-22.0.0.dist-info}/RECORD

@@ -12,8 +12,8 @@ kinto/core/authorization.py,sha256=GywY25KEzuSSAI709dFHDfdLnKxy3SLEYGwW5FkQ7Qc,1
 kinto/core/decorators.py,sha256=3SAPWXlyPNUSICZ9mz04bcN-UdbnDuFOtU0bQHHzLis,2178
 kinto/core/errors.py,sha256=JXZjkPYjjC0I6x02d2VJRGeaQ2yZYS2zm5o7_ljfyes,8946
 kinto/core/events.py,sha256=SYpXgKMtVjiD9fwYJA2Omdom9yA3nBqi9btdvU1I_nc,10345
-kinto/core/initialization.py,sha256=1m3lFLjFpApLKRXBa650GkYkR5u71ZUJRGogRYyo0Vs,26299
-kinto/core/metrics.py,sha256=h582cAZawzgJ9AL16t1ScgyVi0trXoJx-6147Ig-Vns,2693
+kinto/core/initialization.py,sha256=OMnwre6roy_JkOCA0wf47wUJv7erxOfACI9CT78tD5k,26329
+kinto/core/metrics.py,sha256=wlTThw_pSESrgwJfGdVBcM3r0b09gleZV4aSiu5pWq8,2768
 kinto/core/openapi.py,sha256=92sZviff4NCxN0jMnu5lPUnF5iQbrKMGy7Cegf-VAME,3876
 kinto/core/schema.py,sha256=d5L5TQynRYJPkZ8Mu2X7F72xEh6SKDbrHK1CNTdOf2E,3646
 kinto/core/scripts.py,sha256=02SXVjo579W82AsDF8dyVCRxYVcrMFkjjaNVIgLChh0,1412
@@ -100,7 +100,7 @@ kinto/core/views/openapi.py,sha256=PgxplQX1D0zqzlvRxBvd5SzrNMJmsaLfDta_fh-Pr-A,9
 kinto/core/views/version.py,sha256=-m5G_o0oHTpCgrtfFrHFve6Zqw_gs_szT0Bd8jnNmD4,1419
 kinto/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kinto/plugins/flush.py,sha256=poiBOLGXjml0xXHjqDMRdbXJSd6N3SL0mfeGK2vxeHY,812
-kinto/plugins/prometheus.py,sha256=WyE3jULDSMe35S4SJiKbh05AVGDyU9Hc-UR3-7baaGs,8957
+kinto/plugins/prometheus.py,sha256=xoqCnJEF2dmGxZFN5Fql2bSMWaNFDYAdR94Yik-gKLM,8209
 kinto/plugins/statsd.py,sha256=k9sewYZUwm60k9Z799VxbShBP3uPwGVlImaGCPnIrkE,2801
 kinto/plugins/accounts/__init__.py,sha256=2DeIaXJmMqRca3xVHeJ6xBWmeXAfrCdyg3EvK5jzIak,3670
 kinto/plugins/accounts/authentication.py,sha256=pCb269FquKGFd6DH8AVTjFnBFlfxcDEYVyxhQp5Y08o,2117
@@ -141,9 +141,9 @@ kinto/views/contribute.py,sha256=PJoIMLj9_IszSjgZkaCd_TUjekDgNqjpmVTmRN9ztaA,983
 kinto/views/groups.py,sha256=jOq5fX0-4lwZE8k1q5HME2tU7x9052rtBPF7YqcJ-Qg,3181
 kinto/views/permissions.py,sha256=F0_eKx201WyLonXJ5vLdGKa9RcFKjvAihrEEhU1JuLw,9069
 kinto/views/records.py,sha256=lYfACW2L8qcQoyYBD5IX-fTPjFWmGp7GjHq_U4InlyE,5037
-kinto-21.1.0.dist-info/licenses/LICENSE,sha256=oNEIMTuTJzppR5ZEyi86yvvtSagveMYXTYFn56zF0Uk,561
-kinto-21.1.0.dist-info/METADATA,sha256=rTspJQTHQ907FEjyjIM27a3XT_mxRQIILCnGfyZ3-S8,8731
-kinto-21.1.0.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-kinto-21.1.0.dist-info/entry_points.txt,sha256=3KlqBWPKY81mrCe_oX0I5s1cRO7Q53nCLbnVr5P9LH4,85
-kinto-21.1.0.dist-info/top_level.txt,sha256=EG_YmbZL6FAug9VwopG7JtF9SvH_r0DEnFp-3twPPys,6
-kinto-21.1.0.dist-info/RECORD,,
+kinto-22.0.0.dist-info/licenses/LICENSE,sha256=oNEIMTuTJzppR5ZEyi86yvvtSagveMYXTYFn56zF0Uk,561
+kinto-22.0.0.dist-info/METADATA,sha256=CQoL_8oC-kdhnfzaaywv5fZgTW4riJrSrGywkzRxFLU,8731
+kinto-22.0.0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+kinto-22.0.0.dist-info/entry_points.txt,sha256=3KlqBWPKY81mrCe_oX0I5s1cRO7Q53nCLbnVr5P9LH4,85
+kinto-22.0.0.dist-info/top_level.txt,sha256=EG_YmbZL6FAug9VwopG7JtF9SvH_r0DEnFp-3twPPys,6
+kinto-22.0.0.dist-info/RECORD,,

{kinto-21.1.0.dist-info → kinto-22.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (79.0.0)
+Generator: setuptools (80.3.1)
 Root-Is-Purelib: true
 Tag: py3-none-any