Module ore::metrics[−][src]

This is supported on crate feature metrics only.

Expand description

Metrics for materialize systems.

The idea here is that each subsystem keeps its metrics in a scoped-to-it struct, which gets registered (once) to the server’s (or a test’s) prometheus registry.

Instead of using prometheus’s (very verbose) metrics definitions, we rely on type inference to reduce the verbosity a little bit. A typical subsystem will look like the following:

#[derive(Debug, Clone)] // Note that prometheus metrics can safely be cloned
struct Metrics {
    pub bytes_sent: UIntCounter,
}

impl Metrics {
    pub fn register_into(registry: &MetricsRegistry) -> Metrics {
        Metrics {
            bytes_sent: registry.register(metric!(
                name: "mz_pg_sent_bytes",
                help: "total number of bytes sent here",
            )),
        }
    }
}

Modules

delete_on_drop

Support for metrics that get removed from their corresponding metrics vector when dropped.

raw

Access to non-delete-on-drop vector types

third_party_metric

Structs

ComputedGenericGauge

A Gauge whose value is computed whenever it is observed.

DeleteOnDropCounter

A GenericCounter wrapper that deletes its labels from the vec when it is dropped

DeleteOnDropGauge

A GenericGauge wrapper that deletes its labels from the vec when it is dropped

DeleteOnDropHistogram

A GenericCounter wrapper that deletes its labels from the vec when it is dropped

DeleteOnDropWrapper

A wrapper for metrics to require delete on drop semantics

Histogram

A Metric counts individual observations from an event or sample stream in configurable buckets. Similar to a Summary, it also provides a sum of observations and an observation count.

MetricsRegistry

The materialize metrics registry.

PrometheusOpts

A struct that bundles the options for creating most Metric types.

ThirdPartyMetric

A metric that can be made accessible to cloud infrastructure/orchestrators, that won’t betray the contents of the materialize instance that it details.