Struct opendal::layers::PrometheusClientLayer

pub struct PrometheusClientLayer { /* private fields */ }

Available on crate feature layers-prometheus-client only.

Add prometheus-client for every operation.

Prometheus Metrics

We provide several metrics, please see the documentation of observe module. For a more detailed explanation of these metrics and how they are used, please refer to the Prometheus documentation.

Examples

let mut registry = prometheus_client::registry::Registry::default();

let op = Operator::new(services::Memory::default())?
    .layer(PrometheusClientLayer::builder().register(&mut registry))
    .finish();
debug!("operator: {op:?}");

// Write data into object test.
op.write("test", "Hello, World!").await?;
// Read data from object.
let bs = op.read("test").await?;
info!("content: {}", String::from_utf8_lossy(&bs.to_bytes()));

// Get object metadata.
let meta = op.stat("test").await?;
info!("meta: {:?}", meta);

// Export prometheus metrics.
let mut buf = String::new();
prometheus_client::encoding::text::encode(&mut buf, &registry).unwrap();
println!("## Prometheus Metrics");
println!("{}", buf);

Ok(())

Implementations

impl PrometheusClientLayer

pub fn builder() -> PrometheusClientLayerBuilder

Create a PrometheusClientLayerBuilder to set the configuration of metrics.

Default Configuration

• operation_duration_seconds_buckets: exponential_buckets(0.01, 2.0, 16)
• operation_bytes_buckets: exponential_buckets(1.0, 2.0, 16)
• path_label: 0

Examples

// Pick a builder and configure it.
let builder = services::Memory::default();
let mut registry = prometheus_client::registry::Registry::default();

let duration_seconds_buckets =
    prometheus_client::metrics::histogram::exponential_buckets(0.01, 2.0, 16).collect();
let bytes_buckets =
    prometheus_client::metrics::histogram::exponential_buckets(1.0, 2.0, 16).collect();
let op = Operator::new(builder)?
    .layer(
        PrometheusClientLayer::builder()
            .operation_duration_seconds_buckets(duration_seconds_buckets)
            .operation_bytes_buckets(bytes_buckets)
            .path_label(0)
            .register(&mut registry),
    )
    .finish();
debug!("operator: {op:?}");

Ok(())

Trait Implementations

impl Clone for PrometheusClientLayer

fn clone(&self) -> PrometheusClientLayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrometheusClientLayer

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

Formats the value using the given formatter.

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

type LayeredAccess = MetricsAccessor<A, PrometheusClientInterceptor>

The layered accessor that returned by this layer.

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

Intercept the operations on the underlying storage.