wrapture-instrumentation 1.0.0.dev2__tar.gz → 1.0.0.dev4__tar.gz

{wrapture_instrumentation-1.0.0.dev2 → wrapture_instrumentation-1.0.0.dev4}/CHANGES.md

@@ -15,7 +15,9 @@ In development.
 
 - Flask (`flask`, Flask 3.x): every request records as one tree
   through the recording WSGI middleware installed at construction,
-  annotated with the matched route pattern and endpoint; every view
+  annotated with the matched route pattern and endpoint (the route
+  is what wrapture's OpenTelemetry export names the span by, as
+  `http.route`); every view
   function is observed as it registers and labelled by its endpoint
   (blueprints and `MethodView`s included); lifecycle callbacks and
   error handlers are observed however they register; and failures
@@ -29,6 +31,7 @@ In development.
   settings switch the optional layers, all on by default:
   `lifecycle`, `handled_errors` and `templates`; two more shape what
   a recorded request carries: `ignore_paths` (path globs whose
-  requests record nothing, request and view alike) and `redact`
+  requests record nothing at all, request and everything beneath it
+  alike) and `redact`
   (query parameters masked by name on top of the built-in sensitive
   set).

{wrapture_instrumentation-1.0.0.dev2/src/wrapture_instrumentation.egg-info → wrapture_instrumentation-1.0.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wrapture-instrumentation
-Version: 1.0.0.dev2
+Version: 1.0.0.dev4
 Summary: Instrumentation for common Python packages, applied through wrapture.
 Author-email: Graham Dumpleton <Graham.Dumpleton@gmail.com>
 License-Expression: BSD-2-Clause
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: wrapture>=1.0.0a5
+Requires-Dist: wrapture>=1.0.0a12
 Dynamic: license-file
 
 # wrapture-instrumentation

{wrapture_instrumentation-1.0.0.dev2 → wrapture_instrumentation-1.0.0.dev4}/pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
 # install Flask, and whether a target is present and at a supported
 # version is checked by wrapture at apply time from the class data.
 dependencies = [
-    "wrapture>=1.0.0a5",
+    "wrapture>=1.0.0a12",
 ]
 
 [project.urls]

{wrapture_instrumentation-1.0.0.dev2 → wrapture_instrumentation-1.0.0.dev4}/src/wrapture_instrumentation/__init__.py

@@ -22,5 +22,5 @@ def _format_version(parts: tuple[str, ...]) -> str:
     )
 
 
-__version_info__ = ("1", "0", "0", "dev2")
+__version_info__ = ("1", "0", "0", "dev4")
 __version__ = _format_version(__version_info__)

{wrapture_instrumentation-1.0.0.dev2 → wrapture_instrumentation-1.0.0.dev4}/src/wrapture_instrumentation/framework_flask/README.md

@@ -71,7 +71,10 @@ GET /shaky (portal.wsgi_app)  -> '422 UNPROCESSABLE ENTITY'  !! ValueError  [671
   matched route pattern (`route = "/quote/<item>"`) and endpoint
   (`endpoint = "quoted"`), the low-cardinality keys to group by; the
   raw path stays as the per-request detail. A request that matched no
-  route (a 404) has neither key.
+  route (a 404) has neither key. wrapture's OpenTelemetry export
+  reads `route` as the semantic-convention `http.route` and names the
+  request span by it (`GET /quote/<item>`), so a backend groups by
+  endpoint rather than by URL.
 
 - Every view function is observed as its route registers, wherever it
   came from: plain functions, `view_func` by keyword or position,
@@ -138,7 +141,7 @@ a layer:
 
 | Setting | Default | Controls |
 | ------- | ------- | -------- |
-| `ignore_paths` | `[]` | Request paths not to record, as path globs (`"/health"`, `"/static/*"`). A matching request runs and answers as normal but records nothing: the middleware skips the request event, and the same predicate rides on the observed views, so no stray view roots appear. Lifecycle callbacks observed under the `lifecycle` switch still record on ignored paths. |
+| `ignore_paths` | `[]` | Request paths not to record, as path globs (`"/health"`, `"/static/*"`). A matching request runs and answers as normal but records nothing at all: the request event is skipped and everything beneath it is silenced for the request's whole extent, its view, lifecycle callbacks, error handlers and template renders included, so no stray roots appear. It is wrapture's `filter_requests(ignore={"path": [...]})` with `tree=True` on the middleware. |
 | `redact` | `[]` | Query string parameters to mask by name in the recorded query, on top of the built-in sensitive set (passwords, tokens, keys and session ids are always masked). The parameter still reaches the application; only the recording is masked. |
 | `lifecycle` | `true` | Observing before/after/teardown callbacks as they register. Every registered callback runs on every request (extensions register these liberally: user loaders, session cleanup, header stamping), so this is the layer to switch off when the trees are noisier than they are informative. The callbacks still run; they run unobserved. |
 | `handled_errors` | `true` | Noting an exception a registered handler absorbed against its request. The handler's own run is core and stays observed either way. |
@@ -163,8 +166,8 @@ lifecycle = false
 - Flask signals: blinker plumbing; bind the receivers ad hoc with
   wrapture if you need them.
 - `jsonify`, `send_file`, `send_static_file`: response plumbing;
-  static file traffic is better excluded wholesale once
-  `ignore_paths` lands.
+  static file traffic is better excluded wholesale with
+  `ignore_paths`.
 
 ## How it patches
 

{wrapture_instrumentation-1.0.0.dev2 → wrapture_instrumentation-1.0.0.dev4}/src/wrapture_instrumentation/framework_flask/app.py

@@ -8,7 +8,10 @@ their own calls.
   instance's wsgi_app attribute, the documented place Flask middleware
   goes, so every request records as one "request" event however the
   instance was made: module level, an application factory, several
-  applications in one process.
+  applications in one process. The ignore_paths setting rides on the
+  middleware as a filter_requests() filter with tree=True, so an
+  ignored request records nothing at all, its view, callbacks and
+  template renders included.
 
 - Flask.add_url_rule substitutes wrapture.observed(view_func) as
   routes register, labelled with the route's endpoint, so every view
@@ -64,7 +67,6 @@ manager, take the whole thing down again.
 
 from __future__ import annotations
 
-import fnmatch
 from collections.abc import Callable, Sequence
 from typing import Any
 
@@ -73,42 +75,24 @@ import wrapture
 from .common import observing_registration
 
 
-def _declines(ignore_paths: Sequence[str]) -> Callable[..., bool] | None:
-    """The when= predicate for the ignore_paths setting, or None when
-    the setting is empty: record unless the request path matches one
-    of the globs. Shared by the middleware and the observed views, so
-    an ignored request records neither its request event nor its
-    view."""
-
-    if not ignore_paths:
-        return None
-
-    patterns = tuple(ignore_paths)
-
-    def wanted(instance: Any, args: tuple[Any, ...], kwargs: Any) -> bool:
-        # The view form of the predicate: read the path from the
-        # request context (the middleware form gets the environ
-        # directly and never reaches here). A call outside a request
-        # context is not an ignorable request; record it.
-
-        from flask import has_request_context, request
-
-        if not has_request_context():
-            return True
-
-        return not any(
-            fnmatch.fnmatchcase(request.path, pattern) for pattern in patterns
-        )
-
-    return wanted
-
-
 def wrap_app(ignore_paths: Sequence[str], redact: Sequence[str]) -> Callable[..., Any]:
     """Build the Flask.__init__ decorator that installs the recording
     middleware on each new instance's wsgi_app, carrying the
-    ignore_paths and redact settings into it."""
+    ignore_paths and redact settings into it.
+
+    ignore_paths becomes a filter_requests() filter on the middleware's
+    when=, with tree=True so that a declined request silences
+    everything beneath it for its whole extent; without the flag the
+    request's view, callbacks and renders would still record, each as
+    a parentless root. tree= is only valid alongside a when=, so both
+    are left unset when there is nothing to ignore.
+    """
 
-    when = list(ignore_paths) or None
+    request_filter = (
+        wrapture.filter_requests(ignore={"path": list(ignore_paths)})
+        if ignore_paths
+        else None
+    )
     policy = wrapture.redact(*redact) if redact else None
 
     def install(
@@ -122,7 +106,8 @@ def wrap_app(ignore_paths: Sequence[str], redact: Sequence[str]) -> Callable[...
         instance.wsgi_app = wrapture.WSGIMiddleware(
             instance.wsgi_app,
             label=f"{instance.name}.wsgi_app",
-            when=when,
+            when=request_filter,
+            tree=request_filter is not None,
             capture_args=policy,
         )
 
@@ -147,34 +132,28 @@ def _endpoint(args: tuple[Any, ...], kwargs: dict[str, Any], view: Any) -> str:
     return str(endpoint) if endpoint is not None else view.__name__
 
 
-def wrap_view(ignore_paths: Sequence[str]) -> Callable[..., Any]:
+def wrap_view() -> Callable[..., Any]:
     """Build the add_url_rule transformer that substitutes an observed
     view function, labelled by its endpoint, into each registration.
 
     The signature is add_url_rule(rule, endpoint=None, view_func=None,
     ...), so the view is either the view_func keyword or the third
     positional argument; a registration without a view (an endpoint
-    name alone) passes through untouched. The ignore_paths predicate
-    rides on each observed view, so an ignored request's view goes
-    unrecorded along with its request event.
+    name alone) passes through untouched. The view needs no predicate
+    of its own: an ignored request is silenced beneath the middleware,
+    view included.
     """
 
-    when = _declines(ignore_paths)
-
     def transform(
         args: tuple[Any, ...], kwargs: dict[str, Any]
     ) -> tuple[tuple[Any, ...], dict[str, Any]]:
         if kwargs.get("view_func") is not None:
             view = kwargs["view_func"]
-            observed = wrapture.observed(
-                view, label=_endpoint(args, kwargs, view), when=when
-            )
+            observed = wrapture.observed(view, label=_endpoint(args, kwargs, view))
             kwargs = dict(kwargs, view_func=observed)
         elif len(args) >= 3 and args[2] is not None:
             view = args[2]
-            observed = wrapture.observed(
-                view, label=_endpoint(args, kwargs, view), when=when
-            )
+            observed = wrapture.observed(view, label=_endpoint(args, kwargs, view))
             args = (*args[:2], observed, *args[3:])
 
         return args, kwargs
@@ -261,7 +240,7 @@ def instrument(module: Any, instrumentation: wrapture.Instrumentation) -> None:
     )
 
     registrar = wrapture.binding(module.Flask, "add_url_rule", when=False)
-    registrar.on_call.transforms_args(wrap_view(settings["ignore_paths"]))
+    registrar.on_call.transforms_args(wrap_view())
 
     router = wrapture.binding(module.Flask, "preprocess_request", when=False)
     router.on_call.decorates(annotate_route)

{wrapture_instrumentation-1.0.0.dev2 → wrapture_instrumentation-1.0.0.dev4/src/wrapture_instrumentation.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wrapture-instrumentation
-Version: 1.0.0.dev2
+Version: 1.0.0.dev4
 Summary: Instrumentation for common Python packages, applied through wrapture.
 Author-email: Graham Dumpleton <Graham.Dumpleton@gmail.com>
 License-Expression: BSD-2-Clause
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: wrapture>=1.0.0a5
+Requires-Dist: wrapture>=1.0.0a12
 Dynamic: license-file
 
 # wrapture-instrumentation

wrapture_instrumentation-1.0.0.dev4/src/wrapture_instrumentation.egg-info/requires.txt

@@ -0,0 +1 @@
+wrapture>=1.0.0a12

{wrapture_instrumentation-1.0.0.dev2 → wrapture_instrumentation-1.0.0.dev4}/tests/framework_flask/test_request_options.py

@@ -12,7 +12,8 @@ from wrapture_instrumentation.framework_flask import FlaskInstrumentation
 
 
 def make_probe() -> flask.Flask:
-    """An application with a health endpoint beside a working route."""
+    """An application with a health endpoint beside a working route,
+    and a lifecycle callback that runs on every request."""
 
     app = flask.Flask("probe")
 
@@ -22,6 +23,10 @@ def make_probe() -> flask.Flask:
     def work() -> str:
         return "done"
 
+    def stamp() -> None:
+        return None
+
+    app.before_request(stamp)
     app.add_url_rule("/health", "health", health)
     app.add_url_rule("/static/<name>", "asset", lambda name: name)
     app.add_url_rule("/work", "work", work)
@@ -30,10 +35,10 @@ def make_probe() -> flask.Flask:
 
 
 def test_ignored_paths_record_nothing_and_still_answer() -> None:
-    # An ignored request leaves no events at all: the middleware skips
-    # the request event and the same predicate rides on the observed
-    # view, so neither shows up as a stray root. The application still
-    # runs and answers.
+    # An ignored request leaves no events at all: the middleware's
+    # filter declines the request with tree=True, so the view and the
+    # lifecycle callback beneath it are silenced rather than left as
+    # stray roots. The application still runs and answers.
 
     with (
         instrumentation(FlaskInstrumentation, ignore_paths=["/health", "/static/*"]),
@@ -53,6 +58,7 @@ def test_ignored_paths_record_nothing_and_still_answer() -> None:
 
     assert [(event.kind, event.label or event.path) for event in tape.all] == [
         ("request", "probe.wsgi_app"),
+        ("call", f"{__name__}:make_probe.<locals>.stamp"),
         ("call", "work"),
     ]
 
@@ -67,7 +73,7 @@ def test_redact_masks_named_query_parameters() -> None:
     ):
         request(make_probe(), "GET", "/work", query="voucher=SECRET50&limit=5&token=t")
 
-    (seen, _) = tape.all
+    seen = tape.all[0]
     assert seen.data["query"] == "voucher=<redacted>&limit=5&token=<redacted>"
     assert "SECRET50" not in repr(seen.data)
 
@@ -101,6 +107,6 @@ def test_defaults_ignore_nothing_and_redact_only_the_built_ins() -> None:
     with instrumentation(FlaskInstrumentation), timeline() as tape:
         request(make_probe(), "GET", "/health", query="voucher=v&api_key=k")
 
-    (seen, _) = tape.all
+    seen = tape.all[0]
     assert seen.data["path"] == "/health"
     assert seen.data["query"] == "voucher=v&api_key=<redacted>"

wrapture_instrumentation-1.0.0.dev2/src/wrapture_instrumentation.egg-info/requires.txt

@@ -1 +0,0 @@
-wrapture>=1.0.0a5