Struct ActixWebMetricsBuilder

pub struct ActixWebMetricsBuilder { /* private fields */ }

Builder to create new ActixWebMetrics struct.

Implementations

impl ActixWebMetricsBuilder

pub fn new() -> Self

Create new ActixWebMetricsBuilder

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

Set labels to add on every metrics

pub fn namespace<T: Into<String>>(self, value: T) -> Self

Set namespace

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

Defaults to UNKNOWN

pub fn disable_unmatched_pattern_masking(self) -> Self

Disable masking of unmatched patterns.

WARNING:This may lead to unbounded cardinality for unmatched requests. (potential DoS)

pub fn metrics_config(self, value: ActixWebMetricsConfig) -> Self

Set metrics configuration

pub fn build(self) -> ActixWebMetrics

Instantiate ActixWebMetrics struct

WARNING: This call purposefully leaks the memory of metrics and label names to avoid allocations during runtime. Avoid calling more than once.

Trait Implementations

impl Debug for ActixWebMetricsBuilder

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

Formats the value using the given formatter.

impl Default for ActixWebMetricsBuilder

fn default() -> Self

Returns the “default value” for a type.