Struct UsageLedger 

pub struct UsageLedger { /* private fields */ }

See the module doc.

Implementations

impl UsageLedger

pub fn new() -> Self

pub fn epoch(&self) -> &str

This ledger’s epoch: a cursor from another is “everything”.

pub fn drift_corrections(&self) -> u64

How many re-measurements by the reconcile pass found a namespace different from what the ledger held — a change no mark reported. Zero on a box whose marks are complete.

pub fn mark_repo(&self, namespace: &str, name: &str)

This repository’s bytes may have changed.

pub fn mark_namespace(&self, namespace: &str)

Everything about this namespace may have changed: its repositories’ bytes and its tombstones.

pub fn mark_flow(&self, namespace: &str)

This namespace’s flow moved (the flow ledger’s observer).

pub fn mark_all(&self)

Everything may have changed (a growth’s remount, a role change).

pub fn cursor_now(&self, now_unix_ms: i64) -> String

The cursor as of now.

pub fn settle(&self, stores: &ServerStores, sweep: bool) -> Result<()>

Bring the ledger up to date with every mark and with the open-store set — every store that opened or closed since the last settle, and, with sweep, every store that is open.

pub fn page( &self, stores: &ServerStores, after: &str, page_size: usize, changed_since: &str, now_unix_ms: i64, ) -> Result<Page>

One page, in namespace order after after, of at most page_size namespaces — every one, or with since only those that changed after it. Settles first. Returns the rows’ namespaces with what is held, and whether there are more.

pub fn exact( &self, stores: &ServerStores, namespace: &str, ) -> Result<Option<Exact>>

One namespace, measured now — what Usage.Read answers: exact, its own repositories and tombstones walked, nothing else (the index answers which repositories are its). None for a namespace the catalog does not hold. Returns the per-repository bytes too, sorted by name.

pub fn reconcile_step( &self, stores: &ServerStores, tick: Duration, ) -> Result<(usize, usize)>

The reconcile pass: re-measure the next slice of namespaces (sized so the whole set is covered every RECONCILE_CYCLE at a tick cadence), as if each had been marked. A difference found here is a change no mark reported: it is corrected (and answered to the next changed-since read) and counted. Returns (namespaces looked at, corrected).

A pass that cannot run is an Err, never a quiet (0, 0) (A28 M17): the settle before the slice reads the catalog, and when it cannot be read nothing is re-measured. Its caller (crate::stores::reconcile_tick) counts the miss (usage_reconcile_missed on /metrics and in the heartbeat) and warns.

Trait Implementations

impl Debug for UsageLedger

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

Formats the value using the given formatter.

impl Default for UsageLedger

fn default() -> Self

Returns the “default value” for a type.