Struct MetricsLayer

pub struct MetricsLayer {}

Available on crate feature layers-metrics only.

Add metrics for every operation.

Metrics

We provide several metrics, please see the documentation of observe module.

Notes

Please make sure the exporter has been pulled in regular time. Otherwise, the histogram data collected by requests_duration_seconds could result in OOM.

Examples

let _ = Operator::new(services::Memory::default())?
    .layer(MetricsLayer::default())
    .finish();
Ok(())

Output

OpenDAL is using metrics for metrics internally.

To enable metrics output, please enable one of the exporters that metrics supports.

Take metrics_exporter_prometheus as an example:

let builder = PrometheusBuilder::new()
    .set_buckets_for_metric(
        Matcher::Suffix("bytes".into()),
        &observe::DEFAULT_BYTES_BUCKETS,
    )
    .set_buckets_for_metric(
        Matcher::Suffix("duration_seconds".into()),
        &observe::DEFAULT_DURATION_SECONDS_BUCKETS,
    )
    // ..
    .expect("failed to create builder");
builder.install().expect("failed to install recorder/exporter");
let handle = builder.install_recorder().expect("failed to install recorder");
let (recorder, exporter) = builder.build().expect("failed to build recorder/exporter");
let recorder = builder.build_recorder().expect("failed to build recorder");

Trait Implementations

impl Clone for MetricsLayer

fn clone(&self) -> MetricsLayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricsLayer

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

Formats the value using the given formatter.

impl Default for MetricsLayer

fn default() -> MetricsLayer

Returns the “default value” for a type.

impl<A: Access> Layer<A> for MetricsLayer

type LayeredAccess = MetricsAccessor<A, MetricsInterceptor>

The layered accessor that returned by this layer.

fn layer(&self, inner: A) -> Self::LayeredAccess

Intercept the operations on the underlying storage.