Struct metrics_util::layers::FilterLayer

pub struct FilterLayer { /* fields omitted */ }

A layer for filtering and discarding metrics matching certain name patterns.

More information on the behavior of the layer can be found in Filter.

Implementations

impl FilterLayer

pub fn from_patterns<P, I>(patterns: P) -> Self where
    P: IntoIterator<Item = I>,
    I: AsRef<str>, 

Creates a FilterLayer from an existing set of patterns.

pub fn add_pattern<P>(&mut self, pattern: P) -> &mut FilterLayer where
    P: AsRef<str>, 

Adds a pattern to match.

pub fn case_insensitive(&mut self, case_insensitive: bool) -> &mut FilterLayer

Sets the case sensitivity used for pattern matching.

Defaults to false i.e. searches are case sensitive.

pub fn use_dfa(&mut self, dfa: bool) -> &mut FilterLayer

Sets whether or not to internally use a deterministic finite automaton.

Per the docs for the aho-corasick crate, enabling the DFA trades off space usage and build time (at runtime, not compile time) in order to reduce the search time complexity. Using the DFA is beneficial when matching a small number of short patterns, which should be fairly common when filtering metrics.

Defaults to true.

Trait Implementations

impl Default for FilterLayer

pub fn default() -> FilterLayer

Returns the "default value" for a type.

impl<R> Layer<R> for FilterLayer

type Output = Filter<R>

The output type after wrapping.

pub fn layer(&self, inner: R) -> Self::Output

Wraps inner based on this layer.