kinto 21.0.0__tar.gz → 21.1.1__tar.gz

{kinto-21.0.0 → kinto-21.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kinto
-Version: 21.0.0
+Version: 21.1.1
 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.0.0 → kinto-21.1.1}/app.wsgi

@@ -8,6 +8,8 @@ here = os.path.dirname(__file__)
 
 ini_path = os.environ.get('KINTO_INI')
 if ini_path is None:
+    # WARNING: if you modify this default value, you should
+    # also change the default in `kinto.config.config_attributes()`
     ini_path = os.path.join(here, 'config', 'kinto.ini')
 
 # Set up logging

{kinto-21.0.0 → kinto-21.1.1}/docs/api/1.x/utilities.rst

@@ -25,6 +25,11 @@ The returned value is a JSON mapping containing:
   - ``readonly``: Only requests with read operations are allowed.
 
 - ``capabilities``: a mapping used by clients to detect optional features of the API.
+- ``config``: attributes of the configuration file used by the server.
+
+  - ``path``: path on the server
+  - ``hash``: SHA256 hash of the file
+  - ``modified``: datetime of the file
 
   - Example:
 

{kinto-21.0.0 → kinto-21.1.1}/docs/api/index.rst

@@ -11,6 +11,12 @@ API
 Changelog
 ---------
 
+1.23 (2025-04-16)
+'''''''''''''''''
+
+- Added ``config`` field to the root URL endpoint
+
+
 1.22 (2019-03-20)
 '''''''''''''''''
 

{kinto-21.0.0 → kinto-21.1.1}/docs/configuration/settings.rst

@@ -513,6 +513,12 @@ Prometheus metrics can be enabled with (disabled by default):
 
     # kinto.prometheus_prefix = kinto-prod
 
+    # 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
+
 Metrics can then be crawled from the ``/__metrics__`` endpoint.
 
 

{kinto-21.0.0 → kinto-21.1.1}/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-21.0.0 → kinto-21.1.1}/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-21.0.0 → kinto-21.1.1}/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.0.0 → kinto-21.1.1}/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-21.0.0 → kinto-21.1.1}/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
@@ -102,7 +103,7 @@ class Timer:
 
 @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
@@ -111,10 +112,19 @@ 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(
@@ -144,6 +154,7 @@ 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(
@@ -184,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
             ]
@@ -229,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.",
@@ -250,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-21.0.0 → kinto-21.1.1}/kinto.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kinto
-Version: 21.0.0
+Version: 21.1.1
 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.0.0 → kinto-21.1.1}/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.0.0 → kinto-21.1.1}/tests/core/test_views_hello.py

@@ -1,7 +1,9 @@
+import os
 from unittest import mock
 
 from pyramid import testing
 
+from kinto.config import config_attributes
 from kinto.core.testing import unittest
 
 from .support import BaseWebTest
@@ -75,6 +77,22 @@ class HelloViewTest(BaseWebTest, unittest.TestCase):
 
         self.assertTrue(response.json["http_api_version"])
 
+    def test_return_config_file_info(self):
+        config_attributes.cache_clear()
+        before = os.getenv("KINTO_INI", None)
+        os.environ["KINTO_INI"] = "tests/test_configuration/test.ini"
+
+        response = self.app.get("/")
+
+        self.assertEqual(response.json["config"]["hash"], mock.ANY)
+        self.assertEqual(response.json["config"]["modified"], mock.ANY)
+        self.assertEqual(response.json["config"]["path"], mock.ANY)
+
+        if before is None:
+            del os.environ["KINTO_INI"]
+        else:
+            os.environ["KINTO_INI"] = before
+
 
 class APICapabilitiesTest(BaseWebTest, unittest.TestCase):
     def test_list_of_capabilities_contains_basicauth_by_default(self):

{kinto-21.0.0 → kinto-21.1.1}/tests/plugins/test_prometheus.py

@@ -157,3 +157,49 @@ class PrometheusNoPrefixTest(PrometheusWebTest):
 
         resp = self.app.get("/__metrics__")
         self.assertIn("TYPE price summary", resp.text)
+
+
+@skip_if_no_prometheus
+class PrometheusNoCreatedTest(PrometheusWebTest):
+    @classmethod
+    def get_app_settings(cls, extras=None):
+        settings = super().get_app_settings(extras)
+        settings["prometheus_created_metrics_enabled"] = "false"
+        return settings
+
+    def test_metrics_created_not_in_response(self):
+        self.app.app.registry.metrics.observe("price", 111)
+
+        resp = self.app.get("/__metrics__")
+
+        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",method="put",status="201"}',
+            resp.text,
+        )
+        self.assertIn(
+            'kintoprod_request_size_count{bucket_id="bid",collection_id="cid",endpoint="record-object",method="put",status="201"}',
+            resp.text,
+        )

{kinto-21.0.0 → kinto-21.1.1}/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,
+        )