plain.observer 0.0.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

plain/observer/migrations/0002_trace_share_created_at_trace_share_id_trace_summary_and_more.py

@@ -0,0 +1,58 @@
+# Generated by Plain 0.54.1 on 2025-07-21 16:01
+
+from plain import models
+from plain.models import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("plainobserver", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="trace",
+            name="share_created_at",
+            field=models.DateTimeField(allow_null=True, required=False),
+        ),
+        migrations.AddField(
+            model_name="trace",
+            name="share_id",
+            field=models.CharField(default="", max_length=32, required=False),
+        ),
+        migrations.AddField(
+            model_name="trace",
+            name="summary",
+            field=models.CharField(default="", max_length=255, required=False),
+        ),
+        migrations.AddIndex(
+            model_name="trace",
+            index=models.Index(
+                fields=["trace_id"], name="plainobserv_trace_i_075b48_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="trace",
+            index=models.Index(
+                fields=["start_time"], name="plainobserv_start_t_636c80_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="trace",
+            index=models.Index(
+                fields=["request_id"], name="plainobserv_request_d1d5b2_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="trace",
+            index=models.Index(
+                fields=["share_id"], name="plainobserv_share_i_754f3c_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="trace",
+            index=models.Index(
+                fields=["session_id"], name="plainobserv_session_350f42_idx"
+            ),
+        ),
+    ]

plain/observer/models.py

@@ -1,4 +1,5 @@
 import json
+import secrets
 from datetime import UTC, datetime
 from functools import cached_property
 
@@ -15,6 +16,8 @@ from opentelemetry.semconv.attributes import db_attributes
 from opentelemetry.trace import format_trace_id
 
 from plain import models
+from plain.urls import reverse
+from plain.utils import timezone
 
 
 @models.register_model
@@ -24,12 +27,17 @@ class Trace(models.Model):
     end_time = models.DateTimeField()
 
     root_span_name = models.TextField(default="", required=False)
+    summary = models.CharField(max_length=255, default="", required=False)
 
     # Plain fields
     request_id = models.CharField(max_length=255, default="", required=False)
     session_id = models.CharField(max_length=255, default="", required=False)
     user_id = models.CharField(max_length=255, default="", required=False)
 
+    # Shareable URL fields
+    share_id = models.CharField(max_length=32, default="", required=False)
+    share_created_at = models.DateTimeField(allow_null=True, required=False)
+
     class Meta:
         ordering = ["-start_time"]
         constraints = [
@@ -38,25 +46,43 @@ class Trace(models.Model):
                 name="observer_unique_trace_id",
             )
         ]
+        indexes = [
+            models.Index(fields=["trace_id"]),
+            models.Index(fields=["start_time"]),
+            models.Index(fields=["request_id"]),
+            models.Index(fields=["share_id"]),
+            models.Index(fields=["session_id"]),
+        ]
 
     def __str__(self):
         return self.trace_id
 
+    def get_absolute_url(self):
+        """Return the canonical URL for this trace."""
+        return reverse("observer:trace_detail", trace_id=self.trace_id)
+
+    def generate_share_id(self):
+        """Generate a unique share ID for this trace."""
+        self.share_id = secrets.token_urlsafe(24)
+        self.share_created_at = timezone.now()
+        self.save(update_fields=["share_id", "share_created_at"])
+        return self.share_id
+
+    def remove_share_id(self):
+        """Remove the share ID from this trace."""
+        self.share_id = ""
+        self.share_created_at = None
+        self.save(update_fields=["share_id", "share_created_at"])
+
     def duration_ms(self):
         return (self.end_time - self.start_time).total_seconds() * 1000
 
-    def get_trace_summary(self, spans=None):
+    def get_trace_summary(self, spans):
         """Get a concise summary string for toolbar display.
 
         Args:
             spans: Optional list of span objects. If not provided, will query from database.
         """
-        # Get spans from database if not provided
-        if spans is None:
-            spans = list(self.spans.all())
-
-        if not spans:
-            return ""
 
         # Count database queries and track duplicates
         query_counts = {}
@@ -132,9 +158,6 @@ class Trace(models.Model):
             else None
         )
 
-        # Create trace instance
-        # Note: end_time might be None if there are active spans
-        # This is OK since this trace is only used for summaries, not persistence
         return cls(
             trace_id=trace_id,
             start_time=start_time,
@@ -146,9 +169,27 @@ class Trace(models.Model):
             root_span_name=root_span.name if root_span else "",
         )
 
-    def get_annotated_spans(self):
-        """Return spans with annotations and nesting information."""
-        spans = list(self.spans.all().order_by("start_time"))
+    def as_dict(self):
+        spans = [span.span_data for span in self.spans.all().order_by("start_time")]
+
+        return {
+            "trace_id": self.trace_id,
+            "start_time": self.start_time.isoformat(),
+            "end_time": self.end_time.isoformat(),
+            "duration_ms": self.duration_ms(),
+            "summary": self.summary,
+            "root_span_name": self.root_span_name,
+            "request_id": self.request_id,
+            "user_id": self.user_id,
+            "session_id": self.session_id,
+            "spans": spans,
+        }
+
+
+class SpanQuerySet(models.QuerySet):
+    def annotate_spans(self):
+        """Annotate spans with nesting levels and duplicate query warnings."""
+        spans = list(self.order_by("start_time"))
 
         # Build span dictionary for parent lookups
         span_dict = {span.span_id: span for span in spans}
@@ -191,20 +232,6 @@ class Trace(models.Model):
 
         return spans
 
-    def as_dict(self):
-        spans = [span.span_data for span in self.spans.all().order_by("start_time")]
-
-        return {
-            "trace_id": self.trace_id,
-            "start_time": self.start_time.isoformat(),
-            "end_time": self.end_time.isoformat(),
-            "duration_ms": self.duration_ms(),
-            "request_id": self.request_id,
-            "user_id": self.user_id,
-            "session_id": self.session_id,
-            "spans": spans,
-        }
-
 
 @models.register_model
 class Span(models.Model):
@@ -220,6 +247,8 @@ class Span(models.Model):
     status = models.CharField(max_length=50, default="", required=False)
     span_data = models.JSONField(default=dict, required=False)
 
+    objects = SpanQuerySet.as_manager()
+
     class Meta:
         ordering = ["-start_time"]
         constraints = [

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,10 +41,13 @@ 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)}"
+
+    # Technically we're still in the trace... so the duration and stuff could shift slightly
+    # (though we should be at the end of the template, hopefully)
     return processor.get_trace_summary(trace_id)
 
 
@@ -126,6 +129,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 +195,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."""
@@ -219,6 +269,10 @@ class ObserverSpanProcessor(SpanProcessor):
                         len(trace_info["span_models"]),
                         trace_id,
                     )
+                    # The trace is done now, so we can get a more accurate summary
+                    trace_info["trace"].summary = trace_info["trace"].get_trace_summary(
+                        trace_info["span_models"]
+                    )
                     self._export_trace(trace_info["trace"], trace_info["span_models"])
 
                 # Clean up trace
@@ -295,6 +349,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: