Struct mz_persist_client::metrics::SinkMetrics

pub struct SinkMetrics {
    pub forwarded_batches: Counter,
    pub forwarded_updates: Counter,
    /* private fields */
}

Metrics for the persist sink. (While this lies slightly outside the usual abstraction boundary of the client, it’s convenient to manage them together.

Fields

forwarded_batches: Counter

Number of small batches that were forwarded to the central append operator

forwarded_updates: Counter

Number of updates that were forwarded to the centralized append operator

Implementations

impl SinkMetrics

pub fn for_worker(&self, worker_id: usize) -> SinkWorkerMetrics

Obtains a SinkWorkerMetrics instance, which allows for metric reporting from a specific persist_sink instance for a given worker. The reports will update metrics shared across workers, but provide per-worker contributions to them.

pub fn report_correction_update_deltas( &self, correction_len_delta: UpdateDelta, correction_cap_delta: UpdateDelta )

Reports updates to the length and capacity of the correction buffer in the write_batches operator of a persist_sink.

This method updates monotonic metrics based on the deltas and thus can be called across workers and instances of persist_sink.

pub fn update_sink_correction_peak_metrics(&self)

Updates our estimate of the aggregate peak for the correction buffer length and capacity across workers and persist sink.

This method assumes temporary quiescence on the correction buffer metrics, i.e., there are no updates to these metrics taking place when the method is called. This occurs, e.g., after a step_or_park call.

Trait Implementations

impl Clone for SinkMetrics

fn clone(&self) -> SinkMetrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SinkMetrics

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

Formats the value using the given formatter.