Struct mz_persist_client::metrics::SinkMetrics

pub struct SinkMetrics {
    correction_insertions_total: IntCounter,
    correction_deletions_total: IntCounter,
    correction_capacity_increases_total: IntCounter,
    correction_capacity_decreases_total: IntCounter,
    correction_max_per_sink_worker_len_updates: UIntGaugeVec,
    correction_max_per_sink_worker_capacity_updates: UIntGaugeVec,
}

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

correction_insertions_total: IntCounter

Cumulative record insertions made to the correction buffer across workers

correction_deletions_total: IntCounter

Cumulative record deletions made to the correction buffer across workers

correction_capacity_increases_total: IntCounter

Cumulative capacity increases made to the correction buffer across workers

correction_capacity_decreases_total: IntCounter

Cumulative capacity decreases made to the correction buffer across workers

correction_max_per_sink_worker_len_updates: UIntGaugeVec

Maximum length observed for any one correction buffer per worker

correction_max_per_sink_worker_capacity_updates: UIntGaugeVec

Maximum capacity observed for any one correction buffer per worker

Implementations

impl SinkMetrics

fn new(registry: &MetricsRegistry) -> Self

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.

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.