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

kinto/core/initialization.py

@@ -510,17 +510,16 @@ def setup_metrics(config):
         request_labels = [
             ("method", request.method.lower()),
             ("endpoint", endpoint),
-            ("status", str(status)),
         ] + metrics_matchdict_labels
 
         # Count served requests.
-        metrics_service.count("request_summary", unique=request_labels)
+        metrics_service.count("request_summary", unique=request_labels + [("status", str(status))])
 
         try:
             current = utils.msec_time()
-            duration = current - request._received_at
+            duration = (current - request._received_at) / 1000
             metrics_service.timer(
-                "request_duration",
+                "request_duration_seconds",
                 value=duration,
                 labels=request_labels,
             )

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
+from pyramid.settings import asbool, aslist
 from zope.interface import implementer
 
 from kinto.core import metrics
@@ -101,9 +101,17 @@ class Timer:
         return self
 
 
+class NoOpHistogram:  # pragma: no cover
+    def observe(self, value):
+        pass
+
+    def labels(self, *args):
+        return self
+
+
 @implementer(metrics.IMetricsService)
 class PrometheusService:
-    def __init__(self, prefix=""):
+    def __init__(self, prefix="", disabled_metrics=[], histogram_buckets=None):
         prefix_clean = ""
         if prefix:
             # In GCP Console, the metrics are grouped by the first
@@ -112,17 +120,23 @@ class PrometheusService:
             # (eg. `remote-settings` -> `remotesettings_`, `kinto_` -> `kinto_`)
             prefix_clean = _fix_metric_name(prefix).replace("_", "") + "_"
         self.prefix = prefix_clean.lower()
+        self.disabled_metrics = [m.replace(self.prefix, "") for m in disabled_metrics]
+        self.histogram_buckets = histogram_buckets
 
     def timer(self, key, value=None, labels=[]):
         global _METRICS
-        key = self.prefix + key
 
+        key = _fix_metric_name(key)
+        if key in self.disabled_metrics:
+            return Timer(histogram=NoOpHistogram())
+
+        key = self.prefix + key
         if key not in _METRICS:
             _METRICS[key] = prometheus_module.Histogram(
-                _fix_metric_name(key),
+                key,
                 f"Histogram of {key}",
-                registry=get_registry(),
                 labelnames=[label_name for label_name, _ in labels],
+                buckets=self.histogram_buckets,
             )
 
         if not isinstance(_METRICS[key], prometheus_module.Histogram):
@@ -130,7 +144,7 @@ class PrometheusService:
                 f"Metric {key} already exists with different type ({_METRICS[key]})"
             )
 
-        timer = Timer(_METRICS[key])
+        timer = Timer(histogram=_METRICS[key])
         timer.set_labels(labels)
 
         if value is not None:
@@ -144,14 +158,17 @@ class PrometheusService:
 
     def observe(self, key, value, labels=[]):
         global _METRICS
-        key = self.prefix + key
 
+        key = _fix_metric_name(key)
+        if key in self.disabled_metrics:
+            return
+
+        key = self.prefix + key
         if key not in _METRICS:
             _METRICS[key] = prometheus_module.Summary(
-                _fix_metric_name(key),
+                key,
                 f"Summary of {key}",
                 labelnames=[label_name for label_name, _ in labels],
-                registry=get_registry(),
             )
 
         if not isinstance(_METRICS[key], prometheus_module.Summary):
@@ -167,10 +184,12 @@ class PrometheusService:
 
     def count(self, key, count=1, unique=None):
         global _METRICS
-        key = self.prefix + key
 
-        labels = []
+        key = _fix_metric_name(key)
+        if key in self.disabled_metrics:
+            return
 
+        labels = []
         if unique:
             if isinstance(unique, str):
                 warnings.warn(
@@ -189,12 +208,12 @@ class PrometheusService:
                 (_fix_metric_name(label_name), label_value) for label_name, label_value in unique
             ]
 
+        key = self.prefix + key
         if key not in _METRICS:
             _METRICS[key] = prometheus_module.Counter(
-                _fix_metric_name(key),
+                key,
                 f"Counter of {key}",
                 labelnames=[label_name for label_name, _ in labels],
-                registry=get_registry(),
             )
 
         if not isinstance(_METRICS[key], prometheus_module.Counter):
@@ -223,6 +242,19 @@ def _reset_multiproc_folder_content():  # pragma: no cover
     os.makedirs(PROMETHEUS_MULTIPROC_DIR, exist_ok=True)
 
 
+def reset_registry():
+    # This is mainly useful in tests, where the plugin is included
+    # several times with different settings.
+    registry = get_registry()
+
+    for collector in _METRICS.values():
+        try:
+            registry.unregister(collector)
+        except KeyError:  # pragma: no cover
+            pass
+    _METRICS.clear()
+
+
 def includeme(config):
     if prometheus_module is None:
         error_msg = (
@@ -235,27 +267,34 @@ def includeme(config):
     if not asbool(settings.get("prometheus_created_metrics_enabled", True)):
         prometheus_module.disable_created_metrics()
 
+    prefix = settings.get("prometheus_prefix", settings["project_name"])
+    disabled_metrics = aslist(settings.get("prometheus_disabled_metrics", ""))
+
+    # Default buckets for histogram metrics are (.005, .01, .025, .05, .075, .1, .25, .5, .75, 1.0, 2.5, 5.0, 7.5, 10.0, INF)
+    # we reduce it from 15 to 8 values by default here, and let the user override it if needed.
+    histogram_buckets_values = aslist(
+        settings.get(
+            "prometheus_histogram_buckets", "0.01 0.05 0.1 0.5 1.0 3.0 6.0 Inf"
+        )  # Note: Inf is added by default.
+    )
+    histogram_buckets = [float(x) for x in histogram_buckets_values]
+    # Note: we don't need to check for INF or list size, it's done in the prometheus_client library.
+
+    get_registry()  # Initialize the registry.
+
+    metrics_impl = PrometheusService(
+        prefix=prefix, disabled_metrics=disabled_metrics, histogram_buckets=histogram_buckets
+    )
+
     config.add_api_capability(
         "prometheus",
         description="Prometheus metrics.",
         url="https://github.com/Kinto/kinto/",
+        prefix=metrics_impl.prefix,
+        disabled_metrics=disabled_metrics,
     )
 
     config.add_route("prometheus_metrics", "/__metrics__")
     config.add_view(metrics_view, route_name="prometheus_metrics")
 
-    # Reinitialize the registry on initialization.
-    # This is mainly useful in tests, where the plugin is included
-    # several times with different settings.
-    registry = get_registry()
-
-    for collector in _METRICS.values():
-        try:
-            registry.unregister(collector)
-        except KeyError:  # pragma: no cover
-            pass
-    _METRICS.clear()
-
-    prefix = settings.get("prometheus_prefix", settings["project_name"])
-
-    config.registry.registerUtility(PrometheusService(prefix=prefix), metrics.IMetricsService)
+    config.registry.registerUtility(metrics_impl, metrics.IMetricsService)

{kinto-22.0.0.dist-info → kinto-23.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kinto
-Version: 22.0.0
+Version: 23.0.1
 Summary: Kinto Web Service - Store, Sync, Share, and Self-Host.
 Author-email: Mozilla Services <developers@kinto-storage.org>
 License: Copyright 2012 - Mozilla Foundation
@@ -70,6 +70,7 @@ Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: twine; extra == "dev"
+Requires-Dist: uwsgi; extra == "dev"
 Dynamic: license-file
 
 Kinto

{kinto-22.0.0.dist-info → kinto-23.0.1.dist-info}/RECORD

@@ -12,7 +12,7 @@ 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=OMnwre6roy_JkOCA0wf47wUJv7erxOfACI9CT78tD5k,26329
+kinto/core/initialization.py,sha256=TXU9JTenlNurKga4FLX1ov6KzxGJJ2zviGz9Gd-Wnz4,26337
 kinto/core/metrics.py,sha256=wlTThw_pSESrgwJfGdVBcM3r0b09gleZV4aSiu5pWq8,2768
 kinto/core/openapi.py,sha256=92sZviff4NCxN0jMnu5lPUnF5iQbrKMGy7Cegf-VAME,3876
 kinto/core/schema.py,sha256=d5L5TQynRYJPkZ8Mu2X7F72xEh6SKDbrHK1CNTdOf2E,3646
@@ -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=xoqCnJEF2dmGxZFN5Fql2bSMWaNFDYAdR94Yik-gKLM,8209
+kinto/plugins/prometheus.py,sha256=MXI79XQ9Uq_1hwAONgiySiKrLP-cwa26A_s4eeHrAvY,9621
 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-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-23.0.1.dist-info/licenses/LICENSE,sha256=oNEIMTuTJzppR5ZEyi86yvvtSagveMYXTYFn56zF0Uk,561
+kinto-23.0.1.dist-info/METADATA,sha256=o0wKYniN1mdhcMwvWSTXU-LNZiqLxJhwWEYjCj3wX_I,8768
+kinto-23.0.1.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+kinto-23.0.1.dist-info/entry_points.txt,sha256=3KlqBWPKY81mrCe_oX0I5s1cRO7Q53nCLbnVr5P9LH4,85
+kinto-23.0.1.dist-info/top_level.txt,sha256=EG_YmbZL6FAug9VwopG7JtF9SvH_r0DEnFp-3twPPys,6
+kinto-23.0.1.dist-info/RECORD,,

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

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