c2cwsgiutils 5.2.1__py3-none-any.whl → 5.2.1.dev197__py3-none-any.whl

c2cwsgiutils/version.py

@@ -1,15 +1,38 @@
 import json
 import logging
 import os
+import re
 import warnings
-from typing import Dict, Optional, cast
+from typing import Optional, cast
 
+import prometheus_client
 import pyramid.config
 
-from c2cwsgiutils import config_utils, stats
+from c2cwsgiutils import config_utils, prometheus
 
-VERSIONS_PATH = "/app/versions.json"
-LOG = logging.getLogger(__name__)
+_VERSIONS_PATH = "/app/versions.json"
+_LOG = logging.getLogger(__name__)
+
+_PACKAGES = os.environ.get("C2C_PROMETHEUS_PACKAGES", "c2cwsgiutils,pyramid,gunicorn,SQLAlchemy").split(",")
+_APPLICATION_PACKAGES = os.environ.get("C2C_PROMETHEUS_APPLICATION_PACKAGE")
+_LABEL_RE_NOT_ALLOWED = re.compile(r"[^a-zA-Z0-9]+")
+
+
+def _sanitize_label(label: str) -> str:
+    # Replace chart that nor a-zA-Z0-9 with _
+    return _LABEL_RE_NOT_ALLOWED.sub("_", label)
+
+
+_PROMETHEUS_VERSIONS_INFO = prometheus_client.Gauge(
+    prometheus.build_metric_name("version"),
+    "The version of the application",
+    labelnames=[
+        "git_hash",
+        *[_sanitize_label(p) for p in _PACKAGES],
+        *([] if _APPLICATION_PACKAGES is None else ["application"]),
+    ],
+    multiprocess_mode="liveall",
+)
 
 
 def init(config: pyramid.config.Configurator) -> None:
@@ -20,7 +43,8 @@ def init(config: pyramid.config.Configurator) -> None:
 
 def includeme(config: pyramid.config.Configurator) -> None:
     """Initialize the versions view."""
-    if os.path.isfile(VERSIONS_PATH):
+
+    if os.path.isfile(_VERSIONS_PATH):
         versions = _read_versions()
         config.add_route(
             "c2c_versions", config_utils.get_base_path(config) + r"/versions.json", request_method="GET"
@@ -28,30 +52,39 @@ def includeme(config: pyramid.config.Configurator) -> None:
         config.add_view(
             lambda request: versions, route_name="c2c_versions", renderer="fast_json", http_cache=0
         )
-        LOG.info("Installed the /versions.json service")
+        _LOG.info("Installed the /versions.json service")
         git_hash = versions["main"]["git_hash"]
 
         if "git_tag" in versions["main"]:
-            LOG.info("Starting version %s (%s)", versions["main"]["git_tag"], git_hash)
+            _LOG.info("Starting version %s (%s)", versions["main"]["git_tag"], git_hash)
         else:
-            LOG.info("Starting version %s", git_hash)
+            _LOG.info("Starting version %s", git_hash)
 
-        if stats.USE_TAGS:
-            stats.increment_counter(["version"], 1, tags={"version": git_hash})
-        else:
-            stats.increment_counter(["version", git_hash], 1)
+        labels = {
+            "git_hash": git_hash,
+            **{
+                _sanitize_label(package): versions["packages"].get(package, "<missing>")
+                for package in _PACKAGES
+            },
+            **(
+                {}
+                if _APPLICATION_PACKAGES is None
+                else {"application": versions["packages"].get(_APPLICATION_PACKAGES, "<missing>")}
+            ),
+        }
+        _PROMETHEUS_VERSIONS_INFO.labels(**labels).set(1)
 
 
-def _read_versions() -> Dict[str, Dict[str, str]]:
+def _read_versions() -> dict[str, dict[str, str]]:
     """Read the version."""
-    with open(VERSIONS_PATH, encoding="utf-8") as file:
+    with open(_VERSIONS_PATH, encoding="utf-8") as file:
         versions = json.load(file)
-    return cast(Dict[str, Dict[str, str]], versions)
+    return cast(dict[str, dict[str, str]], versions)
 
 
 def get_version() -> Optional[str]:
     """Get the version."""
-    if not os.path.isfile(VERSIONS_PATH):
+    if not os.path.isfile(_VERSIONS_PATH):
         return None
     versions = _read_versions()
     return versions["main"]["git_hash"]

{c2cwsgiutils-5.2.1.dist-info → c2cwsgiutils-5.2.1.dev197.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: c2cwsgiutils
-Version: 5.2.1
+Version: 5.2.1.dev197
 Summary: Common utilities for Camptocamp WSGI applications
 Home-page: https://github.com/camptocamp/c2cwsgiutils
 License: BSD-2-Clause
 Keywords: geo,gis,sqlalchemy,orm,wsgi
 Author: Camptocamp
 Author-email: info@camptocamp.com
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Plugins
 Classifier: Framework :: Pyramid
@@ -17,45 +17,48 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 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
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
 Classifier: Typing :: Typed
+Provides-Extra: alembic
 Provides-Extra: all
 Provides-Extra: broadcast
+Provides-Extra: debug
 Provides-Extra: dev
 Provides-Extra: oauth2
+Provides-Extra: sentry
 Provides-Extra: standard
 Provides-Extra: test-images
-Requires-Dist: SQLAlchemy (>=1.4.0,<3.0.0) ; extra == "standard" or extra == "all"
-Requires-Dist: SQLAlchemy-Utils ; extra == "standard" or extra == "all"
-Requires-Dist: alembic ; extra == "standard" or extra == "all"
-Requires-Dist: boltons ; extra == "standard" or extra == "all"
-Requires-Dist: cee_syslog_handler ; extra == "standard" or extra == "all"
+Provides-Extra: tests
+Provides-Extra: webserver
+Requires-Dist: SQLAlchemy (>=1.4.0,<3.0.0)
+Requires-Dist: SQLAlchemy-Utils
+Requires-Dist: alembic ; extra == "standard" or extra == "alembic" or extra == "all"
+Requires-Dist: boltons ; extra == "tests" or extra == "all"
+Requires-Dist: cee_syslog_handler
 Requires-Dist: certifi
-Requires-Dist: cornice ; extra == "standard" or extra == "all"
-Requires-Dist: gunicorn ; extra == "standard" or extra == "all"
-Requires-Dist: lxml ; extra == "standard" or extra == "all"
-Requires-Dist: netifaces ; extra == "standard" or extra == "all"
-Requires-Dist: objgraph ; extra == "standard" or extra == "all"
-Requires-Dist: psycopg2 ; extra == "standard" or extra == "all"
-Requires-Dist: pyjwt ; extra == "oauth2" or extra == "all"
-Requires-Dist: pyramid ; extra == "standard" or extra == "all"
-Requires-Dist: pyramid-tm ; extra == "standard" or extra == "all"
+Requires-Dist: cornice
+Requires-Dist: gunicorn ; extra == "standard" or extra == "webserver" or extra == "all"
+Requires-Dist: lxml ; extra == "tests" or extra == "all"
+Requires-Dist: objgraph ; extra == "debug" or extra == "all"
+Requires-Dist: prometheus-client
+Requires-Dist: psycopg2
+Requires-Dist: pyjwt ; extra == "standard" or extra == "oauth2" or extra == "all"
+Requires-Dist: pyramid
+Requires-Dist: pyramid-tm
+Requires-Dist: pyramid_mako
 Requires-Dist: pyyaml
-Requires-Dist: redis ; extra == "standard" or extra == "broadcast" or extra == "all" or extra == "all"
+Requires-Dist: redis ; extra == "standard" or extra == "broadcast" or extra == "all"
 Requires-Dist: requests
-Requires-Dist: requests-oauthlib ; extra == "oauth2" or extra == "all"
+Requires-Dist: requests-oauthlib ; extra == "standard" or extra == "oauth2" or extra == "all"
 Requires-Dist: scikit-image ; extra == "test-images"
-Requires-Dist: sentry-sdk ; extra == "standard" or extra == "all"
-Requires-Dist: ujson ; extra == "standard" or extra == "all"
+Requires-Dist: sentry-sdk ; extra == "standard" or extra == "sentry" or extra == "all"
+Requires-Dist: ujson
 Requires-Dist: waitress ; extra == "dev" or extra == "all"
-Requires-Dist: zope.interface ; extra == "standard" or extra == "all"
-Requires-Dist: zope.sqlalchemy ; extra == "standard" or extra == "all"
+Requires-Dist: zope.interface
+Requires-Dist: zope.sqlalchemy
 Project-URL: Repository, https://github.com/camptocamp/c2cwsgiutils
 Description-Content-Type: text/markdown
 
@@ -64,8 +67,7 @@ Description-Content-Type: text/markdown
 This is a Python 3 library (>=3.5) providing common tools for Camptocamp WSGI
 applications:
 
-- Provide a small framework for gathering performance statistics about
-  a web application (statsd protocol)
+- Provide prometheus metrics
 - Allow to use a master/slave PostgresQL configuration
 - Logging handler for CEE/UDP logs
   - An optional view to change runtime the log levels
@@ -104,7 +106,7 @@ You should install `c2cwsgiutils` with the tool you use to manage your pip depen
 
 In the `Dockerfile` you should add the following lines:
 
-```
+```dockerfile
 # Generate the version file.
 RUN c2cwsgiutils-genversion $(git rev-parse HEAD)
 
@@ -112,20 +114,19 @@ CMD ["gunicorn", "--paste=/app/production.ini"]
 
 # Default values for the environment variables
 ENV \
-    DEVELOPMENT=0 \
-    SQLALCHEMY_POOL_RECYCLE=30 \
-    SQLALCHEMY_POOL_SIZE=5 \
-    SQLALCHEMY_MAX_OVERFLOW=25 \
-    SQLALCHEMY_SLAVE_POOL_RECYCLE=30 \
-    SQLALCHEMY_SLAVE_POOL_SIZE=5 \
-    SQLALCHEMY_SLAVE_MAX_OVERFLOW=25\
-    LOG_TYPE=console \
-    OTHER_LOG_LEVEL=WARNING \
-    GUNICORN_LOG_LEVEL=WARNING \
-    GUNICORN_ACCESS_LOG_LEVEL=INFO \
-    SQL_LOG_LEVEL=WARNING \
-    C2CWSGIUTILS_LOG_LEVEL=WARNING \
-    LOG_LEVEL=INFO
+  DEVELOPMENT=0 \
+  SQLALCHEMY_POOL_RECYCLE=30 \
+  SQLALCHEMY_POOL_SIZE=5 \
+  SQLALCHEMY_MAX_OVERFLOW=25 \
+  SQLALCHEMY_SLAVE_POOL_RECYCLE=30 \
+  SQLALCHEMY_SLAVE_POOL_SIZE=5 \
+  SQLALCHEMY_SLAVE_MAX_OVERFLOW=25\
+  LOG_TYPE=console \
+  OTHER_LOG_LEVEL=WARNING \
+  GUNICORN_LOG_LEVEL=WARNING \
+  SQL_LOG_LEVEL=WARNING \
+  C2CWSGIUTILS_LOG_LEVEL=WARNING \
+  LOG_LEVEL=INFO
 ```
 
 Add in your `main` function.
@@ -161,8 +162,6 @@ The related environment variables:
 - `SQL_LOG_LEVEL`: The SQL query log level, `WARNING`: no logs, `INFO`: logs the queries,
   `DEBUG` also logs the results, default is `WARNING`.
 - `GUNICORN_ERROR_LOG_LEVEL`: The Gunicorn error log level, default is `WARNING`.
-- `GUNICORN_ACCESS_LOG_LEVEL`: The Gunicorn access log level, the logs have the level `INFO`,
-  default is `WARNING`.
 - `C2CWSGIUTILS_CONFIG`: The fallback ini file to use by gunicorn, default is `production.ini`.
 - `C2CWSGIUTILS_LOG_LEVEL`: The c2c WSGI utils log level, default is `WARNING`.
 - `OTHER_LOG_LEVEL`: The log level for all the other logger, default is `WARNING`.
@@ -331,47 +330,6 @@ The requests module is also patched to monitor requests done without timeout. In
 configure a default timeout with the `C2C_REQUESTS_DEFAULT_TIMEOUT` environment variable
 (`c2c.requests_default_timeout`). If no timeout and no default is specified, a warning is issued.
 
-## Metrics
-
-To enable and configure the metrics framework, you can use:
-
-- STATS_VIEW (c2c.stats_view): if defined, will enable the stats view `{C2C_BASE_PATH}/stats.json`
-- STATSD_ADDRESS (c2c.statsd_address): if defined, send stats to the given statsd server
-- STATSD_PREFIX (c2c.statsd_prefix): prefix to add to every metric names
-- STATSD_USE_TAGS: If true, automatic metrics will use tags
-- STATSD*TAG*{tag_name}: To set a global tag for the service
-
-If enabled, some metrics are automatically generated:
-
-- {STATSD_PREFIX}.route.{verb}.{route_name}.{status}: The time to process a query (includes rendering)
-- {STATSD_PREFIX}.render.{verb}.{route_name}.{status}: The time to render a query
-- {STATSD_PREFIX}.sql.{query}: The time to execute the given SQL query (simplified and normalized)
-- {STATSD_PREFIX}.requests.{scheme}.{hostname}.{port}.{verb}.{status}: The time to execute HTTP requests to
-  outside services (only the time between the start of sending of the request and when the header is
-  back with a chunk of the body)
-- {STATSD_PREFIX}.redis.{command}: The time to execute the given Redis command
-
-You can manually measure the time spent on something like that:
-
-```python
-from c2cwsgiutils import stats
-with stats.timer_context(['toto', 'tutu']):
-    do_something()
-```
-
-It will only add a timer event in case of success. If you want to measure both success and failures, do that:
-
-```python
-from c2cwsgiutils import stats
-with stats.outcome_timer_context(['toto', 'tutu']):
-    do_something()
-```
-
-Other functions exists to generate metrics. Look at the `c2cwsgiutils.stats` module.
-
-Look at the `c2cwsgiutils-stats-db` utility if you want to generate statistics (gauges) about the
-row counts.
-
 ## SQL profiler
 
 The SQL profiler must be configured with the `C2C_SQL_PROFILER_ENABLED` environment variable. That enables a view
@@ -519,27 +477,100 @@ If the `/app/versions.json` exists, a view is added (`{C2C_BASE_PATH}/versions.j
 version of a app. This file is generated by calling the `c2cwsgiutils-genversion [$GIT_TAG] $GIT_HASH`
 command line. Usually done in the [Dockerfile](acceptance_tests/app/Dockerfile) of the WSGI application.
 
-## Metrics
+## Prometheus
 
-The path `/metrics` provide some metrics for Prometheus.
-By default we have the `smap` `pss`, but we can easily add the `rss`, `size` or your custom settings:
+[Prometheus client](https://github.com/prometheus/client_python) is integrated in c2cwsgiutils.
 
-Example:
+It will work in multi process mode with the limitation listed in the
+[`prometheus_client` documentation](https://github.com/prometheus/client_python#multiprocess-mode-eg-gunicorn).
 
+To enable it you should provide the `C2CWSGIUTILS_PROMETHEUS_PORT` environment variable.
+For security reason, this port should not be exposed.
+
+We can customize it with the following environment variables:
+
+- `C2C_PROMETHEUS_PREFIX`: to customize the prefix, default is `c2cwsggiutils-`.
+- `C2C_PROMETHEUS_PACKAGES` the packages that will be present in the version information, default is `c2cwsgiutils,pyramid,gunicorn,sqlalchemy`.
+- `C2C_PROMETHEUS_APPLICATION_PACKAGE` the packages that will be present in the version information as application.
+
+And you should add in your `gunicorn.conf.py`:
+
+```python
+from prometheus_client import multiprocess
+
+
+def on_starting(server):
+    from c2cwsgiutils import prometheus
+
+    del server
+
+    prometheus.start()
+
+
+def post_fork(server, worker):
+    from c2cwsgiutils import prometheus
+
+    del server, worker
+
+    prometheus.cleanup()
+
+
+def child_exit(server, worker):
+    del server
+
+    multiprocess.mark_process_dead(worker.pid)
 ```
-from import c2cwsgiutils.metrics import add_provider, Provider, MemoryMapProvider
 
-class CustomProvider(Provider):
-    def __init__(self):
-        super().__init__("my_metrics", "My Metric")
+In your `Dockerfile` you should add:
+
+```dockerfile
+RUN mkdir -p /prometheus-metrics \
+    && chmod a+rwx /prometheus-metrics
+ENV PROMETHEUS_MULTIPROC_DIR=/prometheus-metrics
+```
 
-    def get_data(self):
-        return [({'metadata_key': 'matadata_value'}, metrics_value)]
+### Add custom metric collector
 
-add_provider(MemoryMapProvider('rss'))
-add_provider(CustomProvider())
+See [official documentation](https://github.com/prometheus/client_python#custom-collectors).
+
+Related to the Unix process.
+
+```python
+from c2cwsgiutils import broadcast, prometheus
+
+prometheus.MULTI_PROCESS_COLLECTOR_BROADCAST_CHANNELS.append("prometheus_collector_custom")
+broadcast.subscribe("c2cwsgiutils_prometheus_collect_gc", _broadcast_collector_custom)
+my_custom_collector_instance = MyCustomCollector()
+
+
+def _broadcast_collector_custom() -> List[prometheus.SerializedGauge]:
+    """Get the collected GC gauges."""
+
+    return prometheus.serialize_collected_data(my_custom_collector_instance)
+```
+
+Related to the host, use that in the `gunicorn.conf.py`:
+
+```python
+def on_starting(server):
+    from c2cwsgiutils import prometheus
+
+    del server
+
+    registry = CollectorRegistry()
+    registry.register(MyCollector())
+    prometheus.start(registry)
 ```
 
+### Database metrics
+
+Look at the `c2cwsgiutils-stats-db` utility if you want to generate statistics (gauges) about the
+row counts.
+
+### Usage of metrics
+
+With c2cwsgiutils each instance (Pod) has its own metrics, so we need to aggregate them to have the metrics for the service you probably need to use `sum by (<fields>) (<metric>)` to get the metric (especially for counters).
+
 ## Custom scripts
 
 To have the application initialized in a script you should use the
@@ -592,7 +623,7 @@ have dumps of a few things:
 - memory usage: `{C2C_BASE_PATH}/debug/memory?secret={C2C_SECRET}&limit=30&analyze_type=builtins.dict&python_internals_map=false`
 - object ref: `{C2C_BASE_PATH}/debug/show_refs.dot?secret={C2C_SECRET}&analyze_type=gunicorn.app.wsgiapp.WSGIApplication&analyze_id=12345&max_depth=3&too_many=10&filter=1024&no_extra_info&backrefs`
   `analyze_type` and `analyze_id` should not ve used toogether, you can use it like:
-  ```
+  ```bash
   curl "<URL>" > /tmp/show_refs.dot
   dot -Lg -Tpng /tmp/show_refs.dot > /tmp/show_refs.png
   ```
@@ -653,7 +684,7 @@ client. In production mode, you can still get them by sending the secret defined
 
 If you want to use pyramid_debugtoolbar, you need to disable exception handling and configure it like that:
 
-```
+```ini
 pyramid.includes =
     pyramid_debugtoolbar
 debugtoolbar.enabled = true
@@ -727,3 +758,41 @@ To make a release:
 - Add the new branch name in the `.github/workflows/rebuild.yaml` and
   `.github/workflows/audit.yaml` files.
 
+## Testing
+
+### Screenshots
+
+To test the screenshots, you need to install `node` with `npm`, to do that add the following lines in your `Dockerfile`:
+
+```dockerfile
+RUN --mount=type=cache,target=/var/lib/apt/lists \
+    --mount=type=cache,target=/var/cache,sharing=locked \
+    . /etc/os-release \
+    && echo "deb https://deb.nodesource.com/node_18.x ${VERSION_CODENAME} main" > /etc/apt/sources.list.d/nodesource.list \
+    && curl --silent https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add - \
+    && apt-get update \
+    && apt-get install --assume-yes --no-install-recommends 'nodejs=18.*'
+```
+
+To do the image test call `check_screenshot` e.g.:
+
+```python
+def test_screenshot(app_connection):
+    image.check_screenshot(
+        app_connection.base_url + "my-path",
+        width=800,
+        height=600,
+        result_folder="results",
+        expected_filename=os.path.join(os.path.dirname(__file__), "my-check.expected.png"),
+    )
+```
+
+## Contributing
+
+Install the pre-commit hooks:
+
+```bash
+pip install pre-commit
+pre-commit install --allow-missing-config
+```
+

c2cwsgiutils-5.2.1.dev197.dist-info/RECORD

@@ -0,0 +1,67 @@
+c2cwsgiutils/__init__.py,sha256=YHZ6OY8BvFrZAoBpbEWmAZ-60nqDer_CKHgY-LSHAKs,3986
+c2cwsgiutils/acceptance/__init__.py,sha256=vjtpPfu0kbXUOYMx15Z8713IfPFZA9XnkUKkIFtVj_M,1500
+c2cwsgiutils/acceptance/connection.py,sha256=WKD4yDDvOqpKTcwCn9cIK5W_AWxumGboe8Sel7ZeXHI,9146
+c2cwsgiutils/acceptance/image.py,sha256=_LNKuUYnljZTyPoVqtOLvWb5HWFr_7mQXWQh2ow4o4Q,7200
+c2cwsgiutils/acceptance/package-lock.json,sha256=Y50ESiYKsdaZsmTo448ScQa1Vrn8DnuDgpuEkSXSHIE,76668
+c2cwsgiutils/acceptance/package.json,sha256=nQN96fhokGljwDhBoLn00rm9jSd7_U38qRs44oHY394,101
+c2cwsgiutils/acceptance/print.py,sha256=j5K1c2Kn0eEnhgdbZNBVkdscK02pQhtPIh6lJzHMJcM,2323
+c2cwsgiutils/acceptance/screenshot.js,sha256=pp8G5Bb04aDb1VX7PnLwBxVhaxN9p5PUU3iPWENVGoI,1899
+c2cwsgiutils/acceptance/utils.py,sha256=-NgLlG_oQj3P_ZiK293RG7ZHPumg0WrDwo_APOI3WG4,1851
+c2cwsgiutils/auth.py,sha256=73NkFu4mKeDwulECRabSFhpNUKoEfP-0M3JnTQ9lJ3s,9333
+c2cwsgiutils/broadcast/__init__.py,sha256=Ae0qU6nP0G6Qa6Zi-vJK4Om8T9HKxmaz5-uOAJKZZdE,4360
+c2cwsgiutils/broadcast/interface.py,sha256=jE8BSy9N7xnPmq5U0m852sFFhx46c7Uo9SyFJTCde9o,636
+c2cwsgiutils/broadcast/local.py,sha256=24aIRdFOR2CXZfp_F2R_S1QW-yon3EyTM6TvljWVlP0,1083
+c2cwsgiutils/broadcast/redis.py,sha256=sxBsYZtMNXMOck6a_Mcb3QZjjW4lPTxnImTfL1vv14g,5085
+c2cwsgiutils/broadcast/utils.py,sha256=0fQZXPu3p_5LEJpGenJwiiMxECQjJhjZBjIkBk8h-ng,272
+c2cwsgiutils/client_info.py,sha256=t35d8yI6MVDoB3i2yRKk0k-GmLP3v-WCis5JVzC6XFg,3044
+c2cwsgiutils/config_utils.py,sha256=N_DPNRCBmeomhv2cJN5OQALrTAG29FCCk3VeugWrBwI,1523
+c2cwsgiutils/coverage_setup.py,sha256=fES0sdhFy6oaeOCuP1qjjm7PQL9l_O8rUKZhRvRBRwQ,839
+c2cwsgiutils/db.py,sha256=N_9zxxXYKiKwfNxs5KsunKYb_gUZQkTrlw6HZu5qsgQ,16174
+c2cwsgiutils/db_maintenance_view.py,sha256=ejSNCv7vZIDjXctDTWTXEYTnUYFVVNIecFLeDlCkDBA,3076
+c2cwsgiutils/debug/__init__.py,sha256=80zdAZnE9cwgQW1odE2aOauIxYsG5CQpWvHPcslRue8,1239
+c2cwsgiutils/debug/_listeners.py,sha256=sXXHbPHQaSRMrzUC2ryiSDsBXuTdVbpQOxmMmhZ3n90,4378
+c2cwsgiutils/debug/_views.py,sha256=zUeIshxBshBrlTz0p1I1LUi6HiJBOAAiDPrlOJsziQA,7522
+c2cwsgiutils/debug/utils.py,sha256=TPlJC5qKeFnvbgq1xjlfrrRgDcV5kIR69IPJgNcIZQY,2311
+c2cwsgiutils/errors.py,sha256=LUhZF3BW1i-v20x3EE-rZbT-TpdugpxiW7p5iCAu73Q,6723
+c2cwsgiutils/health_check.py,sha256=O-GGS0aicTuMz4gqE-btk8ipzVi5allDe6sFuyOANOA,19977
+c2cwsgiutils/index.py,sha256=jFThEi1sbsd2RnMNwhXpVAQUcpZSxW7ava9kxYwO5Zk,16703
+c2cwsgiutils/loader.py,sha256=x_yHRTDzzlQ61fHonWnnG01xdqFuXpbGZMNN--tN25U,622
+c2cwsgiutils/logging_view.py,sha256=W6-dFTz00hLt6BGJ8V3-4ip4AdxTyPG2W5vQjIuKiQs,3357
+c2cwsgiutils/models_graph.py,sha256=laip8EdhI2hoGZVAotdrsgMwiNbwsJPjknKkRq1eEq0,2680
+c2cwsgiutils/pretty_json.py,sha256=f1-oecFX9hub1nD32mmZRjOTIxhV8bVSt3Meqw68sNU,1698
+c2cwsgiutils/profiler.py,sha256=3tIwoDSzOKQ06ug_U6j5VDR1BQ9auUOqdJRRLRhDoHw,739
+c2cwsgiutils/prometheus.py,sha256=a09eTEmmhv_WENYx5I8jZUFdbUuVztE_lbMdOJNDm1U,6494
+c2cwsgiutils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+c2cwsgiutils/pyramid.py,sha256=H-b5abZvxt9MkMFjyWOjWzPa02YRhZR6LDiMCaYLq5s,1388
+c2cwsgiutils/pyramid_logging.py,sha256=vVPrkAKZoIwb6SPf-omZDGyiKfElBf5yo_dPaIo-8ko,3730
+c2cwsgiutils/redis_stats.py,sha256=triLtzryGXJKvCUw4TreYpF22BpUKPdrMp30ZGKsXwU,1545
+c2cwsgiutils/redis_utils.py,sha256=dSe7qvnobCglKwDbYg4OwCxWxWg4migxmHbgClU2Qnw,4630
+c2cwsgiutils/request_tracking/__init__.py,sha256=5SxMqBV3_w6SyykB1FFKug7XqzwdPhQdQOZ4VKUM4A8,4039
+c2cwsgiutils/request_tracking/_sql.py,sha256=ME13tdXV2Vvhvscon9DbDUqehNWcn4uL75uqzcN5-Mg,577
+c2cwsgiutils/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+c2cwsgiutils/scripts/genversion.py,sha256=GKmD08-H83hiKqXxy4odABuWqD5gADs_YEzM3TzHxEA,1985
+c2cwsgiutils/scripts/stats_db.py,sha256=QNwtEKznCgOKg4ZsAFED9ISS-THgdwD2km_oVoII5XU,10317
+c2cwsgiutils/scripts/test_print.py,sha256=UeOZa7jTazgEq5BRJD6lq-u9K6G4movf-sOVKTEs1cQ,2096
+c2cwsgiutils/sentry.py,sha256=X-8Pd9wEi6EKMde50LxcdeM6LYBRyGnJpkPgEmFgqpg,5029
+c2cwsgiutils/services.py,sha256=qz51oCZOC0Lj2_ig4UuHIm0ZZO3FfpFTxrXBWZ_oaNo,1567
+c2cwsgiutils/setup_process.py,sha256=RKZGQdcKvHh_YU2mA-J5FQ01XNGj-SevcPNQB0439rs,3428
+c2cwsgiutils/sql_profiler/__init__.py,sha256=lZYq83LYlm_P4uNMv0WU_B9Obl90YaNzkqWtteUHadg,876
+c2cwsgiutils/sql_profiler/_impl.py,sha256=0UWSZDEm2E9Zeujd8UFRu0cIyyHBMxXxdmzt0cmuv0s,3702
+c2cwsgiutils/sqlalchemylogger/README.md,sha256=WEyJSrBjedtX1FFrYiq4oMaWMt1fNxRkJYmJWnAoz3g,1552
+c2cwsgiutils/sqlalchemylogger/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+c2cwsgiutils/sqlalchemylogger/_filters.py,sha256=OJQ9_WA-fd9fMZ7TUNFzHHTPI6msw2NVBl5RoeYFnGw,752
+c2cwsgiutils/sqlalchemylogger/_models.py,sha256=A9SQ8AqUazCMemVjp5p_1x4bZG3LAYW9pOXT84FdNkE,1471
+c2cwsgiutils/sqlalchemylogger/examples/example.py,sha256=n48dJdUi1FH1hfBMAbfHLGPSb1bOVD8pXMxXB57PnpQ,460
+c2cwsgiutils/sqlalchemylogger/handlers.py,sha256=Qul-Bebmxqt4KvFU4TqjUGnbmpAVBviF5pSV3duUqG0,4801
+c2cwsgiutils/static/favicon-16x16.png,sha256=LKk6RFvb3NlPIZdDfAodE8H9IN8KM6CMGnMx4vOHlUQ,887
+c2cwsgiutils/static/favicon-32x32.png,sha256=i4ucx08zAZARd8e7JTMGK-gb5WcOmyuDN6IN4brsEOo,1216
+c2cwsgiutils/stats_pyramid/__init__.py,sha256=7P10LjLv3c-ObEDGuYmRF_RFt7fRmO80ruqTGQAyC6w,747
+c2cwsgiutils/stats_pyramid/_db_spy.py,sha256=ZGRdrI17Bdl3mzaLjfPyAaEW3KK8Pikrgi-0WmH7zCs,2917
+c2cwsgiutils/stats_pyramid/_pyramid_spy.py,sha256=P212MGGl2VV_7UU4AXZA-rOuF7ouaONRklZwpas2wc8,3209
+c2cwsgiutils/templates/index.html.mako,sha256=zrdMxncl3PFwdg1TVDKAjH1CaXw1m7yr9dj8Hi7rYGw,1362
+c2cwsgiutils/version.py,sha256=z4of1DDr6J7PDw4AUOz31Gp63khgXf3JfiIaoWUM-9I,2870
+c2cwsgiutils-5.2.1.dev197.dist-info/LICENSE,sha256=rM6IWxociA3daRkXnNLYOxGndT5fbs3BfVZCA2Xgt-g,1304
+c2cwsgiutils-5.2.1.dev197.dist-info/METADATA,sha256=AXKlHCfO4_Uq--GCt6EpxznwArBUXtSO-IQrrlH-CH8,32515
+c2cwsgiutils-5.2.1.dev197.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+c2cwsgiutils-5.2.1.dev197.dist-info/entry_points.txt,sha256=ujgqMTL1awN9qDg8WXmrF7m0fgR-hslUM6zKH86pvy0,703
+c2cwsgiutils-5.2.1.dev197.dist-info/RECORD,,

{c2cwsgiutils-5.2.1.dist-info → c2cwsgiutils-5.2.1.dev197.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.5.0
+Generator: poetry-core 1.7.0
 Root-Is-Purelib: true
 Tag: py3-none-any

c2cwsgiutils/acceptance/composition.py

@@ -1,129 +0,0 @@
-import logging
-import os
-import subprocess  # nosec
-import sys
-import time
-import warnings
-from typing import Any, Callable, Dict, List, Mapping, Optional, cast
-
-import netifaces
-from pyramid.request import Request
-
-from c2cwsgiutils.acceptance import utils
-
-LOG = logging.getLogger(__name__)
-logging.basicConfig(
-    level=logging.DEBUG,
-    format="TEST: %(asctime)-15s %(levelname)5s %(name)s %(message)s",
-    stream=sys.stdout,
-)
-logging.getLogger("requests.packages.urllib3.connectionpool").setLevel(logging.WARN)
-
-
-def _try(what: Callable[[], Any], fail: bool = True, times: int = 5, delay: int = 10) -> Optional[Any]:
-    for i in range(times):
-        try:
-            return what()
-        except:  # pylint: disable=bare-except
-            LOG.warning("Exception:", exc_info=True)
-            if i + 1 == times and fail:
-                raise
-            time.sleep(delay)
-    return None
-
-
-class Composition:
-    """The Docker composition."""
-
-    def __init__(self, request: Request, composition: str, coverage_paths: Optional[str] = None) -> None:
-        warnings.warn("The c2cwsgiutils.acceptance.composition should be used only if it's relay needed.")
-        self.cwd = os.path.dirname(composition)
-        filename = os.path.basename(composition)
-        self.docker_compose = ["docker-compose"]
-        if filename != "docker-compose.yaml":
-            self.docker_compose.append("--file=" + filename)
-        self.coverage_paths = coverage_paths
-        env = Composition._get_env()
-        if os.environ.get("docker_start", "1") == "1":
-            self.dc_try(["stop"], fail=False)
-            self.dc_try(["rm", "-f"], fail=False)
-            self.dc_try(["build"], fail=False)
-            self.dc_try(["up", "-d"], fail=False)
-
-        # Setup something that redirects the docker container logs to the test output
-        log_watcher = subprocess.Popen(  # nosec, pylint: disable=consider-using-with
-            self.docker_compose + ["logs", "--follow", "--no-color"],
-            cwd=self.cwd,
-            env=env,
-            stderr=subprocess.STDOUT,
-        )
-        request.addfinalizer(log_watcher.kill)
-        if os.environ.get("docker_stop", "1") == "1":
-            request.addfinalizer(self.stop_all)
-
-    def dc(self, args: List[str], **kwargs: Any) -> str:
-        return cast(
-            str,
-            subprocess.check_output(  # nosec
-                self.docker_compose + args,
-                cwd=self.cwd,
-                env=Composition._get_env(),
-                stderr=subprocess.STDOUT,
-                **kwargs,
-            ).decode(),
-        )
-
-    def dc_try(self, args: List[str], **kwargs: Any) -> None:
-        _try(
-            lambda: self.dc(args),
-            **kwargs,
-        )
-
-    def stop_all(self) -> None:
-        self.dc_try(["stop"])
-        if self.coverage_paths:
-            target_dir = "/reports/"
-            os.makedirs(target_dir, exist_ok=True)
-            for path in self.coverage_paths:
-                try:
-                    subprocess.check_call(  # nosec
-                        ["docker", "cp", path, target_dir], stderr=subprocess.STDOUT
-                    )
-                except Exception:
-                    self.dc(["ps"])
-                    raise
-
-    def stop(self, container: str) -> None:
-        self.dc_try(["stop", container])
-
-    def restart(self, container: str) -> None:
-        self.dc_try(["restart", container])
-
-    def run(self, container: str, *command: str, **kwargs: Dict[str, Any]) -> str:
-        return self.dc(
-            ["run", "--rm", container] + list(command),
-            **kwargs,
-        )
-
-    def exec(self, container: str, *command: str, **kwargs: Dict[str, Any]) -> str:
-        return self.dc(["exec", "-T", container] + list(command), **kwargs)
-
-    @staticmethod
-    def _get_env() -> Mapping[str, str]:
-        """
-        Make sure the DOCKER_TAG environment variable.
-
-        Used in the docker-compose.yaml file is correctly set when we call docker-compose.
-        """
-        env = dict(os.environ)
-        if "DOCKER_TAG" not in env:
-            env["DOCKER_TAG"] = "latest"
-        if utils.in_docker():
-            env["DOCKER_IP"] = netifaces.gateways()[netifaces.AF_INET][0][0]
-            env["DOCKER_CB_HOST"] = env["DOCKER_IP"]
-        else:
-            env["DOCKER_IP"] = netifaces.ifaddresses("docker0")[netifaces.AF_INET][0]["addr"]
-            env["DOCKER_CB_HOST"] = "localhost"
-        default_iface = netifaces.gateways()[netifaces.AF_INET][0][1]
-        env["TEST_IP"] = netifaces.ifaddresses(default_iface)[netifaces.AF_INET][0]["addr"]
-        return env