plain.observer 0.0.0__tar.gz → 0.1.0__tar.gz

{plain_observer-0.0.0 → plain_observer-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.observer
-Version: 0.0.0
+Version: 0.1.0
 Summary: On-page telemetry and observability tools for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause

plain_observer-0.1.0/plain/observer/CHANGELOG.md

@@ -0,0 +1,15 @@
+# plain-observer changelog
+
+## [0.1.0](https://github.com/dropseed/plain/releases/plain-observer@0.1.0) (2025-07-19)
+
+### What's changed
+
+- Initial release of plain-observer package providing OpenTelemetry-based observability and monitoring for Plain applications ([b0224d0](https://github.com/dropseed/plain/commit/b0224d0418))
+- Added real-time trace monitoring with summary and persist modes via signed cookies ([b0224d0](https://github.com/dropseed/plain/commit/b0224d0418))
+- Added admin interface for viewing detailed trace information and spans ([b0224d0](https://github.com/dropseed/plain/commit/b0224d0418))
+- Added toolbar integration showing performance summaries for current requests ([b0224d0](https://github.com/dropseed/plain/commit/b0224d0418))
+- Observer can now combine with existing OpenTelemetry trace providers instead of replacing them ([7e55779](https://github.com/dropseed/plain/commit/7e55779548))
+
+### Upgrade instructions
+
+- No changes required

plain_observer-0.1.0/plain/observer/config.py

@@ -0,0 +1,44 @@
+from opentelemetry import trace
+from opentelemetry.sdk.trace import TracerProvider
+
+from plain.packages import PackageConfig, register_config
+
+from .otel import (
+    ObserverCombinedSampler,
+    ObserverSampler,
+    ObserverSpanProcessor,
+    get_observer_span_processor,
+)
+
+
+@register_config
+class Config(PackageConfig):
+    package_label = "plainobserver"
+
+    def ready(self):
+        sampler = ObserverSampler()
+        span_processor = ObserverSpanProcessor()
+
+        if provider := self.get_existing_trace_provider():
+            # There is already a trace provider, so combine our sampler
+            # and add an additional span processor for Observer
+            if hasattr(provider, "sampler"):
+                provider.sampler = ObserverCombinedSampler(provider.sampler, sampler)
+
+            if not get_observer_span_processor():
+                provider.add_span_processor(span_processor)
+        else:
+            # Start our own provider, new sampler, and span processor
+            provider = TracerProvider(sampler=sampler)
+            provider.add_span_processor(span_processor)
+            trace.set_tracer_provider(provider)
+
+    @staticmethod
+    def get_existing_trace_provider():
+        """Return the currently configured provider if set."""
+        current_provider = trace.get_tracer_provider()
+        if current_provider and not isinstance(
+            current_provider, trace.ProxyTracerProvider
+        ):
+            return current_provider
+        return None

{plain_observer-0.0.0 → plain_observer-0.1.0}/plain/observer/otel.py

@@ -18,7 +18,7 @@ from .core import Observer, ObserverMode
 logger = logging.getLogger(__name__)
 
 
-def get_span_processor():
+def get_observer_span_processor():
     """Get the span collector instance from the tracer provider."""
     if not (current_provider := trace.get_tracer_provider()):
         return None
@@ -41,7 +41,7 @@ def get_current_trace_summary() -> str | None:
     if not (current_span := trace.get_current_span()):
         return None
 
-    if not (processor := get_span_processor()):
+    if not (processor := get_observer_span_processor()):
         return None
 
     trace_id = f"0x{format_trace_id(current_span.get_span_context().trace_id)}"
@@ -126,6 +126,50 @@ class ObserverSampler(sampling.Sampler):
         return "ObserverSampler"
 
 
+class ObserverCombinedSampler(sampling.Sampler):
+    """Combine another sampler with ``ObserverSampler``."""
+
+    def __init__(self, primary: sampling.Sampler, secondary: sampling.Sampler):
+        self.primary = primary
+        self.secondary = secondary
+
+    def should_sample(
+        self,
+        parent_context,
+        trace_id,
+        name,
+        kind: SpanKind | None = None,
+        attributes=None,
+        links=None,
+        trace_state=None,
+    ):
+        result = self.primary.should_sample(
+            parent_context,
+            trace_id,
+            name,
+            kind=kind,
+            attributes=attributes,
+            links=links,
+            trace_state=trace_state,
+        )
+
+        if result.decision is sampling.Decision.DROP:
+            return self.secondary.should_sample(
+                parent_context,
+                trace_id,
+                name,
+                kind=kind,
+                attributes=attributes,
+                links=links,
+                trace_state=trace_state,
+            )
+
+        return result
+
+    def get_description(self) -> str:
+        return f"ObserverCombinedSampler({self.primary.get_description()}, {self.secondary.get_description()})"
+
+
 class ObserverSpanProcessor(SpanProcessor):
     """Collects spans in real-time for current trace performance monitoring.
 
@@ -148,6 +192,9 @@ class ObserverSpanProcessor(SpanProcessor):
             }
         )
         self._traces_lock = threading.Lock()
+        self._ignore_url_paths = [
+            re.compile(p) for p in settings.OBSERVER_IGNORE_URL_PATTERNS
+        ]
 
     def on_start(self, span, parent_context=None):
         """Called when a span starts."""
@@ -295,6 +342,13 @@ class ObserverSpanProcessor(SpanProcessor):
                     )
 
     def _get_recording_mode(self, span, parent_context) -> str | None:
+        # Again check the span attributes, in case we relied on another sampler
+        if span.attributes:
+            if url_path := span.attributes.get(url_attributes.URL_PATH, ""):
+                for pattern in self._ignore_url_paths:
+                    if pattern.match(url_path):
+                        return None
+
         # If the span has links, then we are going to export if the linked span is also exported
         for link in span.links:
             if link.context.is_valid and link.context.span_id:

{plain_observer-0.0.0 → plain_observer-0.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.observer"
-version = "0.0.0"
+version = "0.1.0"
 description = "On-page telemetry and observability tools for Plain."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"

plain_observer-0.0.0/plain/observer/CHANGELOG.md

@@ -1 +0,0 @@
-# plain-observer changelog

plain_observer-0.0.0/plain/observer/config.py

@@ -1,36 +0,0 @@
-from opentelemetry import trace
-from opentelemetry.sdk.trace import TracerProvider
-
-from plain.packages import PackageConfig, register_config
-
-from .otel import ObserverSampler, ObserverSpanProcessor
-
-
-@register_config
-class Config(PackageConfig):
-    package_label = "plainobserver"
-
-    def ready(self):
-        if self.has_existing_trace_provider():
-            return
-
-        self.setup_observer()
-
-    @staticmethod
-    def has_existing_trace_provider() -> bool:
-        """Check if there is an existing trace provider."""
-        current_provider = trace.get_tracer_provider()
-        return current_provider and not isinstance(
-            current_provider, trace.ProxyTracerProvider
-        )
-
-    @staticmethod
-    def setup_observer() -> None:
-        sampler = ObserverSampler()
-        provider = TracerProvider(sampler=sampler)
-
-        # Add our combined processor that handles both memory storage and export
-        observer_processor = ObserverSpanProcessor()
-        provider.add_span_processor(observer_processor)
-
-        trace.set_tracer_provider(provider)