kinto 18.1.0__tar.gz → 19.2.0__tar.gz

{kinto-18.1.0 → kinto-19.2.0}/.github/workflows/publish.yml

@@ -86,7 +86,7 @@ jobs:
           images: kinto/kinto-server
 
       - name: Build and push Docker image
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: ./Dockerfile

{kinto-18.1.0 → kinto-19.2.0}/.github/workflows/test.yml

@@ -179,7 +179,7 @@ jobs:
           install: true
 
       - name: Build container
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           cache-from: type=local,src=${{ env.DOCKER_CACHE}}
           cache-to: type=local,dest=${{ env.DOCKER_CACHE}},mode=max

{kinto-18.1.0 → kinto-19.2.0}/Makefile

@@ -25,8 +25,9 @@ help:
 	@echo "  migrate                     run the kinto migrations"
 	@echo "  lint                        run the code linters"
 	@echo "  tests                       run all the tests with all the supported python interpreters (same as CI)"
+	@echo "  test-deps                   pulls and runs docker postgres and memcached containers for tests"
 	@echo "  tdd                         run pytest-watch to rerun tests automatically on changes for tdd"
-	@echo "  tests-once  	             only run the tests once with the default python interpreter"
+	@echo "  tests-once  	               only run the tests once with the default python interpreter"
 	@echo "  functional                  run functional test against a real kinto"
 	@echo "  browser-test                run browser test against a real kinto"
 	@echo "  clean                       remove *.pyc files and __pycache__ directory"
@@ -94,6 +95,14 @@ tests: install-postgres install-monitoring install-memcached version-file instal
 tests-raw: version-file install-dev
 	$(VENV)/bin/py.test
 
+test-deps:
+	docker pull memcached
+	docker pull postgres
+	docker run -p 11211:11211 --name kinto-memcached -d memcached || echo "cannot start memcached, already exists?"
+	docker run -p 5432:5432 --name kinto-postgres -e POSTGRES_PASSWORD=postgres -d postgres  || echo "cannot start postgres, already exists?"
+	sleep 2
+	PGPASSWORD=postgres psql -c "CREATE DATABASE testdb ENCODING 'UTF8' TEMPLATE template0;" -U postgres -h localhost
+
 lint: install-dev
 	$(VENV)/bin/ruff check kinto tests docs/conf.py
 	$(VENV)/bin/ruff format --check kinto tests docs/conf.py
@@ -123,6 +132,8 @@ clean:
 	find . -name '*.pyc' -delete
 	find . -name '__pycache__' -type d | xargs rm -fr
 	rm -fr docs/_build/
+	docker rm -f kinto-memcached || echo ""
+	docker rm -f kinto-postgres || echo ""
 
 distclean: clean
 	rm -fr *.egg *.egg-info/ dist/ build/

{kinto-18.1.0/kinto.egg-info → kinto-19.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kinto
-Version: 18.1.0
+Version: 19.2.0
 Summary: Kinto Web Service - Store, Sync, Share, and Self-Host.
 Author-email: Mozilla Services <developers@kinto-storage.org>
 License: Copyright 2012 - Mozilla Foundation
@@ -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

{kinto-18.1.0 → kinto-19.2.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

{kinto-18.1.0 → kinto-19.2.0}/constraints.in

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

{kinto-18.1.0 → kinto-19.2.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.2
+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.1.1
+build==1.2.2.post1
     # via -r constraints.in
-certifi==2023.11.17
+certifi==2024.7.4
     # via
     #   requests
     #   sentry-sdk
@@ -38,21 +38,17 @@ cornice-swagger==1.0.1
     # via -r constraints.in
 coverage==7.4.0
     # via pytest-cov
-dockerflow==2024.3.0
+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
-    # via
-    #   playwright
-    #   sqlalchemy
+    # via playwright
 hupper==1.12
     # via pyramid
-idna==3.6
+idna==3.7
     # via
     #   jsonschema
     #   requests
@@ -70,7 +66,7 @@ jsonpointer==2.4
     #   jsonschema
 jsonref==1.1.0
     # via bravado-core
-jsonschema==4.21.1
+jsonschema==4.23.0
     # via
     #   -r constraints.in
     #   bravado-core
@@ -83,7 +79,7 @@ markupsafe==2.1.4
     # via werkzeug
 msgpack==1.0.7
     # via bravado-core
-newrelic==9.7.1
+newrelic==10.1.0
     # via -r constraints.in
 packaging==23.2
     # via
@@ -98,13 +94,15 @@ plaster==1.1.2
     #   pyramid
 plaster-pastedeploy==1.0.1
     # via pyramid
-playwright==1.42.0
+playwright==1.47.0
     # via -r constraints.in
-pluggy==1.3.0
+pluggy==1.5.0
     # via pytest
+prometheus-client==0.21.0
+    # via -r constraints.in
 psycopg2==2.9.9
     # via -r constraints.in
-pyee==11.0.1
+pyee==12.0.0
     # via playwright
 pyproject-hooks==1.0.0
     # via build
@@ -117,18 +115,18 @@ pyramid==2.0.2
     #   pyramid-tm
 pyramid-mailer==0.15.1
     # via -r constraints.in
-pyramid-multiauth==1.0.1
+pyramid-multiauth==1.0.2
     # via -r constraints.in
 pyramid-tm==2.5
     # via -r constraints.in
-pytest==7.4.4
+pytest==8.3.3
     # via
     #   -r constraints.in
     #   pytest-cache
     #   pytest-cov
 pytest-cache==1.0
     # via -r constraints.in
-pytest-cov==4.1.0
+pytest-cov==5.0.0
     # via -r constraints.in
 python-dateutil==2.9.0.post0
     # via
@@ -151,7 +149,7 @@ referencing==0.32.1
     #   jsonschema-specifications
 repoze-sendmail==4.4.1
     # via pyramid-mailer
-requests==2.31.0
+requests==2.32.3
     # via
     #   -r constraints.in
     #   bravado-core
@@ -163,9 +161,9 @@ rpds-py==0.17.1
     # via
     #   jsonschema
     #   referencing
-ruff==0.3.3
+ruff==0.6.9
     # 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 +175,7 @@ six==1.16.0
     #   rfc3339-validator
 soupsieve==2.5
     # via beautifulsoup4
-sqlalchemy==2.0.28
+sqlalchemy==2.0.35
     # via
     #   -r constraints.in
     #   sentry-sdk
@@ -186,13 +184,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
@@ -212,7 +204,7 @@ typing-extensions==4.9.0
     #   swagger-spec-validator
 uri-template==1.3.0
     # via jsonschema
-urllib3==2.1.0
+urllib3==2.2.2
     # via
     #   requests
     #   sentry-sdk
@@ -224,15 +216,15 @@ waitress==3.0.0
     # 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.1
+werkzeug==3.0.4
     # via -r constraints.in
 zope-deprecation==5.0
     # via pyramid

{kinto-18.1.0 → kinto-19.2.0}/docs/community.rst

@@ -119,7 +119,7 @@ Get started!
 
     git clone git@github.com:your_name_here/kinto.git
 
-3. Setup a local PostgreSQL database for the tests (:ref:`more details <postgresql-install>`)::
+3. Run ``make test-deps``, or setup a local PostgreSQL database (:ref:`more details <postgresql-install>`)::
 
     sudo apt-get install postgresql
     sudo -n -u postgres -s -- psql -c "ALTER USER postgres WITH PASSWORD 'postgres';" -U postgres

{kinto-18.1.0 → kinto-19.2.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.0 → kinto-19.2.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-18.1.0 → kinto-19.2.0}/docs/requirements.txt

@@ -1,12 +1,12 @@
-Sphinx==7.2.6
+Sphinx==7.4.4
 sphinx_rtd_theme==2.0.0
 docutils==0.20.1
 sphinxcontrib-httpdomain==1.8.1
-sphinx-github-changelog==1.3.0
+sphinx-github-changelog==1.4.0
 kinto
 mock==5.1.0
-webtest==3.0.0
+webtest==3.0.1
 cornice==6.1.0
 pyramid==2.0.2
-python-rapidjson==1.16
-SQLAlchemy==2.0.28
+python-rapidjson==1.20
+SQLAlchemy==2.0.35

{kinto-18.1.0 → kinto-19.2.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": "",