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

kinto/__init__.py

@@ -14,7 +14,7 @@ from kinto.core import utils
 __version__ = pkg_resources.get_distribution(__package__).version
 
 # Implemented HTTP API Version
-HTTP_API_VERSION = "1.22"
+HTTP_API_VERSION = "1.23"
 
 # Main kinto logger
 logger = logging.getLogger(__name__)

kinto/config/__init__.py

@@ -1,6 +1,9 @@
 import codecs
 import logging
 import os
+from datetime import datetime
+from functools import lru_cache
+from hashlib import sha256
 from time import strftime
 
 from kinto import __version__
@@ -69,3 +72,23 @@ def init(config_file, backend, cache_backend, host="127.0.0.1"):
     values.update(cache_backend_to_values[cache_backend])
 
     render_template("kinto.tpl", config_file, **values)
+
+
+@lru_cache(maxsize=1)
+def config_attributes():
+    """
+    Returns a hash of the config `.ini` file content.
+    The path is only known from `app.wsgi`, so we have to read
+    the environment variable again. Since tests are not run through
+    WSGI, then the variable is not set.
+    """
+    # WARNING: this default value should be the same as `app.wsgi`
+    ini_path = os.environ.get("KINTO_INI", os.path.join(".", "config", "kinto.ini"))
+    if not os.path.exists(ini_path):
+        logger.error(f"Could not find config file at {ini_path}")
+        return None
+    return {
+        "path": ini_path,
+        "hash": sha256(open(ini_path, "rb").read()).hexdigest(),
+        "modified": datetime.fromtimestamp(os.path.getmtime(ini_path)).isoformat(),
+    }

kinto/core/initialization.py

@@ -1,7 +1,6 @@
 import logging
 import random
 import re
-import urllib.parse
 import warnings
 from datetime import datetime
 
@@ -466,14 +465,6 @@ def setup_metrics(config):
         request = event.request
         metrics_service = config.registry.metrics
 
-        try:
-            endpoint = utils.strip_uri_prefix(request.path)
-            endpoint = urllib.parse.quote_plus(endpoint, safe="/?&=-_")
-        except UnicodeDecodeError as e:
-            # This `on_new_response` callback is also called when a HTTP 400
-            # is returned because of an invalid UTF-8 path. We still want metrics.
-            endpoint = str(e)
-
         # Count unique users.
         user_id = request.prefixed_userid
         if user_id:
@@ -496,13 +487,27 @@ 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.
+            endpoint = service.name
+        elif route := request.matched_route:
+            # Use the route name as endpoint if we're not on a Cornice service.
+            endpoint = route.name
+        else:
+            endpoint = (
+                "unnamed" if status != 404 else "unknown"
+            )  # Do not multiply cardinality for unknown endpoints.
+
         # Count served requests.
         metrics_service.count(
             "request_summary",
             unique=[
                 ("method", request.method.lower()),
                 ("endpoint", endpoint),
-                ("status", str(event.response.status_code)),
+                ("status", str(status)),
             ]
             + metrics_matchdict_labels,
         )
@@ -510,10 +515,11 @@ def setup_metrics(config):
         try:
             current = utils.msec_time()
             duration = current - request._received_at
-            metrics_service.observe(
+            metrics_service.timer(
                 "request_duration",
-                duration,
-                labels=[("endpoint", endpoint)] + metrics_matchdict_labels,
+                value=duration,
+                labels=[("endpoint", endpoint), ("method", request.method.lower())]
+                + metrics_matchdict_labels,
             )
         except AttributeError:  # pragma: no cover
             # Logging was not setup in this Kinto app (unlikely but possible)
@@ -527,13 +533,11 @@ def setup_metrics(config):
         )
 
         # Count authentication verifications.
-        if hasattr(request, "authn_type"):
-            metrics_service.count(f"authn_type.{request.authn_type}")
-
-        # Count view calls.
-        service = request.current_service
-        if service:
-            metrics_service.count(f"view.{service.name}.{request.method}")
+        try:
+            metrics_service.count("authentication", unique=[("type", request.authn_type)])
+        except AttributeError:
+            # Not authenticated
+            pass
 
     config.add_subscriber(on_new_response, NewResponse)
 

kinto/core/metrics.py

@@ -47,7 +47,7 @@ class NoOpTimer:
 
 @implementer(IMetricsService)
 class NoOpMetricsService:
-    def timer(self, key):
+    def timer(self, key, value=None, labels=[]):
         return NoOpTimer()
 
     def observe(self, key, value, labels=[]):
@@ -65,11 +65,12 @@ def watch_execution_time(metrics_service, obj, prefix="", classname=None):
     classname = classname or utils.classname(obj)
     members = dir(obj)
     for name in members:
-        value = getattr(obj, name)
-        is_method = isinstance(value, types.MethodType)
+        method = getattr(obj, name)
+        is_method = isinstance(method, types.MethodType)
         if not name.startswith("_") and is_method:
-            statsd_key = f"{prefix}.{classname}.{name}"
-            decorated_method = metrics_service.timer(statsd_key)(value)
+            statsd_key = f"{prefix}.{classname}"
+            labels = [("method", name)]
+            decorated_method = metrics_service.timer(statsd_key, labels=labels)(method)
             setattr(obj, name, decorated_method)
 
 

kinto/core/views/hello.py

@@ -2,6 +2,7 @@ import colander
 from pyramid.authorization import Authenticated
 from pyramid.security import NO_PERMISSION_REQUIRED
 
+from kinto.config import config_attributes
 from kinto.core import Service
 
 
@@ -26,14 +27,17 @@ hello_response_schemas = {
 def get_hello(request):
     """Return information regarding the current instance."""
     settings = request.registry.settings
+
     project_name = settings["project_name"]
     project_version = settings["project_version"]
+
     data = dict(
         project_name=project_name,
         project_version=project_version,
         http_api_version=settings["http_api_version"],
         project_docs=settings["project_docs"],
         url=request.route_url(hello.name),
+        config=config_attributes(),
     )
 
     eos = get_eos(request)

kinto/plugins/prometheus.py

@@ -6,6 +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 zope.interface import implementer
 
 from kinto.core import metrics
@@ -49,10 +50,27 @@ def _fix_metric_name(s):
 
 
 class Timer:
-    def __init__(self, summary):
-        self.summary = summary
+    """
+    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
+    constructor.
+
+    Main limitation: it does not support `labels` on the decorator.
+    """
+
+    def __init__(self, histogram):
+        self.histogram = histogram
         self._start_time = None
 
+    def set_labels(self, labels):
+        if not labels:
+            return
+        self.histogram = self.histogram.labels(*(label_value for _, label_value in labels))
+
+    def observe(self, value):
+        return self.histogram.observe(value)
+
     def __call__(self, f):
         @safe_wraps(f)
         def _wrapped(*args, **kwargs):
@@ -61,7 +79,7 @@ class Timer:
                 return f(*args, **kwargs)
             finally:
                 dt_ms = 1000.0 * (time_now() - start_time)
-                self.summary.observe(dt_ms)
+                self.histogram.observe(dt_ms)
 
         return _wrapped
 
@@ -79,13 +97,13 @@ class Timer:
         if self._start_time is None:  # pragma: nocover
             raise RuntimeError("Timer has not started.")
         dt_ms = 1000.0 * (time_now() - self._start_time)
-        self.summary.observe(dt_ms)
+        self.histogram.observe(dt_ms)
         return self
 
 
 @implementer(metrics.IMetricsService)
 class PrometheusService:
-    def __init__(self, prefix=""):
+    def __init__(self, prefix="", exclude_labels=None):
         prefix_clean = ""
         if prefix:
             # In GCP Console, the metrics are grouped by the first
@@ -94,26 +112,49 @@ 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):
+    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.Summary(
-                _fix_metric_name(key), f"Summary of {key}", registry=get_registry()
+            _METRICS[key] = prometheus_module.Histogram(
+                _fix_metric_name(key),
+                f"Histogram of {key}",
+                registry=get_registry(),
+                labelnames=[label_name for label_name, _ in labels],
             )
 
-        if not isinstance(_METRICS[key], prometheus_module.Summary):
+        if not isinstance(_METRICS[key], prometheus_module.Histogram):
             raise RuntimeError(
                 f"Metric {key} already exists with different type ({_METRICS[key]})"
             )
 
-        return Timer(_METRICS[key])
+        timer = Timer(_METRICS[key])
+        timer.set_labels(labels)
+
+        if value is not None:
+            # We are timing something.
+            return timer.observe(value)
+
+        # We are not timing anything, just returning the timer object
+        # (eg. to be used as decorator or context manager).
+        # Note that in this case, the labels values will be the same for all calls.
+        return timer
 
     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(
@@ -154,6 +195,7 @@ 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
             ]
@@ -199,6 +241,11 @@ def includeme(config):
         )
         raise ConfigurationError(error_msg)
 
+    settings = config.get_settings()
+
+    if not asbool(settings.get("prometheus_created_metrics_enabled", True)):
+        prometheus_module.disable_created_metrics()
+
     config.add_api_capability(
         "prometheus",
         description="Prometheus metrics.",
@@ -220,7 +267,13 @@ def includeme(config):
             pass
     _METRICS.clear()
 
-    settings = config.get_settings()
     prefix = settings.get("prometheus_prefix", settings["project_name"])
 
-    config.registry.registerUtility(PrometheusService(prefix=prefix), metrics.IMetricsService)
+    # 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
+    )

kinto/plugins/statsd.py

@@ -1,4 +1,5 @@
 import warnings
+from datetime import timedelta
 from urllib.parse import urlparse
 
 from pyramid.exceptions import ConfigurationError
@@ -26,7 +27,13 @@ class StatsDService:
     def __init__(self, host, port, prefix):
         self._client = statsd_module.StatsClient(host, port, prefix=prefix)
 
-    def timer(self, key):
+    def timer(self, key, value=None, labels=[]):
+        if labels:
+            # [("method", "get")] -> "method.get"
+            key = f"{key}." + ".".join(f"{label[0]}.{sanitize(label[1])}" for label in labels)
+        if value:
+            value = timedelta(seconds=value)
+            return self._client.timing(key, value)
         return self._client.timer(key)
 
     def observe(self, key, value, labels=[]):

{kinto-20.6.1.dist-info → kinto-21.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kinto
-Version: 20.6.1
+Version: 21.1.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-20.6.1.dist-info → kinto-21.1.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
-kinto/__init__.py,sha256=XG7cOyHN0ipQeOSPMW-XFax7uFgAjnCd3Slq0jSFGC4,3299
+kinto/__init__.py,sha256=OLigXJoAE1frrLwNjfAnuuhgfRrk8yL_OrvZpguRzT8,3299
 kinto/__main__.py,sha256=6XDjWYGtJ36qepn9Of4xL9zc35TfdSeEvHh3s26Aw9c,7913
 kinto/authorization.py,sha256=i3ttdPTFGzE9CqUQmfC4rR_6dDZJu0jWJMLGl_jFzIE,4919
 kinto/contribute.json,sha256=HT9QVB8rA8jWIREQoqWfMibfJXMAzbRsixW8F6O6cQY,792
 kinto/events.py,sha256=NMPvKUdbi25aYHhu9svzQsrEZMa9nyO4mtuMZC5871Q,85
 kinto/schema_validation.py,sha256=mtAmnl5HwiUsjS2gU8MKH4lkZ1380A5wZht-w9s5X7M,5306
-kinto/config/__init__.py,sha256=av8W0utmjheueFqrjTYEDk_vbpm3XYdHcqv5lppNR4k,2131
+kinto/config/__init__.py,sha256=v3EySgWgyqLr2kV6sFkBVgnEgjHwyylbcgYIpdNveKQ,2979
 kinto/config/kinto.tpl,sha256=Pm9p_oRsBlVoEXPVA2X6Wvv49jMOVv-27jw4rahVlwE,8201
 kinto/core/__init__.py,sha256=s7PshdeKmpiqI5sW-zdC7p3Ig-e60w4kiUwlKi-impY,8655
 kinto/core/authentication.py,sha256=HLA0kREC3GMEsrIsHsQYjVNztYfAF01kb8-pLboByFs,1527
@@ -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=ZjmCKc8MYZXv63W2mv--fY8rXSLAnJa7RtCYdfK4jsg,26225
-kinto/core/metrics.py,sha256=Y6Mt4PUzy2-oudeGr_oCmtX8nIR4SZkzUlPxr58jr-g,2619
+kinto/core/initialization.py,sha256=1m3lFLjFpApLKRXBa650GkYkR5u71ZUJRGogRYyo0Vs,26299
+kinto/core/metrics.py,sha256=h582cAZawzgJ9AL16t1ScgyVi0trXoJx-6147Ig-Vns,2693
 kinto/core/openapi.py,sha256=92sZviff4NCxN0jMnu5lPUnF5iQbrKMGy7Cegf-VAME,3876
 kinto/core/schema.py,sha256=d5L5TQynRYJPkZ8Mu2X7F72xEh6SKDbrHK1CNTdOf2E,3646
 kinto/core/scripts.py,sha256=02SXVjo579W82AsDF8dyVCRxYVcrMFkjjaNVIgLChh0,1412
@@ -95,13 +95,13 @@ kinto/core/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 kinto/core/views/batch.py,sha256=sWNn67YqfTbiqwpbwbm1QyumcVGi8aNhlT5AtLToElI,5657
 kinto/core/views/errors.py,sha256=2uTy85UBQL1EDIMotzFBhVl14RmWwb3rupbsB0mycbs,6099
 kinto/core/views/heartbeat.py,sha256=qidZ7fTvuPoJMo7miDnclAm_WsbgqubzsARrv9aCo5U,3336
-kinto/core/views/hello.py,sha256=tTjJ2PHKPnmLL41cwF6e0AzPhm4WmojIc0VWHcZNOgI,1961
+kinto/core/views/hello.py,sha256=DipWK5EuuDOyUSHCGTGZKmNBbgyp_SHyPXUje6hc81E,2042
 kinto/core/views/openapi.py,sha256=PgxplQX1D0zqzlvRxBvd5SzrNMJmsaLfDta_fh-Pr-A,958
 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=Ljirp9K3Gw1iy0I5vzE_Z2fE6yw3gjjHZayu0_2Y2Vw,6985
-kinto/plugins/statsd.py,sha256=-VasJZM1xkhTfFa6_0GgWwfPqKnYS2722bSMDLzZ3pI,2469
+kinto/plugins/prometheus.py,sha256=WyE3jULDSMe35S4SJiKbh05AVGDyU9Hc-UR3-7baaGs,8957
+kinto/plugins/statsd.py,sha256=k9sewYZUwm60k9Z799VxbShBP3uPwGVlImaGCPnIrkE,2801
 kinto/plugins/accounts/__init__.py,sha256=2DeIaXJmMqRca3xVHeJ6xBWmeXAfrCdyg3EvK5jzIak,3670
 kinto/plugins/accounts/authentication.py,sha256=pCb269FquKGFd6DH8AVTjFnBFlfxcDEYVyxhQp5Y08o,2117
 kinto/plugins/accounts/scripts.py,sha256=_LNkSpFprOMGHFKkRmmOqK31uoQW28yttPQztmfUt5Q,2001
@@ -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-20.6.1.dist-info/licenses/LICENSE,sha256=oNEIMTuTJzppR5ZEyi86yvvtSagveMYXTYFn56zF0Uk,561
-kinto-20.6.1.dist-info/METADATA,sha256=VGdr0-TWwOlbW-X1GxdLcIe92XnBzroCTiwtKZ7icEs,8731
-kinto-20.6.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-kinto-20.6.1.dist-info/entry_points.txt,sha256=3KlqBWPKY81mrCe_oX0I5s1cRO7Q53nCLbnVr5P9LH4,85
-kinto-20.6.1.dist-info/top_level.txt,sha256=EG_YmbZL6FAug9VwopG7JtF9SvH_r0DEnFp-3twPPys,6
-kinto-20.6.1.dist-info/RECORD,,
+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-20.6.1.dist-info → kinto-21.1.0.dist-info}/WHEEL

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