kinto 18.1.1__tar.gz → 19.3.0__tar.gz

{kinto-18.1.1 → kinto-19.3.0}/.github/workflows/test.yml

@@ -32,10 +32,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        pyenv: [py38, py39, py310, py311, py312, py312-raw]
+        pyenv: [py39, py310, py311, py312, py312-raw]
         include:
-          - pyenv: py38
-            python-version: "3.8"
           - pyenv: py39
             python-version: "3.9"
           - pyenv: py310

{kinto-18.1.1 → kinto-19.3.0}/Dockerfile

@@ -1,5 +1,5 @@
 # Mozilla Kinto server
-FROM python:3.10-bullseye as python-builder
+FROM python:3.10-bullseye AS python-builder
 RUN python -m venv /opt/venv
 ARG KINTO_VERSION=1
 ENV SETUPTOOLS_SCM_PRETEND_VERSION_FOR_KINTO=${KINTO_VERSION} \
@@ -36,4 +36,4 @@ WORKDIR /app
 USER app
 
 # Run database migrations and start the kinto server
-CMD kinto migrate --ini $KINTO_INI && kinto start --ini $KINTO_INI --port $PORT
+CMD ["sh", "-c", "kinto migrate --ini $KINTO_INI && kinto start --ini $KINTO_INI --port $PORT"]

{kinto-18.1.1/kinto.egg-info → kinto-19.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kinto
-Version: 18.1.1
+Version: 19.3.0
 Summary: Kinto Web Service - Store, Sync, Share, and Self-Host.
 Author-email: Mozilla Services <developers@kinto-storage.org>
 License: Copyright 2012 - Mozilla Foundation
@@ -21,10 +21,10 @@ Project-URL: Repository, https://github.com/Kinto/kinto
 Keywords: web,sync,json,storage,services
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
@@ -61,6 +61,7 @@ Requires-Dist: newrelic; extra == "monitoring"
 Requires-Dist: sentry-sdk[sqlalchemy]; extra == "monitoring"
 Requires-Dist: statsd; extra == "monitoring"
 Requires-Dist: werkzeug; extra == "monitoring"
+Requires-Dist: prometheus-client; extra == "monitoring"
 Provides-Extra: test
 Requires-Dist: bravado; extra == "test"
 Requires-Dist: pytest; extra == "test"
@@ -79,7 +80,7 @@ Kinto
 |coc| |gitter| |readthedocs| |pypi| |ci| |main-coverage|
 
 .. |coc| image:: https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg
-    :target: https://github.com/Kinto/kinto/blob/main/CODE_OF_CONDUCT.md
+    :target: https://github.com/Kinto/kinto/blob/main/.github/CODE_OF_CONDUCT.md
     :alt: Code of conduct
 
 .. |gitter| image:: https://badges.gitter.im/Kinto/kinto.svg
@@ -113,7 +114,7 @@ Kinto is a minimalist JSON storage service with synchronisation and sharing abil
 Requirements
 ------------
 
-* **Python**: 3.8+
+* **Python**: 3.9+
 * **Backends**: In-memory (development), PostgreSQL 9.5+ (production)
 
 Contributors

{kinto-18.1.1 → kinto-19.3.0}/README.rst

@@ -4,7 +4,7 @@ Kinto
 |coc| |gitter| |readthedocs| |pypi| |ci| |main-coverage|
 
 .. |coc| image:: https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg
-    :target: https://github.com/Kinto/kinto/blob/main/CODE_OF_CONDUCT.md
+    :target: https://github.com/Kinto/kinto/blob/main/.github/CODE_OF_CONDUCT.md
     :alt: Code of conduct
 
 .. |gitter| image:: https://badges.gitter.im/Kinto/kinto.svg
@@ -38,5 +38,5 @@ Kinto is a minimalist JSON storage service with synchronisation and sharing abil
 Requirements
 ------------
 
-* **Python**: 3.8+
+* **Python**: 3.9+
 * **Backends**: In-memory (development), PostgreSQL 9.5+ (production)

{kinto-18.1.1 → kinto-19.3.0}/constraints.in

@@ -25,6 +25,7 @@ psycopg2
 zope.sqlalchemy
 # monitoring
 newrelic
+prometheus-client
 sentry-sdk[sqlalchemy]
 statsd
 werkzeug

{kinto-18.1.1 → kinto-19.3.0}/constraints.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
+# This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
 #    pip-compile --output-file=constraints.txt --strip-extras constraints.in
@@ -10,15 +10,15 @@ attrs==23.2.0
     # via
     #   jsonschema
     #   referencing
-bcrypt==4.1.3
+bcrypt==4.2.0
     # via -r constraints.in
 beautifulsoup4==4.12.3
     # via webtest
 bravado-core==6.1.1
     # via -r constraints.in
-build==1.2.1
+build==1.2.2.post1
     # via -r constraints.in
-certifi==2023.11.17
+certifi==2024.7.4
     # via
     #   requests
     #   sentry-sdk
@@ -40,13 +40,11 @@ coverage==7.4.0
     # via pytest-cov
 dockerflow==2024.4.2
     # via -r constraints.in
-exceptiongroup==1.2.0
-    # via pytest
 execnet==2.0.2
     # via pytest-cache
 fqdn==1.5.1
     # via jsonschema
-greenlet==3.0.3
+greenlet==3.1.1
     # via
     #   playwright
     #   sqlalchemy
@@ -70,7 +68,7 @@ jsonpointer==2.4
     #   jsonschema
 jsonref==1.1.0
     # via bravado-core
-jsonschema==4.22.0
+jsonschema==4.23.0
     # via
     #   -r constraints.in
     #   bravado-core
@@ -83,7 +81,7 @@ markupsafe==2.1.4
     # via werkzeug
 msgpack==1.0.7
     # via bravado-core
-newrelic==9.11.0
+newrelic==10.2.0
     # via -r constraints.in
 packaging==23.2
     # via
@@ -98,13 +96,15 @@ plaster==1.1.2
     #   pyramid
 plaster-pastedeploy==1.0.1
     # via pyramid
-playwright==1.44.0
+playwright==1.48.0
     # via -r constraints.in
 pluggy==1.5.0
     # via pytest
-psycopg2==2.9.9
+prometheus-client==0.21.0
+    # via -r constraints.in
+psycopg2==2.9.10
     # via -r constraints.in
-pyee==11.1.0
+pyee==12.0.0
     # via playwright
 pyproject-hooks==1.0.0
     # via build
@@ -121,7 +121,7 @@ pyramid-multiauth==1.0.2
     # via -r constraints.in
 pyramid-tm==2.5
     # via -r constraints.in
-pytest==8.2.2
+pytest==8.3.3
     # via
     #   -r constraints.in
     #   pytest-cache
@@ -163,9 +163,9 @@ rpds-py==0.17.1
     # via
     #   jsonschema
     #   referencing
-ruff==0.4.9
+ruff==0.7.1
     # via -r constraints.in
-sentry-sdk==1.39.2
+sentry-sdk==2.8.0
     # via -r constraints.in
 simplejson==3.19.2
     # via bravado-core
@@ -177,7 +177,7 @@ six==1.16.0
     #   rfc3339-validator
 soupsieve==2.5
     # via beautifulsoup4
-sqlalchemy==2.0.30
+sqlalchemy==2.0.36
     # via
     #   -r constraints.in
     #   sentry-sdk
@@ -186,13 +186,7 @@ statsd==4.0.1
     # via -r constraints.in
 swagger-spec-validator==3.0.3
     # via bravado-core
-tomli==2.0.1
-    # via
-    #   build
-    #   coverage
-    #   pyproject-hooks
-    #   pytest
-transaction==4.0
+transaction==5.0
     # via
     #   -r constraints.in
     #   pyramid-mailer
@@ -220,19 +214,19 @@ venusian==3.1.0
     # via
     #   cornice
     #   pyramid
-waitress==3.0.0
+waitress==3.0.1
     # via
     #   -r constraints.in
     #   webtest
-webcolors==1.13
+webcolors==24.6.0
     # via jsonschema
-webob==1.8.7
+webob==1.8.8
     # via
     #   pyramid
     #   webtest
 webtest==3.0.0
     # via -r constraints.in
-werkzeug==3.0.3
+werkzeug==3.0.6
     # via -r constraints.in
 zope-deprecation==5.0
     # via pyramid

{kinto-18.1.1 → kinto-19.3.0}/docs/conf.py

@@ -24,10 +24,7 @@ __HERE__ = os.path.dirname(os.path.abspath(__file__))
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
-
     html_theme = "sphinx_rtd_theme"
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # otherwise, readthedocs.io uses their theme by default, so no need to specify
 # it

{kinto-18.1.1 → kinto-19.3.0}/docs/configuration/production.rst

@@ -220,19 +220,14 @@ In the configuration of the CDN service, you should also:
 Monitoring
 ----------
 
-In order to enable monitoring features like *statsd*, install
+In order to enable monitoring features (eg. *Prometheus* or *StatsD*), install
 extra requirements:
 
 ::
 
     make install-monitoring
 
-And configure its URL:
-
-.. code-block :: ini
-
-    # StatsD
-    kinto.statsd_url = udp://carbon.server:8125
+See :ref:`settings section <monitoring-with-prometheus>` for the configuration aspects.
 
 Counters
 ::::::::

{kinto-18.1.1 → kinto-19.3.0}/docs/configuration/settings.rst

@@ -301,21 +301,86 @@ hello view <api-utilities>`.
    # kinto.http_host = production.server.com:7777
 
 
+.. _configuration-plugins:
+
+Plugins
+=======
+
+It is possible to extend the default Kinto behaviors by using "plugins".
+
+The list of plugins to load at startup can be specified in the settings, as a
+list of Python modules:
+
+.. code-block:: ini
+
+    kinto.includes = kinto.plugins.default_bucket
+                     kinto.plugins.history
+                     kinto.plugins.admin
+                     kinto-attachment
+                     custom-myplugin
+
++---------------------------------------+--------------------------------------------------------------------------+
+| Built-in plugins                      | What does it do?                                                         |
++=======================================+==========================================================================+
+| ``kinto.plugins.accounts``            | It allows users to sign-up and authenticate using username and password  |
+|                                       | (:ref:`more details <api-accounts>`).                                    |
++---------------------------------------+--------------------------------------------------------------------------+
+| ``kinto.plugins.admin``               | It is a Web admin UI to manage data from a Kinto server.                 |
+|                                       | (:ref:`more details <kinto-admin>`).                                     |
++---------------------------------------+--------------------------------------------------------------------------+
+| ``kinto.plugins.default_bucket``      | It enables a personal bucket ``default``, where collections are created  |
+|                                       | implicitly (:ref:`more details <buckets-default-id>`).                   |
++---------------------------------------+--------------------------------------------------------------------------+
+| ``kinto.plugins.flush``               | Adds an endpoint to completely remove all data from the database backend |
+|                                       | for testing/staging purposes. (:ref:`more details <api-flush>`).         |
++---------------------------------------+--------------------------------------------------------------------------+
+| ``kinto.plugins.history``             | It tracks every action performed on objects within a bucket              |
+|                                       | (:ref:`more details <api-history>`).                                     |
++---------------------------------------+--------------------------------------------------------------------------+
+| ``kinto.plugins.openid``              | It allows to authenticate users using OpenID Connect from Google,        |
+|                                       | Microsoft, Auth0, etc. (:ref:`more details <api-openid>`).               |
++---------------------------------------+--------------------------------------------------------------------------+
+| ``kinto.plugins.quotas``              | It allows to limit storage per collection size, number of records, etc.  |
+|                                       | (:ref:`more details <api-quotas>`).                                      |
++---------------------------------------+--------------------------------------------------------------------------+
+| ``kinto.plugins.prometheus``          | Send metrics about backend duration, authentication, endpoints hits, ..  |
+|                                       | (:ref:`more details <monitoring-with-prometheus>`).                      |
++---------------------------------------+--------------------------------------------------------------------------+
+| ``kinto.plugins.statsd``              | Send metrics about backend duration, authentication, endpoints hits, ..  |
+|                                       | (:ref:`more details <monitoring-with-statsd>`).                          |
++---------------------------------------+--------------------------------------------------------------------------+
+
+
+There are `many available packages`_ in the Pyramid ecosystem, and it is straightforward to build one,
+since the specified module must just define an ``includeme(config)`` function.
+
+.. _many available packages: https://github.com/ITCase/awesome-pyramid
+
+See `our list of community plugins <https://github.com/Kinto/kinto/wiki/Plugins>`_.
+
+See also: :ref:`tutorial-write-plugin` for more in-depth informations on how
+to create your own plugin.
+
+
+Pluggable components
+::::::::::::::::::::
+
+:term:`Pluggable <pluggable>` components can be substituted from configuration files,
+as long as the replacement follows the original component API.
+
+.. code-block:: ini
+
+    kinto.logging_renderer = your_log_renderer.CustomRenderer
+
+This is the simplest way to extend *Kinto*, but will be limited to its
+existing components (cache, storage, log renderer, ...).
+
+In order to add extra features, including external packages is the way to go!
+
+
 Logging and Monitoring
 ======================
 
-+------------------------+----------------------------------------+--------------------------------------------------------------------------+
-| Setting name           | Default                                | What does it do?                                                         |
-+========================+========================================+==========================================================================+
-| kinto.statsd_backend   | ``kinto.core.statsd``                  | The Python **dotted** location of the StatsD module that should be used  |
-|                        |                                        | for monitoring. Useful to plug custom implementations like Datadog™.     |
-+------------------------+----------------------------------------+--------------------------------------------------------------------------+
-| kinto.statsd_prefix    | ``kinto``                              | The prefix to use when sending data to statsd.                           |
-+------------------------+----------------------------------------+--------------------------------------------------------------------------+
-| kinto.statsd_url       | ``None``                               | The fully qualified URL to use to connect to the statsd host. e.g.       |
-|                        |                                        | ``udp://localhost:8125``                                                 |
-+------------------------+----------------------------------------+--------------------------------------------------------------------------+
-
 Standard Logging
 ::::::::::::::::
 
@@ -425,109 +490,86 @@ Or the equivalent environment variables:
     The application sends an event on startup (mainly for setup check).
 
 
-Monitoring with StatsD
-::::::::::::::::::::::
+.. _monitoring-with-prometheus:
 
-Requires the ``statsd`` package.
+Monitoring with Prometheus
+::::::::::::::::::::::::::
 
-StatsD metrics can be enabled (disabled by default):
+Requires the ``prometheus-client`` package (installed with ``kinto[monitoring]``).
 
-.. code-block:: ini
-
-    kinto.statsd_url = udp://localhost:8125
-    # kinto.statsd_prefix = kinto-prod
+Prometheus metrics can be enabled with (disabled by default):
 
+.. code-block:: ini
 
-Monitoring with New Relic
-:::::::::::::::::::::::::
+    kinto.includes = kinto.plugins.prometheus
 
-Requires the ``newrelic`` package.
+Metrics can then be crawled from the ``/__metrics__`` endpoint.
 
-+-----------------------+----------+--------------------------------------------------------------------------+
-| Setting name          | Default  | What does it do?                                                         |
-+=======================+==========+==========================================================================+
-| kinto.newrelic_config | ``None`` | Location of the newrelic configuration file.                             |
-+-----------------------+----------+--------------------------------------------------------------------------+
-| kinto.newrelic_env    | ``dev``  | The environment the server runs into                                     |
-+-----------------------+----------+--------------------------------------------------------------------------+
 
-New Relic can be enabled (disabled by default):
+.. _monitoring-with-statsd:
 
-.. code-block:: ini
+Monitoring with StatsD
+::::::::::::::::::::::
 
-    kinto.newrelic_config = /location/of/newrelic.ini
-    kinto.newrelic_env = prod
+Requires the ``statsd`` package.
 
+.. note::
 
-.. _configuration-plugins:
+    Only one of *Prometheus* and *StatsD* can be enabled. It will take precedence and the other one will be ignored.
 
-Plugins
-=======
++------------------------+----------------------------------------+--------------------------------------------------------------------------+
+| Setting name           | Default                                | What does it do?                                                         |
++========================+========================================+==========================================================================+
+| kinto.statsd_backend   | ``kinto.core.statsd``                  | The Python **dotted** location of the StatsD module that should be used  |
+|                        |                                        | for monitoring. Useful to plug custom implementations like Datadog™.     |
++------------------------+----------------------------------------+--------------------------------------------------------------------------+
+| kinto.statsd_prefix    | ``kinto``                              | The prefix to use when sending data to statsd.                           |
++------------------------+----------------------------------------+--------------------------------------------------------------------------+
+| kinto.statsd_url       | ``None``                               | The fully qualified URL to use to connect to the statsd host. e.g.       |
+|                        |                                        | ``udp://host:8125``                                                      |
++------------------------+----------------------------------------+--------------------------------------------------------------------------+
 
-It is possible to extend the default Kinto behaviors by using "plugins".
 
-The list of plugins to load at startup can be specified in the settings, as a
-list of Python modules:
+StatsD metrics can be enabled with (disabled by default):
 
 .. code-block:: ini
 
-    kinto.includes = kinto.plugins.default_bucket
-                     kinto.plugins.history
-                     kinto.plugins.admin
-                     kinto-attachment
-                     custom-myplugin
+    kinto.statsd_url = udp://host:8125
+    # kinto.statsd_prefix = kinto-prod
 
-+---------------------------------------+--------------------------------------------------------------------------+
-| Built-in plugins                      | What does it do?                                                         |
-+=======================================+==========================================================================+
-| ``kinto.plugins.accounts``            | It allows users to sign-up and authenticate using username and password  |
-|                                       | (:ref:`more details <api-accounts>`).                                    |
-+---------------------------------------+--------------------------------------------------------------------------+
-| ``kinto.plugins.admin``               | It is a Web admin UI to manage data from a Kinto server.                 |
-|                                       | (:ref:`more details <kinto-admin>`).                                     |
-+---------------------------------------+--------------------------------------------------------------------------+
-| ``kinto.plugins.default_bucket``      | It enables a personal bucket ``default``, where collections are created  |
-|                                       | implicitly (:ref:`more details <buckets-default-id>`).                   |
-+---------------------------------------+--------------------------------------------------------------------------+
-| ``kinto.plugins.flush``               | Adds an endpoint to completely remove all data from the database backend |
-|                                       | for testing/staging purposes. (:ref:`more details <api-flush>`).         |
-+---------------------------------------+--------------------------------------------------------------------------+
-| ``kinto.plugins.history``             | It tracks every action performed on objects within a bucket              |
-|                                       | (:ref:`more details <api-history>`).                                     |
-+---------------------------------------+--------------------------------------------------------------------------+
-| ``kinto.plugins.openid``              | It allows to authenticate users using OpenID Connect from Google,        |
-|                                       | Microsoft, Auth0, etc. (:ref:`more details <api-openid>`).               |
-+---------------------------------------+--------------------------------------------------------------------------+
-| ``kinto.plugins.quotas``              | It allows to limit storage per collection size, number of records, etc.  |
-|                                       | (:ref:`more details <api-quotas>`).                                      |
-+---------------------------------------+--------------------------------------------------------------------------+
 
+StatsD can also be enabled at the *uWSGI* level:
 
-There are `many available packages`_ in Pyramid ecosystem, and it is straightforward to build one,
-since the specified module must just define an ``includeme(config)`` function.
+.. code-block:: ini
 
-.. _many available packages: https://github.com/ITCase/awesome-pyramid
+    [uwsgi]
 
-See `our list of community plugins <https://github.com/Kinto/kinto/wiki/Plugins>`_.
+    # ...
 
-See also: :ref:`tutorial-write-plugin` for more in-depth informations on how
-to create your own plugin.
+    enable-metrics = true
+    plugin = dogstatsd
+    stats-push = dogstatsd:host:8125,kinto.{{ $deployment }}
 
 
-Pluggable components
-::::::::::::::::::::
+Monitoring with New Relic
+:::::::::::::::::::::::::
 
-:term:`Pluggable <pluggable>` components can be substituted from configuration files,
-as long as the replacement follows the original component API.
+Requires the ``newrelic`` package.
 
-.. code-block:: ini
++-----------------------+----------+--------------------------------------------------------------------------+
+| Setting name          | Default  | What does it do?                                                         |
++=======================+==========+==========================================================================+
+| kinto.newrelic_config | ``None`` | Location of the newrelic configuration file.                             |
++-----------------------+----------+--------------------------------------------------------------------------+
+| kinto.newrelic_env    | ``dev``  | The environment the server runs into                                     |
++-----------------------+----------+--------------------------------------------------------------------------+
 
-    kinto.logging_renderer = your_log_renderer.CustomRenderer
+New Relic can be enabled (disabled by default):
 
-This is the simplest way to extend *Kinto*, but will be limited to its
-existing components (cache, storage, log renderer, ...).
+.. code-block:: ini
 
-In order to add extra features, including external packages is the way to go!
+    kinto.newrelic_config = /location/of/newrelic.ini
+    kinto.newrelic_env = prod
 
 
 .. _configuration-authentication:

kinto-19.3.0/docs/requirements.txt

@@ -0,0 +1,12 @@
+Sphinx==8.1.3
+sphinx_rtd_theme==3.0.1
+docutils==0.20.1
+sphinxcontrib-httpdomain==1.8.1
+sphinx-github-changelog==1.4.0
+kinto
+mock==5.1.0
+webtest==3.0.1
+cornice==6.1.0
+pyramid==2.0.2
+python-rapidjson==1.20
+SQLAlchemy==2.0.36

{kinto-18.1.1 → kinto-19.3.0}/kinto/__init__.py

@@ -38,6 +38,7 @@ DEFAULT_SETTINGS = {
     "record_id_generator": "kinto.views.RelaxedUUID",
     "project_name": "kinto",
     "admin_assets_path": None,
+    "metrics_matchdict_fields": ["bucket_id", "collection_id", "group_id", "record_id"],
 }
 
 

{kinto-18.1.1 → kinto-19.3.0}/kinto/core/__init__.py

@@ -66,8 +66,8 @@ DEFAULT_SETTINGS = {
         "kinto.core.initialization.setup_authentication",
         "kinto.core.initialization.setup_backoff",
         "kinto.core.initialization.setup_sentry",
-        "kinto.core.initialization.setup_statsd",
         "kinto.core.initialization.setup_listeners",
+        "kinto.core.initialization.setup_metrics",
         "kinto.core.events.setup_transaction_hook",
     ),
     "event_listeners": "",
@@ -96,6 +96,7 @@ DEFAULT_SETTINGS = {
     "statsd_backend": "kinto.core.statsd",
     "statsd_prefix": "kinto.core",
     "statsd_url": None,
+    "metrics_matchdict_fields": [],
     "storage_backend": "",
     "storage_url": "",
     "storage_max_fetch_size": 10000,