plainx-sentry 0.6.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

plainx/sentry/CHANGELOG.md

@@ -0,0 +1,11 @@
+# plainx-sentry changelog
+
+## [0.7.0](https://github.com/davegaeddert/plainx-sentry/releases/plainx-sentry@0.7.0) (2025-07-19)
+
+### What's changed
+
+- Middleware was removed in favor of using the OpenTelemetry integration and new otel instrumentation in Plain.
+
+### Upgrade instructions
+
+- Remove `SentryMiddleware` and `SentryWorkerMiddleware` from your `app/settings.py`.

plainx/sentry/__init__.py

@@ -1,3 +0,0 @@
-from .middleware import SentryMiddleware, SentryWorkerMiddleware
-
-__all__ = ["SentryMiddleware", "SentryWorkerMiddleware"]

plainx/sentry/config.py

@@ -1,6 +1,10 @@
 import sentry_sdk
+from opentelemetry import trace
+from opentelemetry.propagate import set_global_textmap
+from opentelemetry.sdk.trace import TracerProvider
 from plain.packages import PackageConfig, register_config
 from plain.runtime import settings
+from sentry_sdk.integrations.opentelemetry import SentryPropagator, SentrySpanProcessor
 
 
 @register_config
@@ -16,5 +20,19 @@ class PlainxSentryConfig(PackageConfig):
                 send_default_pii=settings.SENTRY_PII_ENABLED,
                 traces_sample_rate=settings.SENTRY_TRACES_SAMPLE_RATE,
                 profiles_sample_rate=settings.SENTRY_PROFILES_SAMPLE_RATE,
+                instrumenter="otel",
                 **settings.SENTRY_INIT_KWARGS,
             )
+
+            # Set up OpenTelemetry tracing with Sentry
+            if trace.get_tracer_provider() and not isinstance(
+                trace.get_tracer_provider(), trace.ProxyTracerProvider
+            ):
+                raise RuntimeError(
+                    "A tracer provider already exists. Sentry's OpenTelemetry integration requires a clean tracer provider."
+                )
+
+            provider = TracerProvider()
+            provider.add_span_processor(SentrySpanProcessor())
+            trace.set_tracer_provider(provider)
+            set_global_textmap(SentryPropagator())

plainx/sentry/templates.py

@@ -1,4 +1,5 @@
 import sentry_sdk
+from plain.auth import get_request_user
 from plain.runtime import settings
 from plain.templates import register_template_extension
 from plain.templates.jinja.extensions import InclusionTagExtension
@@ -25,8 +26,8 @@ class SentryJSExtension(InclusionTagExtension):
         }
 
         if "request" in context:
-            # Use request.user by default (avoids accidental "user" variable confusion)
-            user = getattr(context["request"], "user", None)
+            # Get the authenticated user from the request
+            user = get_request_user(context["request"])
         else:
             # Get user directly if no request (like in server error context)
             user = context.get("user", None)

{plainx_sentry-0.6.0.dist-info → plainx_sentry-0.8.0.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: plainx-sentry
-Version: 0.6.0
+Version: 0.8.0
 Author-email: Dave Gaeddert <dave.gaeddert@gmail.com>
 Requires-Python: >=3.11
-Requires-Dist: sentry-sdk>=2.24.0
+Requires-Dist: sentry-sdk[opentelemetry]>=2.24.0
 Description-Content-Type: text/markdown
 
 # plainx-sentry
@@ -20,12 +20,6 @@ INSTALLED_PACKAGES = [
   # ...
   "plainx.sentry",
 ]
-
-MIDDLEWARE = [
-  # Put SentryMiddleware as early as possible in the middleware stack
-  "plainx.sentry.SentryMiddleware",
-  # ...
-]
 ```
 
 In your `base.html`, load `sentry` and include the `sentry_js` tag:

plainx_sentry-0.8.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+plainx/sentry/CHANGELOG.md,sha256=kE1atfmZkThPdQ5fS7yylRMc_REJXel9zLjrDNgiGoc,373
+plainx/sentry/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plainx/sentry/config.py,sha256=mtA9uyFtXgGqaUI-wraG06klKA5fNzTKunS2DNm1KK8,1573
+plainx/sentry/default_settings.py,sha256=DNX6OQ0-BqfjyWuszW7JnZhiDn0tGtS3Fa2W7VbTIF8,564
+plainx/sentry/templates.py,sha256=5dR1CwYfftnkzBan46sNHaHGu-ydQzrAhV9n_L9bb5k,2053
+plainx/sentry/templates/sentry/js.html,sha256=aOjWAwuUaecGbC-5yZWP1aaGyYAcM-GK0dru-4VOYoE,491
+plainx_sentry-0.8.0.dist-info/METADATA,sha256=oCOW9dxdvS4ESNc9ME0rc2vVgr8243z5mnQKvvb-1qE,1442
+plainx_sentry-0.8.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plainx_sentry-0.8.0.dist-info/RECORD,,

plainx/sentry/middleware.py

@@ -1,156 +0,0 @@
-import sentry_sdk
-from plain.runtime import settings
-from sentry_sdk.tracing import TransactionSource
-from sentry_sdk.utils import capture_internal_exceptions
-
-try:
-    from plain.models.db import db_connection
-except ImportError:
-    db_connection = None
-
-import logging
-
-logger = logging.getLogger(__name__)
-
-
-def trace_db(execute, sql, params, many, context):
-    with sentry_sdk.start_span(op="db", description=sql) as span:
-        # Mostly borrowed from the Sentry Django integration...
-        data = {
-            "db.params": params,
-            "db.executemany": many,
-            "db.system": db_connection.vendor,
-            "db.name": db_connection.settings_dict.get("NAME"),
-            "db.user": db_connection.settings_dict.get("USER"),
-            "server.address": db_connection.settings_dict.get("HOST"),
-            "server.port": db_connection.settings_dict.get("PORT"),
-        }
-
-        sentry_sdk.add_breadcrumb(message=sql, category="query", data=data)
-
-        for k, v in data.items():
-            span.set_data(k, v)
-
-        result = execute(sql, params, many, context)
-
-    return result
-
-
-class SentryMiddleware:
-    def __init__(self, get_response):
-        self.get_response = get_response
-
-    def __call__(self, request):
-        # Don't do anything if Sentry is not active
-        if not sentry_sdk.get_client().is_active():
-            return self.get_response(request)
-
-        def event_processor(event, hint):
-            # request gets attached directly to an event,
-            # not necessarily in the "context"
-            request_info = event.setdefault("request", {})
-            request_info["url"] = request.build_absolute_uri()
-            request_info["method"] = request.method
-            request_info["query_string"] = request.meta.get("QUERY_STRING", "")
-            # Headers and env need some PII filtering, ideally,
-            # among other filters... similar for GET/POST data?
-            # request_info["headers"] = dict(request.headers)
-            try:
-                request_info["data"] = request.body.decode("utf-8")
-            except Exception:
-                pass
-
-            if user := getattr(request, "user", None):
-                event["user"] = {"id": str(user.pk)}
-                if settings.SENTRY_PII_ENABLED:
-                    if email := getattr(user, "email", None):
-                        event["user"]["email"] = email
-                    if username := getattr(user, "username", None):
-                        event["user"]["username"] = username
-
-            return event
-
-        with sentry_sdk.isolation_scope() as scope:
-            # Reset the scope (and breadcrumbs) for each request
-            scope.clear()
-            scope.add_event_processor(event_processor)
-
-            # Sentry's Django integration patches the WSGIHandler.
-            # We could make our own WSGIHandler and patch it or call it directly from gunicorn,
-            # but putting our middleware at the top of MIDDLEWARE is pretty close and easier.
-            with sentry_sdk.start_transaction(
-                op="http.server", name=request.path_info
-            ) as transaction:
-                if db_connection:
-                    # Also get spans for db queries
-                    with db_connection.execute_wrapper(trace_db):
-                        response = self.get_response(request)
-                else:
-                    # No db presumably
-                    response = self.get_response(request)
-
-                if resolver_match := getattr(request, "resolver_match", None):
-                    # Rename the transaction using a pattern,
-                    # and attach other url/views tags we can use to filter
-                    transaction.name = f"route:{resolver_match.route}"
-                    transaction.set_tag("url_namespace", resolver_match.namespace)
-                    transaction.set_tag("url_name", resolver_match.url_name)
-                    transaction.set_tag(
-                        "view_class", resolver_match.view.view_class.__qualname__
-                    )
-
-                    # Don't need to filter on this, but do want the context to view
-                    transaction.set_context(
-                        "url_params",
-                        {
-                            "args": resolver_match.args,
-                            "kwargs": resolver_match.kwargs,
-                        },
-                    )
-
-                transaction.set_http_status(response.status_code)
-
-            return response
-
-
-class SentryWorkerMiddleware:
-    def __init__(self, run_job):
-        self.run_job = run_job
-
-    def __call__(self, job):
-        # Don't do anything if Sentry is not active
-        if not sentry_sdk.get_client().is_active():
-            return self.run_job(job)
-
-        def event_processor(event, hint):
-            with capture_internal_exceptions():
-                # Attach it directly to any events
-                extra = event.setdefault("extra", {})
-                extra["plain.worker"] = {"job": job.as_json()}
-            return event
-
-        with sentry_sdk.isolation_scope() as scope:
-            # Reset the scope (and breadcrumbs) for each request
-            scope.clear()
-            scope.add_event_processor(event_processor)
-
-            with sentry_sdk.start_transaction(
-                op="plain.worker.job",
-                name=f"job:{job.job_class}",
-                source=TransactionSource.TASK,
-            ) as transaction:
-                if db_connection:
-                    # Also get spans for db queries
-                    with db_connection.execute_wrapper(trace_db):
-                        job_result = self.run_job(job)
-                else:
-                    # No db presumably
-                    job_result = self.run_job(job)
-
-                with capture_internal_exceptions():
-                    # Don't need to filter on this, but do want the context to view
-                    transaction.set_context("job", job.as_json())
-
-                transaction.set_status("ok")
-
-            return job_result

plainx_sentry-0.6.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-plainx/sentry/__init__.py,sha256=Klz3mH_itM2RXzJ_sWWJRIoZcS0jCRxWrhVVIPsG5FY,123
-plainx/sentry/config.py,sha256=EwMnY3DaanIGkgtKD_4h8ncx6MH_MxOML8BF5Hx5GBA,723
-plainx/sentry/default_settings.py,sha256=DNX6OQ0-BqfjyWuszW7JnZhiDn0tGtS3Fa2W7VbTIF8,564
-plainx/sentry/middleware.py,sha256=gGLxsRFHGJ5f6yLnpMnz8p7AnUnhg1I_vkd0bHtSKic,6098
-plainx/sentry/templates.py,sha256=ARLvITEyrOQjnuuRkdHvQT0bCar1ya2j-wueDjC4tu4,2048
-plainx/sentry/templates/sentry/js.html,sha256=aOjWAwuUaecGbC-5yZWP1aaGyYAcM-GK0dru-4VOYoE,491
-plainx_sentry-0.6.0.dist-info/METADATA,sha256=4_qF1CiLjhjFJ4WBjoLzq-aRHFo4_Qe6vlsR9SdTVwQ,1559
-plainx_sentry-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plainx_sentry-0.6.0.dist-info/RECORD,,