Struct metrix::instruments::Panel

pub struct Panel<L> {
    pub label: L,
    pub name: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub counter: Option<Counter>,
    pub gauge: Option<Gauge>,
    pub meter: Option<Meter>,
    pub histogram: Option<Histogram>,
    pub value_scaling: Option<ValueScaling>,
}

The panel shows recorded observations of the same label in different representations.

Let's say you want to monitor the successful requests of a specific endpoint of your REST API. You would then create a panel for this and might want to add a counter and a meter and a histogram to track latencies.

Example

use std::time::Instant;
use metrix::instruments::*;

#[derive(Clone, PartialEq, Eq)]
struct SuccessfulRequests;

let counter = Counter::new_with_defaults("count");
let gauge = Gauge::new_with_defaults("last_latency");
let meter = Meter::new_with_defaults("per_second");
let histogram = Histogram::new_with_defaults("latencies");

assert_eq!(0, counter.get());
assert_eq!(None, gauge.get());

let mut panel = Panel::with_name(SuccessfulRequests, "succesful_requests");
panel.set_counter(counter);
panel.set_gauge(gauge);
panel.set_meter(meter);
panel.set_histogram(histogram);

let update = Update::ObservationWithValue(12, Instant::now());
panel.update(&update);

assert_eq!(Some(1), panel.counter().map(|c| c.get()));
assert_eq!(Some(12), panel.gauge().and_then(|g| g.get()));

Fields

label: L

name: Option<String>

title: Option<String>

description: Option<String>

counter: Option<Counter>

gauge: Option<Gauge>

meter: Option<Meter>

histogram: Option<Histogram>

value_scaling: Option<ValueScaling>

Methods

impl<L> Panel<L>

fn new(label: L) -> Panel<L>

Create a new Panel without a name.

fn with_name<T: Into<String>>(label: L, name: T) -> Panel<L>

Create a new Panel with the given name

fn set_counter(&mut self, counter: Counter)

fn set_gauge(&mut self, gauge: Gauge)

fn set_meter(&mut self, meter: Meter)

fn set_histogram(&mut self, histogram: Histogram)

fn counter(&self) -> Option<&Counter>

fn gauge(&self) -> Option<&Gauge>

fn meter(&self) -> Option<&Meter>

fn histogram(&self) -> Option<&Histogram>

fn set_value_scaling(&mut self, value_scaling: ValueScaling)

fn name(&self) -> Option<&str>

Gets the name of this Panel

fn set_name<T: Into<String>>(&mut self, name: T)

Set the name if this Panel.

The name is a path segment within a Snapshot

fn set_title<T: Into<String>>(&mut self, title: T)

Sets the title of this Panel.

A title can be part of a descriptive Snapshot

fn set_description<T: Into<String>>(&mut self, description: T)

Sets the description of this Panel.

A description can be part of a descriptive Snapshot

Trait Implementations

impl<L> PutsSnapshot for Panel<L>

fn put_snapshot(&self, into: &mut Snapshot, descriptive: bool)

Puts the current snapshot values into the given Snapshot thereby following the guidelines of PutsSnapshot.

impl<L> Updates for Panel<L>

fn update(&mut self, with: &Update)

Update the internal state according to the given Update.

impl<L> Descriptive for Panel<L>

fn title(&self) -> Option<&str>

fn description(&self) -> Option<&str>