c2cwsgiutils 5.1.7.dev20230901073305__py3-none-any.whl → 5.2.1.dev197__py3-none-any.whl

c2cwsgiutils/stats_pyramid/_db_spy.py

@@ -1,15 +1,24 @@
 import logging
 import re
-from typing import Any, Callable, Dict, Optional
+import time
+from typing import Any, Callable
 
+import prometheus_client
 import sqlalchemy.event
 from sqlalchemy.engine import Connection, Engine
 from sqlalchemy.orm import Session
 
-from c2cwsgiutils import stats
+from c2cwsgiutils import prometheus
 
 LOG = logging.getLogger(__name__)
 
+_PROMETHEUS_DB_SUMMARY = prometheus_client.Summary(
+    prometheus.build_metric_name("database"),
+    "Database requests",
+    ["what"],
+    unit="seconds",
+)
+
 
 def _jump_string(content: str, pos: int) -> int:
     quote_char = content[pos]
@@ -58,17 +67,11 @@ def _simplify_sql(sql: str) -> str:
 
 
 def _create_sqlalchemy_timer_cb(what: str) -> Callable[..., Any]:
-    if stats.USE_TAGS and what != "commit":
-        key = ["sql"]
-        tags: Optional[Dict[str, str]] = dict(query=what)
-    else:
-        key = ["sql", what]
-        tags = None
-    measure = stats.timer(key, tags)
+    start = time.perf_counter()
 
     def after(*_args: Any, **_kwargs: Any) -> None:
-        duration = measure.stop()
-        LOG.debug("Execute statement '%s' in %d.", what, duration)
+        _PROMETHEUS_DB_SUMMARY.labels({"query": what}).observe(time.perf_counter() - start)
+        LOG.debug("Execute statement '%s' in %d.", what, time.perf_counter() - start)
 
     return after
 

c2cwsgiutils/stats_pyramid/_pyramid_spy.py

@@ -1,11 +1,26 @@
-from typing import Any, Callable, Dict, Optional
+import time
+from typing import Callable, Optional
 
+import prometheus_client
 import pyramid.config
 import pyramid.events
 import pyramid.request
 from pyramid.httpexceptions import HTTPException
 
-from c2cwsgiutils import stats
+from c2cwsgiutils import prometheus
+
+_PROMETHEUS_PYRAMID_ROUTES_SUMMARY = prometheus_client.Summary(
+    prometheus.build_metric_name("pyramid_routes"),
+    "Pyramid routes",
+    ["method", "route", "status", "group"],
+    unit="seconds",
+)
+_PROMETHEUS_PYRAMID_VIEWS_SUMMARY = prometheus_client.Summary(
+    prometheus.build_metric_name("pyramid_render"),
+    "Pyramid render",
+    ["method", "route", "status", "group"],
+    unit="seconds",
+)
 
 
 def _add_server_metric(
@@ -14,10 +29,10 @@ def _add_server_metric(
     duration: Optional[float] = None,
     description: Optional[str] = None,
 ) -> None:
-    # format: <name>;dur=<duration>;desc=<description>
+    # format: <name>;due=<duration>;desc=<description>
     metric = name
     if duration is not None:
-        metric += ";dur=" + str(round(duration * 1000))
+        metric += ";due=" + str(round(duration * 1000))
     if description is not None:
         metric += ";desc=" + description
 
@@ -28,14 +43,16 @@ def _add_server_metric(
 
 
 def _create_finished_cb(
-    kind: str, measure: stats.Timer
+    kind: str, measure: prometheus_client.Summary
 ) -> Callable[[pyramid.request.Request], None]:  # pragma: nocover
+    start = time.process_time()
+
     def finished_cb(request: pyramid.request.Request) -> None:
         if request.exception is not None:
             if isinstance(request.exception, HTTPException):
                 status = request.exception.code
             else:
-                status = 500
+                status = 599
         else:
             status = request.response.status_code
         if request.matched_route is None:
@@ -44,32 +61,24 @@ def _create_finished_cb(
             name = request.matched_route.name
             if kind == "route":
                 _add_server_metric(request, "route", description=name)
-        if stats.USE_TAGS:
-            key = [kind]
-            tags: Optional[Dict[str, Any]] = dict(
-                method=request.method, route=name, status=status, group=status // 100
-            )
-        else:
-            key = [kind, request.method, name, status]
-            tags = None
-        duration = measure.stop(key, tags)
-        _add_server_metric(request, kind, duration=duration)
+        measure.labels(
+            method=request.method, route=name, status=status, group=str(status // 100 * 100)
+        ).observe(time.process_time() - start)
+        _add_server_metric(request, kind, duration=time.process_time() - start)
 
     return finished_cb
 
 
 def _request_callback(event: pyramid.events.NewRequest) -> None:  # pragma: nocover
     """Finish the callback called when a new HTTP request is incoming."""
-    measure = stats.timer()
-    event.request.add_finished_callback(_create_finished_cb("route", measure))
+    event.request.add_finished_callback(_create_finished_cb("route", _PROMETHEUS_PYRAMID_ROUTES_SUMMARY))
 
 
 def _before_rendered_callback(event: pyramid.events.BeforeRender) -> None:  # pragma: nocover
     """Finish the callback called when the rendering is starting."""
     request = event.get("request", None)
     if request:
-        measure = stats.timer()
-        request.add_finished_callback(_create_finished_cb("render", measure))
+        request.add_finished_callback(_create_finished_cb("render", _PROMETHEUS_PYRAMID_VIEWS_SUMMARY))
 
 
 def init(config: pyramid.config.Configurator) -> None:  # pragma: nocover

c2cwsgiutils/templates/index.html.mako

@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
+    <link
+      rel="icon"
+      type="image/png"
+      sizes="32x32"
+      href="${request.static_url('c2cwsgiutils:static/favicon-32x32.png')}"
+      referrerpolicy="no-referrer"
+    />
+    <link
+      rel="icon"
+      type="image/png"
+      sizes="16x16"
+      href="${request.static_url('c2cwsgiutils:static/favicon-16x16.png')}"
+      referrerpolicy="no-referrer"
+    />
+    <link
+        rel="stylesheet"
+        href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.3.2/css/bootstrap.min.css"
+        integrity="sha512-b2QcS5SsA8tZodcDtGRELiGv5SaKSk1vDHDaQRda0htPYWZ6046lr3kJ5bAAQdpV2mmA/4v0wQF9MyU6/pDIAg=="
+        crossorigin="anonymous"
+        referrerpolicy="no-referrer"
+    />
+    <title>c2cwsgiutils tools</title>
+    <style>
+      body {
+        margin-top: 0.5rem;
+      }
+      button, p  {
+        margin-bottom: 0.5rem;
+      }
+    </style>
+  </head>
+  <body>
+    <script>
+      (() => {
+        'use strict'
+        if (window.matchMedia('(prefers-color-scheme: dark)').matches) {
+          document.documentElement.setAttribute('data-bs-theme', 'dark');
+        }
+      })()
+    </script>
+    <div class="container-fluid">
+      ${ body | n }
+    </div>
+  </body>
+</html>

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=dict(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.dev197.dist-info/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015-2023, Camptocamp SA
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.