Struct PatternGroup

pub struct PatternGroup { /* private fields */ }

Implementations

impl PatternGroup

pub fn new() -> Self

Examples found in repository

examples/basic.rs (line 22)

async fn main() {
    let handle = PlotlyRecorderBuilder::new().install().unwrap();

    let h = tokio::spawn(async {
        for _ in 0..200 {
            counter!("something_success").increment(1);
            counter!("something_error").increment(1);

            counter!("foo_asdf_success").increment(2);
            counter!("foo_asdf_error").increment(2);
            tokio::time::sleep(std::time::Duration::from_millis(10)).await;
        }
    });

    h.await;

    handle
        .plot(&[PatternGroup::new()
            .pattern(r"(?<transaction>.*)_success", PlotKind::Rate)
            .pattern(r"(?<transaction>.*)_error", PlotKind::Rate)])
        .await;
}

pub fn pattern(self, regex: &str, kind: PlotKind) -> Self

Add a pattern to match for plotting

Takes in a regex pattern with a named capture group which will be used to correlate metrics.

Example

The following will match metrics of the form *_success and *_error, and group them together into plots next to each other.

PatternGroup::new()
    .pattern(r"(?<transaction>.*)_success", PlotKind::Rate)
    .pattern(r"(?<transaction>.*)_error", PlotKind::Rate)

For instance, foo_success and foo_error will be grouped, and bar_success and bar_error will be grouped together.

Panics

Panics on an invalid Regex

Examples found in repository

examples/basic.rs (line 23)

async fn main() {
    let handle = PlotlyRecorderBuilder::new().install().unwrap();

    let h = tokio::spawn(async {
        for _ in 0..200 {
            counter!("something_success").increment(1);
            counter!("something_error").increment(1);

            counter!("foo_asdf_success").increment(2);
            counter!("foo_asdf_error").increment(2);
            tokio::time::sleep(std::time::Duration::from_millis(10)).await;
        }
    });

    h.await;

    handle
        .plot(&[PatternGroup::new()
            .pattern(r"(?<transaction>.*)_success", PlotKind::Rate)
            .pattern(r"(?<transaction>.*)_error", PlotKind::Rate)])
        .await;
}

Trait Implementations

impl Debug for PatternGroup

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

Formats the value using the given formatter.

impl Default for PatternGroup

fn default() -> Self

Returns the “default value” for a type.