plain 0.53.0__py3-none-any.whl → 0.54.0__py3-none-any.whl

plain/CHANGELOG.md

@@ -1,5 +1,16 @@
 # plain changelog
 
+## [0.54.0](https://github.com/dropseed/plain/releases/plain@0.54.0) (2025-07-18)
+
+### What's changed
+
+- Added OpenTelemetry instrumentation for HTTP requests, views, and template rendering ([b0224d0418](https://github.com/dropseed/plain/commit/b0224d0418))
+- Added `plain-observer` package reference to plain README ([f29ff4dafe](https://github.com/dropseed/plain/commit/f29ff4dafe))
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.53.0](https://github.com/dropseed/plain/releases/plain@0.53.0) (2025-07-18)
 
 ### What's changed

plain/README.md

@@ -48,6 +48,7 @@ The `plain` package includes everything you need to start handling web requests
 - [plain.support](/plain-support/plain/support/README.md) - Customer support forms.
 - [plain.redirection](/plain-redirection/plain/redirection/README.md) - Redirects managed in the database.
 - [plain.pageviews](/plain-pageviews/plain/pageviews/README.md) - Basic self-hosted page view tracking and reporting.
+- [plain.observer](/plain-observer/plain/observer/README.md) - On-page telemetry reporting.
 
 ## Dev Packages
 

plain/internal/handlers/base.py

@@ -1,6 +1,9 @@
 import logging
 import types
 
+from opentelemetry import baggage, trace
+from opentelemetry.semconv.attributes import http_attributes, url_attributes
+
 from plain.exceptions import ImproperlyConfigured
 from plain.logs import log_response
 from plain.runtime import settings
@@ -26,6 +29,9 @@ BUILTIN_AFTER_MIDDLEWARE = [
 ]
 
 
+tracer = trace.get_tracer("plain")
+
+
 class BaseHandler:
     _middleware_chain = None
 
@@ -35,8 +41,7 @@ class BaseHandler:
 
         Must be called after the environment is fixed (see __call__ in subclasses).
         """
-        get_response = self._get_response
-        handler = convert_exception_to_response(get_response)
+        handler = convert_exception_to_response(self._get_response)
 
         middlewares = reversed(
             BUILTIN_BEFORE_MIDDLEWARE + settings.MIDDLEWARE + BUILTIN_AFTER_MIDDLEWARE
@@ -59,18 +64,55 @@ class BaseHandler:
 
     def get_response(self, request):
         """Return a Response object for the given HttpRequest."""
-        # Setup default url resolver for this thread
-        response = self._middleware_chain(request)
-        response._resource_closers.append(request.close)
-        if response.status_code >= 400:
-            log_response(
-                "%s: %s",
-                response.reason_phrase,
-                request.path,
-                response=response,
-                request=request,
+
+        span_attributes = {
+            "plain.request.id": request.unique_id,
+            http_attributes.HTTP_REQUEST_METHOD: request.method,
+            url_attributes.URL_PATH: request.path_info,
+            url_attributes.URL_SCHEME: request.scheme,
+        }
+
+        # Add full URL if we can build it (requires proper WSGI environment)
+        try:
+            span_attributes[url_attributes.URL_FULL] = request.build_absolute_uri()
+        except KeyError:
+            # Missing required WSGI environment variables (e.g. in tests)
+            pass
+
+        # Add query string if present
+        if query_string := request.meta.get("QUERY_STRING"):
+            span_attributes[url_attributes.URL_QUERY] = query_string
+
+        span_context = baggage.set_baggage("http.request.cookies", request.cookies)
+
+        with tracer.start_as_current_span(
+            f"{request.method} {request.path_info}",
+            context=span_context,
+            attributes=span_attributes,
+            kind=trace.SpanKind.SERVER,
+        ) as span:
+            response = self._middleware_chain(request)
+            response._resource_closers.append(request.close)
+
+            span.set_attribute(
+                http_attributes.HTTP_RESPONSE_STATUS_CODE, response.status_code
+            )
+
+            span.set_status(
+                trace.StatusCode.OK
+                if response.status_code < 400
+                else trace.StatusCode.ERROR
             )
-        return response
+
+            if response.status_code >= 400:
+                log_response(
+                    "%s: %s",
+                    response.reason_phrase,
+                    request.path,
+                    response=response,
+                    request=request,
+                )
+            return response
 
     def _get_response(self, request):
         """
@@ -94,9 +136,18 @@ class BaseHandler:
         Retrieve/set the urlrouter for the request. Return the view resolved,
         with its args and kwargs.
         """
+
         resolver = get_resolver()
         # Resolve the view, and assign the match object back to the request.
         resolver_match = resolver.resolve(request.path_info)
+
+        span = trace.get_current_span()
+        span.set_attribute(http_attributes.HTTP_ROUTE, resolver_match.route)
+
+        # Route makes a better name
+        if resolver_match.route:
+            span.update_name(f"{request.method} {resolver_match.route}")
+
         request.resolver_match = resolver_match
         return resolver_match
 

plain/templates/core.py

@@ -1,7 +1,14 @@
 import jinja2
+from opentelemetry import trace
+from opentelemetry.semconv._incubating.attributes.code_attributes import (
+    CODE_FUNCTION_NAME,
+    CODE_NAMESPACE,
+)
 
 from .jinja import environment
 
+tracer = trace.get_tracer("plain")
+
 
 class TemplateFileMissing(Exception):
     def __str__(self) -> str:
@@ -21,4 +28,15 @@ class Template:
             raise TemplateFileMissing(filename)
 
     def render(self, context: dict) -> str:
-        return self._jinja_template.render(context)
+        with tracer.start_as_current_span(
+            f"render {self.filename}",
+            kind=trace.SpanKind.INTERNAL,
+            attributes={
+                CODE_FUNCTION_NAME: "render",
+                CODE_NAMESPACE: f"{self.__class__.__module__}.{self.__class__.__qualname__}",
+                "template.filename": self.filename,
+                "template.engine": "jinja2",
+            },
+        ):
+            result = self._jinja_template.render(context)
+            return result

plain/views/base.py

@@ -1,6 +1,12 @@
 import logging
 from http import HTTPMethod
 
+from opentelemetry import trace
+from opentelemetry.semconv._incubating.attributes.code_attributes import (
+    CODE_FUNCTION_NAME,
+    CODE_NAMESPACE,
+)
+
 from plain.http import (
     HttpRequest,
     JsonResponse,
@@ -16,6 +22,9 @@ from .exceptions import ResponseException
 logger = logging.getLogger("plain.request")
 
 
+tracer = trace.get_tracer("plain")
+
+
 class View:
     request: HttpRequest
     url_args: tuple
@@ -35,9 +44,23 @@ class View:
     @classonlymethod
     def as_view(cls, *init_args, **init_kwargs):
         def view(request, *url_args, **url_kwargs):
-            v = cls(*init_args, **init_kwargs)
-            v.setup(request, *url_args, **url_kwargs)
-            return v.get_response()
+            with tracer.start_as_current_span(
+                f"{cls.__name__}",
+                kind=trace.SpanKind.INTERNAL,
+                attributes={
+                    CODE_FUNCTION_NAME: "as_view",
+                    CODE_NAMESPACE: f"{cls.__module__}.{cls.__qualname__}",
+                },
+            ) as span:
+                v = cls(*init_args, **init_kwargs)
+                v.setup(request, *url_args, **url_kwargs)
+                response = v.get_response()
+                span.set_status(
+                    trace.StatusCode.OK
+                    if response.status_code < 400
+                    else trace.StatusCode.ERROR
+                )
+                return response
 
         view.view_class = cls
 

{plain-0.53.0.dist-info → plain-0.54.0.dist-info}/METADATA

@@ -1,12 +1,14 @@
 Metadata-Version: 2.4
 Name: plain
-Version: 0.53.0
+Version: 0.54.0
 Summary: A web framework for building products with Python.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE
 Requires-Python: >=3.11
 Requires-Dist: click>=8.0.0
 Requires-Dist: jinja2>=3.1.2
+Requires-Dist: opentelemetry-api>=1.34.1
+Requires-Dist: opentelemetry-semantic-conventions>=0.55b1
 Description-Content-Type: text/markdown
 
 # Plain
@@ -59,6 +61,7 @@ The `plain` package includes everything you need to start handling web requests
 - [plain.support](/plain-support/plain/support/README.md) - Customer support forms.
 - [plain.redirection](/plain-redirection/plain/redirection/README.md) - Redirects managed in the database.
 - [plain.pageviews](/plain-pageviews/plain/pageviews/README.md) - Basic self-hosted page view tracking and reporting.
+- [plain.observer](/plain-observer/plain/observer/README.md) - On-page telemetry reporting.
 
 ## Dev Packages
 

{plain-0.53.0.dist-info → plain-0.54.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-plain/CHANGELOG.md,sha256=DHF0llr5trZE_8C0138MnuFQEAM9W2jM9nL0xfjjz8Y,4472
-plain/README.md,sha256=gik6DBZcJAITcm4WRq_L53AxkjY45eQLafyTCSf0CKE,3986
+plain/CHANGELOG.md,sha256=x8vKNqfNIAeNvkBhz1648Y4zqH3MpfHACrkLW-8F9mk,4907
+plain/README.md,sha256=5BJyKhf0TDanWVbOQyZ3zsi5Lov9xk-LlJYCDWofM6Y,4078
 plain/__main__.py,sha256=GK39854Lc_LO_JP8DzY9Y2MIQ4cQEl7SXFJy244-lC8,110
 plain/debug.py,sha256=XdjnXcbPGsi0J2SpHGaLthhYU5AjhBlkHdemaP4sbYY,758
 plain/exceptions.py,sha256=Z9cbPE5im_Y-bjVq8cqC85gBoqOr80rLFG5wTKixrwE,5894
@@ -62,7 +62,7 @@ plain/internal/files/uploadedfile.py,sha256=JRB7T3quQjg-1y3l1ASPxywtSQZhaeMc45uF
 plain/internal/files/uploadhandler.py,sha256=63_QUwAwfq3bevw79i0S7zt2EB2UBoO7MaauvezaVMY,7198
 plain/internal/files/utils.py,sha256=xN4HTJXDRdcoNyrL1dFd528MBwodRlHZM8DGTD_oBIg,2646
 plain/internal/handlers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plain/internal/handlers/base.py,sha256=6K8wd5DojOYA-UEQTd1jxdDggm5ThHXQahVcuJqd2qo,4169
+plain/internal/handlers/base.py,sha256=odNSI5v5c8WsQjebPeKpKtmEreiFNQrwuG-_lM8mY3E,5882
 plain/internal/handlers/exception.py,sha256=vfha_6-fz6S6VYCP1PMBfue2Gw-_th6jqaTE372fGlw,4809
 plain/internal/handlers/wsgi.py,sha256=dgPT29t_F9llB-c5RYU3SHxGuZNaZ83xRjOfuOmtOl8,8209
 plain/internal/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -96,7 +96,7 @@ plain/signals/dispatch/dispatcher.py,sha256=VxSlqn9PCOTghPPJLOqZPs6FNQZfV2BJpMfF
 plain/signals/dispatch/license.txt,sha256=o9EhDhsC4Q5HbmD-IfNGVTEkXtNE33r5rIt3lleJ8gc,1727
 plain/templates/README.md,sha256=G43IdTRJX6mfxsExUTQf9QAwPeHLsDgY7PvKXdx4l6g,2432
 plain/templates/__init__.py,sha256=bX76FakE9T7mfK3N0deN85HlwHNQpeigytSC9Z8LcOs,451
-plain/templates/core.py,sha256=iw58EAmyyv8N5HDA-Sq4-fLgz_qx8v8WJfurgR116jw,625
+plain/templates/core.py,sha256=mbcH0yTeFOI3XOg9dYSroXRIcdv9sETEy4HzY-ugwco,1258
 plain/templates/jinja/__init__.py,sha256=xvYif0feMYR9pWjN0czthq2dk3qI4D5UQjgj9yp4dNA,2776
 plain/templates/jinja/environments.py,sha256=9plifzvQj--aTN1cCpJ2WdzQxZJpzB8S_4hghgQRQT0,2064
 plain/templates/jinja/extensions.py,sha256=AEmmmHDbdRW8fhjYDzq9eSSNbp9WHsXenD8tPthjc0s,1351
@@ -141,7 +141,7 @@ plain/utils/timezone.py,sha256=6u0sE-9RVp0_OCe0Y1KiYYQoq5THWLokZFQYY8jf78g,6221
 plain/utils/tree.py,sha256=wdWzmfsgc26YDF2wxhAY3yVxXTixQYqYDKE9mL3L3ZY,4383
 plain/views/README.md,sha256=_jR_8_eccE1Qwc9sbUhD_hpZGGf0r-HY4W-al6kqtGs,6762
 plain/views/__init__.py,sha256=a-N1nkklVohJTtz0yD1MMaS0g66HviEjsKydNVVjvVc,392
-plain/views/base.py,sha256=WVwJZ-N8zt0lMjVWffxglgORZBq6TeXiYmT3I8dP7fg,3430
+plain/views/base.py,sha256=CC9UvMZeAjVvi90vGjoZzsQ0jnhbg3-7qCKQ8-Pb6cg,4184
 plain/views/csrf.py,sha256=7q6l5xzLWhRnMY64aNj0hR6G-3pxI2yhRwG6k_5j00E,144
 plain/views/errors.py,sha256=jbNCJIzowwCsEvqyJ3opMeZpPDqTyhtrbqb0VnAm2HE,1263
 plain/views/exceptions.py,sha256=b4euI49ZUKS9O8AGAcFfiDpstzkRAuuj_uYQXzWNHME,138
@@ -149,8 +149,8 @@ plain/views/forms.py,sha256=ESZOXuo6IeYixp1RZvPb94KplkowRiwO2eGJCM6zJI0,2400
 plain/views/objects.py,sha256=GGbcfg_9fPZ-PiaBwIHG2e__8GfWDR7JQtQ15wTyiHg,5970
 plain/views/redirect.py,sha256=daq2cQIkdDF78bt43sjuZxRAyJm_t_SKw6tyPmiXPIc,1985
 plain/views/templates.py,sha256=ivkI7LU7BXDQ0d4Geab96Is4-Cp03KbIntXRT1J8e6I,2139
-plain-0.53.0.dist-info/METADATA,sha256=n3gNCFOwyioHwL_hKBiAmIGxSQG6CBM-XjM-x5EMq5I,4297
-plain-0.53.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain-0.53.0.dist-info/entry_points.txt,sha256=nn4uKTRRZuEKOJv3810s3jtSMW0Gew7XDYiKIvBRR6M,93
-plain-0.53.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
-plain-0.53.0.dist-info/RECORD,,
+plain-0.54.0.dist-info/METADATA,sha256=uCFa4LMC3-o4Vbr_ZKT-Kb3DGxAy9xW0UWzrEIk3CBU,4488
+plain-0.54.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain-0.54.0.dist-info/entry_points.txt,sha256=nn4uKTRRZuEKOJv3810s3jtSMW0Gew7XDYiKIvBRR6M,93
+plain-0.54.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
+plain-0.54.0.dist-info/RECORD,,