Struct opendal::layers::PrometheusLayerBuilder

pub struct PrometheusLayerBuilder { /* private fields */ }

Available on crate feature layers-prometheus only.

PrometheusLayerBuilder is a config builder to build a PrometheusLayer.

Implementations

impl PrometheusLayerBuilder

pub fn operation_duration_seconds_buckets(self, buckets: Vec<f64>) -> Self

Set buckets for operation_duration_seconds histogram.

Example

// Pick a builder and configure it.
let builder = services::Memory::default();
let registry = prometheus::default_registry();

let buckets = prometheus::exponential_buckets(0.01, 2.0, 16).unwrap();
let op = Operator::new(builder)?
    .layer(
        PrometheusLayer::builder()
            .operation_duration_seconds_buckets(buckets)
            .register(registry)
            .expect("register metrics successfully"),
    )
    .finish();
debug!("operator: {op:?}");

Ok(())

pub fn operation_bytes_buckets(self, buckets: Vec<f64>) -> Self

Set buckets for operation_bytes histogram.

Example

// Pick a builder and configure it.
let builder = services::Memory::default();
let registry = prometheus::default_registry();

let buckets = prometheus::exponential_buckets(1.0, 2.0, 16).unwrap();
let op = Operator::new(builder)?
    .layer(
        PrometheusLayer::builder()
            .operation_bytes_buckets(buckets)
            .register(registry)
            .expect("register metrics successfully"),
    )
    .finish();
debug!("operator: {op:?}");

Ok(())

pub fn path_label(self, level: usize) -> Self

Set the level of path label.

• level = 0: we will ignore the path label.
• level > 0: the path label will be the path split by “/” and get the last n level, if n=1 and input path is “abc/def/ghi”, and then we will get “abc/” as the path label.

Example

// Pick a builder and configure it.
let builder = services::Memory::default();
let registry = prometheus::default_registry();

let op = Operator::new(builder)?
    .layer(
        PrometheusLayer::builder()
            .path_label(1)
            .register(registry)
            .expect("register metrics successfully"),
    )
    .finish();
debug!("operator: {op:?}");

Ok(())

pub fn register(self, registry: &Registry) -> Result<PrometheusLayer>

Register the metrics into the given registry and return a PrometheusLayer.

Example

// Pick a builder and configure it.
let builder = services::Memory::default();
let registry = prometheus::default_registry();

let op = Operator::new(builder)?
    .layer(
        PrometheusLayer::builder()
            .register(registry)
            .expect("register metrics successfully"),
    )
    .finish();
debug!("operator: {op:?}");

Ok(())

pub fn register_default(self) -> Result<PrometheusLayer>

Register the metrics into the default registry and return a PrometheusLayer.

Example

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

let op = Operator::new(builder)?
    .layer(
        PrometheusLayer::builder()
            .register_default()
            .expect("register metrics successfully"),
    )
    .finish();
debug!("operator: {op:?}");

Ok(())