Struct mz_storage::metrics::StorageMetrics

pub struct StorageMetrics {
    pub(crate) source_defs: SourceMetricDefs,
    pub(crate) decode_defs: DecodeMetricDefs,
    pub(crate) upsert_defs: UpsertMetricDefs,
    pub(crate) upsert_backpressure_defs: UpsertBackpressureMetricDefs,
    pub(crate) sink_defs: SinkMetricDefs,
    pub(crate) source_statistics: SourceStatisticsMetricDefs,
    pub(crate) sink_statistics: SinkStatisticsMetricDefs,
}

A top-level struct holding all various definitions of all metrics use by the mz-storage crate.

Created by registering it with a MetricsRegistry, it also provides helpers to obtain various instantiated time-series, either per-worker, shared globally, or some more specific labeling scheme.

This struct can be cloned, and the various definitions are shared.

Fields

source_defs: SourceMetricDefs

decode_defs: DecodeMetricDefs

upsert_defs: UpsertMetricDefs

upsert_backpressure_defs: UpsertBackpressureMetricDefs

sink_defs: SinkMetricDefs

source_statistics: SourceStatisticsMetricDefs

sink_statistics: SinkStatisticsMetricDefs

Implementations

impl StorageMetrics

pub fn register_with(registry: &MetricsRegistry) -> Self

Register all metrics with the MetricsRegistry.

pub(crate) fn get_backpressure_metrics( &self, id: GlobalId, index: usize, ) -> BackpressureMetrics

Get a BackpressureMetrics for the given id and worker id.

pub(crate) fn get_upsert_metrics( &self, id: GlobalId, worker_id: usize, backpressure_metrics: Option<BackpressureMetrics>, ) -> UpsertMetrics

Get an UpsertMetrics for the given id and worker id (and optional BackpressureMetrics).

pub(crate) fn get_source_persist_sink_metrics( &self, export_id: GlobalId, primary_source_id: GlobalId, worker_id: usize, data_shard: &ShardId, output_index: usize, ) -> SourcePersistSinkMetrics

Get a SourcePersistSinkMetrics for the given configuration.

pub(crate) fn get_source_metrics( &self, name: &str, id: GlobalId, worker_id: usize, ) -> SourceMetrics

Get a SourceMetrics for the given id and worker id.

pub(crate) fn get_postgres_source_metrics( &self, id: GlobalId, ) -> PgSourceMetrics

Get a PgMetrics for the given id.

pub(crate) fn get_mysql_source_metrics( &self, id: GlobalId, ) -> MySqlSourceMetrics

Get a MySqlSourceMetrics for the given id.

pub(crate) fn get_offset_commit_metrics( &self, id: GlobalId, ) -> OffsetCommitMetrics

Get an OffsetCommitMetrics for the given id.

pub(crate) fn get_kafka_source_metrics( &self, ids: Vec<i32>, topic: String, source_id: GlobalId, ) -> KafkaSourceMetrics

Get an KafkaSourceMetrics for the given configuration.

pub(crate) fn get_kafka_sink_metrics( &self, sink_id: GlobalId, ) -> KafkaSinkMetrics

Get an KafkaSinkMetrics for the given configuration.

pub(crate) fn get_instrumented_source_channel<T>( &self, id: GlobalId, worker_id: usize, worker_count: usize, location: &str, ) -> (InstrumentedUnboundedSender<T, DeleteOnDropCounter<'static, AtomicU64, Vec<String>>>, InstrumentedUnboundedReceiver<T, DeleteOnDropCounter<'static, AtomicU64, Vec<String>>>)

Produce an instrumented channel for use in the source pipeline.

Trait Implementations

impl Clone for StorageMetrics

fn clone(&self) -> StorageMetrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageMetrics

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

Formats the value using the given formatter.