Skip to main content

RunSummary

Struct RunSummary 

Source
pub struct RunSummary {
Show 28 fields pub run_id: String, pub export_name: String, pub status: String, pub total_rows: i64, pub files_produced: usize, pub bytes_written: u64, pub files_committed: usize, pub duration_ms: i64, pub peak_rss_mb: i64, pub retries: u32, pub validated: Option<bool>, pub schema_changed: Option<bool>, pub quality_passed: Option<bool>, pub error_message: Option<String>, pub tuning_profile: String, pub batch_size: usize, pub batch_size_memory_mb: Option<usize>, pub format: String, pub mode: String, pub compression: String, pub pg_temp_bytes_delta: Option<i64>, pub source_count: Option<i64>, pub reconciled: Option<bool>, pub manifest_parts: Vec<ManifestPart>, pub schema_fingerprint: Option<String>, pub manifest_verification: Option<ManifestVerification>, pub apply_context: Option<ApplyContext>, pub journal: RunJournal,
}
Expand description

Accumulates operational data during a pipeline run for summary and metrics.

The embedded journal is the structured event log for this run. Use summary.journal.record(event) at any call site that already holds &mut RunSummary.

Fields§

§run_id: String§export_name: String§status: String§total_rows: i64§files_produced: usize§bytes_written: u64§files_committed: usize

Incremented after each successful dest.write(). Non-zero means a previous attempt already committed data — retrying from the same cursor would duplicate rows.

§duration_ms: i64§peak_rss_mb: i64§retries: u32§validated: Option<bool>§schema_changed: Option<bool>§quality_passed: Option<bool>§error_message: Option<String>§tuning_profile: String

profile from YAML, or balanced (default) if omitted.

§batch_size: usize

Configured batch_size from YAML/profile (FETCH cap before batch_size_memory_mb override).

§batch_size_memory_mb: Option<usize>

When set, actual FETCH size is derived from schema (see logs).

§format: String§mode: String§compression: String§pg_temp_bytes_delta: Option<i64>

Postgres pg_stat_database.temp_bytes delta around the run. None for non-Postgres sources or when the snapshot probe failed (no admin perms not required — the view is readable by any role). When set and large, indicates cursor / sort spill to pgsql_tmp/ — the safe action is to shrink tuning.batch_size or set tuning.batch_size_memory_mb below PG’s work_mem.

§source_count: Option<i64>

Source COUNT(*) result for reconciliation (None = not requested or not applicable).

§reconciled: Option<bool>

Whether reconciliation passed (Some(true) = match, Some(false) = mismatch, None = skipped).

§manifest_parts: Vec<ManifestPart>

Committed parts accumulated during the run, in commit order. Populated by pipeline::manifest_writer::record_committed_part at each dest.write site (ADR-0012 M1 — Parts Before Manifest). Drained at finalize into a RunManifest by [crate::pipeline::manifest_writer::write_manifest].

§schema_fingerprint: Option<String>

xxh3 fingerprint of the dest-facing column schema for this run, in the canonical xxh3:<16-hex> form produced by crate::state::schema_fingerprint.

Recorded by [crate::pipeline::manifest_writer::record_run_schema_fingerprint] the first time the sink has resolved a schema (i.e. on the first batch of any chunk). Idempotent within a run — the schema is identical across chunks, so later writes are no-ops.

finalize_manifest reads this directly so the manifest’s schema_fingerprint no longer depends on the per-export schema row happening to land in state before the manifest write. The state lookup remains a fallback for resume scenarios where the summary was reconstructed without ever seeing a live schema.

§manifest_verification: Option<ManifestVerification>

Result of the manifest-aware --validate pass (ADR-0012 M5/M6, ADR-0013). Populated by pipeline::job::finalize_validate_manifest after finalize_manifest succeeds; None when the run targeted a streaming destination, when --validate was not requested, or when the run failed before any manifest could be written.

§apply_context: Option<ApplyContext>

Apply-time context (plan_id, –force usage, bypassed checks). None when the run came from rivet run rather than rivet apply. See [ApplyContext] and finding F5 of the 0.7.5 audit.

§journal: RunJournal

Structured event log for this run. Answers the four DoD observability questions.

Trait Implementations§

Source§

impl Clone for RunSummary

Source§

fn clone(&self) -> RunSummary

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RunSummary

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> MaybeSend for T
where T: Send,