Skip to main content

SpoolStats

Struct SpoolStats 

Source
pub struct SpoolStats {
    pub unspooled_entries: u32,
    pub unspooled_samples: u32,
    pub watermark: LogPosition,
    pub head: LogPosition,
    pub dropped_unspooled: u32,
    pub data_lost: bool,
}
Expand description

Replication accounting for a log.

Returned by SensorDb::spool_stats. Kept separate from DbStats, which describes the sector index and means the same thing whether or not anything is replicating this log.

Fields§

§unspooled_entries: u32

Durable entries not yet known to be replicated elsewhere.

Entries, which is the unit a spool pass moves and its budget is denominated in. For “how many readings are still only here”, see unspooled_samples.

§unspooled_samples: u32

Durable samples not yet known to be replicated elsewhere.

Larger than unspooled_entries when the un-replicated tail holds runs.

§watermark: LogPosition

Everything strictly before this position is durably replicated.

§head: LogPosition

Position after the newest entry.

§dropped_unspooled: u32

Entries the ring overwrote before they could be replicated.

Counted against the watermark as it stood at the time of the eviction. Because mount starts every run with the watermark at LogPosition::BEGINNING, data overwritten before a replica reappears and calls restore_spool_watermark is counted here even if a replica already had it. Attach early in boot, or seed the watermark from wherever the application stashed it.

§data_lost: bool

Sticky: set once any un-replicated data has been overwritten, never cleared. Surface this to the operator — it means data may have been lost.

On a log that never replicates, everything is un-replicated, so this becomes true the first time the ring wraps. That is accurate but rarely interesting: SpoolStats is only meaningful for a log with a replica.

Trait Implementations§

Source§

impl Clone for SpoolStats

Source§

fn clone(&self) -> Self

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 Copy for SpoolStats

Source§

impl Debug for SpoolStats

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SpoolStats

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for SpoolStats

Source§

impl Format for SpoolStats

Available on crate feature defmt only.
Source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.
Source§

impl PartialEq for SpoolStats

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SpoolStats

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, 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.