Struct PrometheusMetricsBuilder 

pub struct PrometheusMetricsBuilder { /* private fields */ }

Builder to create new PrometheusMetrics struct.HistogramVec

It allows setting optional parameters like registry, buckets, etc.

Implementations

impl PrometheusMetricsBuilder

pub fn new(namespace: &str) -> Self

Create new PrometheusMetricsBuilder

namespace example: “actix”

pub fn endpoint(self, value: &str) -> Self

Set actix web endpoint

Example: “/metrics”

pub fn buckets(self, value: &[f64]) -> Self

Set histogram buckets

pub fn const_labels(self, value: HashMap<String, String>) -> Self

Set labels to add on every metrics

pub fn registry(self, value: Registry) -> Self

Set registry

By default one is set and is internal to PrometheusMetrics

pub fn exclude<T: Into<String>>(self, path: T) -> Self

Ignore and do not record metrics for specified path.

pub fn exclude_regex<T: Into<String>>(self, path: T) -> Self

Ignore and do not record metrics for paths matching the regex.

pub fn exclude_status<T: Into<StatusCode>>(self, status: T) -> Self

Ignore and do not record metrics for paths returning the status code.

pub fn mask_unmatched_patterns<T: Into<String>>(self, mask: T) -> Self

Replaces the request path with the supplied mask if no actix-web handler is matched

pub fn metrics_configuration(self, value: ActixMetricsConfiguration) -> Self

Set metrics configuration

pub fn build(self) -> Result<PrometheusMetrics, Box<dyn Error + Send + Sync>>

Instantiate PrometheusMetrics struct

Trait Implementations

impl Debug for PrometheusMetricsBuilder

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

Formats the value using the given formatter.