Struct RuntimeObservationSession 

pub struct RuntimeObservationSession { /* private fields */ }

Owner-only capability for one query observation lifetime.

This type is intentionally not Clone. Cloneable execution contexts and workers receive only RuntimeObservationHandle, which cannot seal.

Implementations

impl RuntimeObservationSession

pub fn new( query_id: impl Into<QueryId>, trace_id: Option<TraceId>, config: RuntimeObservationConfig, ) -> Self

Creates an owner and recording handle using a system monotonic clock.

pub fn with_clock( query_id: impl Into<QueryId>, trace_id: Option<TraceId>, config: RuntimeObservationConfig, clock: Arc<dyn RuntimeObservationClock>, ) -> Self

Creates an owner and recording handle using an injected clock.

pub const fn disabled() -> Self

Creates a disabled owner and handle.

pub fn handle(&self) -> RuntimeObservationHandle

Returns a cloneable recording capability without seal authority.

pub const fn config(&self) -> RuntimeObservationConfig

Returns the immutable recorder configuration.

pub fn query_id(&self) -> Option<&QueryId>

Returns the immutable query identity when recording is enabled.

pub fn trace_id(&self) -> Option<&TraceId>

Returns the immutable optional parent trace identity.

pub fn record<F>(&self, build_payload: F) -> RuntimeObservationRecordDisposition

where F: FnOnce() -> RuntimeObservationPayload,

Lazily constructs and records a query-level event.

pub fn record_for_plan<F>( &self, plan_execution_id: PlanExecutionId, build_payload: F, ) -> RuntimeObservationRecordDisposition

where F: FnOnce() -> RuntimeObservationPayload,

Lazily constructs and records an event for one plan execution.

pub fn record_with_context<F>( &self, context: RuntimeEventContext, build_payload: F, ) -> RuntimeObservationRecordDisposition

where F: FnOnce() -> RuntimeObservationPayload,

Lazily constructs an event before acquiring recorder order and records it infallibly.

pub fn record_topology<F>( &self, class: RuntimeObservationRecordClass, build_record: F, ) -> RuntimeObservationRecordDisposition

where F: FnOnce() -> RuntimeTopologyRecord,

Lazily constructs and records one static topology row.

pub fn live_snapshot(&self) -> Option<LiveRuntimeObservationSnapshot>

Captures an immutable incomplete view. Returns none after sealing or when disabled.

pub fn seal( &self, outcome: RuntimeTerminalOutcome, ) -> Option<SealedRuntimeObservationSnapshot>

Fixes the first terminal outcome and returns the same immutable snapshot to every later or concurrent seal.

pub fn sealed_snapshot(&self) -> Option<SealedRuntimeObservationSnapshot>

Returns the sealed immutable snapshot when a terminal outcome was already fixed.

Trait Implementations

impl Debug for RuntimeObservationSession

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RuntimeObservationSession

fn default() -> Self

Returns the “default value” for a type.