Skip to main content

Provenance

Struct Provenance 

Source
pub struct Provenance {
    pub stages: Vec<StageProvenance>,
    pub view_provenance: ViewProvenance,
    pub frame_receive_ts: MonotonicTs,
    pub pipeline_complete_ts: MonotonicTs,
    pub total_latency: Duration,
    pub frame_age: Option<Duration>,
    pub queue_hold_time: Duration,
    pub frame_included: bool,
}
Expand description

Full provenance for one processed frame.

Every output carries this, making production debugging tractable.

§Timing semantics

All timestamps are MonotonicTs values — they share the same monotonic clock domain as FrameEnvelope::ts().

  • frame_receive_ts — when the frame was dequeued from the bounded queue.
  • pipeline_complete_ts — when all stages finished and output was constructed.
  • Per-stage start_ts / end_ts — real wall-clock offsets converted to monotonic nanoseconds from the pipeline epoch for ordering consistency.

Fields§

§stages: Vec<StageProvenance>

Per-stage provenance records, in execution order.

§view_provenance: ViewProvenance

View-system provenance for this frame.

§frame_receive_ts: MonotonicTs

Timestamp when the frame was dequeued from the bounded queue (start of pipeline processing for this frame).

§pipeline_complete_ts: MonotonicTs

Timestamp when the pipeline completed processing this frame.

§total_latency: Duration

Total pipeline latency (receive → complete).

§frame_age: Option<Duration>

Wall-clock age of the frame at processing time.

Computed as WallTs::now() - frame.wall_ts() when the frame enters pipeline processing. A large value indicates the frame was stale before the executor even touched it — typically due to buffer-pool starvation, TCP backlog, or slow decode.

None if wall-clock age could not be determined (e.g., if the frame’s wall timestamp is in the future due to clock skew).

§queue_hold_time: Duration

Time the frame spent waiting in the bounded queue.

Measured from push() to pop() using Instant. A consistently low value combined with high frame_age proves that staleness originates upstream of the queue (e.g., in the decoder or TCP receive buffer), not from queue backlog.

§frame_included: bool

Whether this output includes the source frame.

Always true for FrameInclusion::Always, always false for FrameInclusion::Never, and periodic for FrameInclusion::Sampled.

Trait Implementations§

Source§

impl Clone for Provenance

Source§

fn clone(&self) -> Provenance

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Provenance

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more