pub struct MetricsLayer;
Expand description

MetricsLayer will add metrics for OpenDAL.

Metrics

  • opendal_requests_total: Total requests numbers;
  • opendal_requests_duration_seconds: Request duration seconds;
    • NOTE: this metric tracks the duration of the OpenDAL’s function call, not the underlying http request duration.
  • opendal_failures_total: number of unexpected errors encountered, like network broken;
  • opendal_errors_total: number of expected errors failures encountered, like file not found;
  • opendal_bytes_read_total: bytes read from underlying storage;
  • opendal_bytes_write_total: bytes write to underlying storage.

Labels

Most metrics will carry the following labels

  • service: Service name from Scheme
  • operation: Operation name from Operation

Examples

use anyhow::Result;
use opendal::layers::MetricsLayer;
use opendal::Operator;
use opendal::Scheme;

let _ = Operator::from_env(Scheme::Fs)
    .expect("must init")
    .layer(MetricsLayer);

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Intercept the operations on the underlying storage.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Applies the [Compat] adapter by value. Read more
Applies the [Compat] adapter by shared reference. Read more
Applies the [Compat] adapter by mutable reference. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more