Struct ProcessorMount

pub struct ProcessorMount { /* private fields */ }

A building block for grouping

Implementations

impl ProcessorMount

pub fn new<T: Into<String>>(name: T) -> ProcessorMount

Creates a new instance.

Even though a name is optional having one is the default since this struct is mostly used to group other components.

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

Returns the name

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

Sets the name of this ProcessorMount

Examples found in repository

examples/demo_run.rs (line 136)

fn create_bar_metrics() -> (TelemetryTransmitter<BarLabel>, ProcessorMount) {
    let mut bar_a_panel = Panel::named(BarLabel::A, "bar_a_panel")
        .counter(Counter::new_with_defaults("bar_a_counter"));
    bar_a_panel.add_gauge(Gauge::new_with_defaults("bar_a_gauge"));
    bar_a_panel.add_meter(Meter::new_with_defaults("bar_a_meter"));
    bar_a_panel.add_histogram(Histogram::new_with_defaults("bar_a_histogram"));

    let mut bar_a_cockpit = Cockpit::without_name();
    bar_a_cockpit.add_panel(bar_a_panel);

    let mut bar_b_panel = Panel::new(BarLabel::B);
    bar_b_panel.add_counter(Counter::new_with_defaults("bar_b_counter"));
    bar_b_panel.add_gauge(Gauge::new_with_defaults("bar_b_gauge"));
    bar_b_panel.add_meter(Meter::new_with_defaults("bar_b_meter"));
    bar_b_panel.add_histogram(Histogram::new_with_defaults("bar_b_histogram"));

    let mut bar_b_cockpit = Cockpit::new("bar_b_cockpit");
    bar_b_cockpit.add_panel(bar_b_panel);

    let mut bar_c_panel = Panel::named(BarLabel::C, "bar_c_panel");
    bar_c_panel.add_counter(Counter::new_with_defaults("bar_c_counter"));
    bar_c_panel.add_gauge(Gauge::new_with_defaults("bar_c_gauge"));
    bar_c_panel.add_meter(Meter::new_with_defaults("bar_c_meter"));
    bar_c_panel.add_histogram(Histogram::new_with_defaults("bar_c_histogram"));

    let mut bar_c_cockpit = Cockpit::new("bar_c_cockpit");
    bar_c_cockpit.add_panel(bar_c_panel);

    let (tx, mut processor) = TelemetryProcessor::new_pair_without_name();

    processor.add_cockpit(bar_a_cockpit);
    processor.add_cockpit(bar_b_cockpit);
    processor.add_cockpit(bar_c_cockpit);

    let mut group_processor1 = ProcessorMount::default();
    group_processor1.add_processor(processor);

    let mut group_processor2 = ProcessorMount::default();
    group_processor2.add_processor(group_processor1);
    group_processor2.set_name("group_processor_2");

    let polled_counter = PolledCounter::new();
    let mut polled_instrument =
        PollingInstrument::new_with_defaults("polled_instrument_2", polled_counter);
    polled_instrument.set_title("The polled counter 2");
    polled_instrument.set_description("A counter that is increased when a snapshot is polled");

    group_processor2.add_snapshooter(polled_instrument);

    (tx, group_processor2)
}

pub fn set_inactivity_limit(&mut self, limit: Duration)

Sets the maximum amount of time this processor may be inactive until no more snapshots are taken

pub fn processors(&self) -> Vec<&dyn ProcessesTelemetryMessages>

Returns the processors in this ProcessorMount

pub fn snapshooters(&self) -> Vec<&dyn PutsSnapshot>

Returns the snapshooters of this ProcessorMount

pub fn add_processor_dyn( &mut self, processor: Box<dyn ProcessesTelemetryMessages>, )

pub fn add_snapshooter_dyn(&mut self, snapshooter: Box<dyn PutsSnapshot>)

Trait Implementations

impl AggregatesProcessors for ProcessorMount

fn add_processor<P: ProcessesTelemetryMessages>(&mut self, processor: P)

Add a processor.

fn add_snapshooter<S: PutsSnapshot>(&mut self, snapshooter: S)

Add a snapshooter.

fn attached_mount(&mut self, mount: ProcessorMount) -> AttachedMount

impl Default for ProcessorMount

fn default() -> ProcessorMount

Returns the “default value” for a type.

impl Descriptive for ProcessorMount

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

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

impl ProcessesTelemetryMessages for ProcessorMount

fn process( &mut self, max: usize, strategy: ProcessingStrategy, ) -> ProcessingOutcome

Receive and handle pending operations

impl PutsSnapshot for ProcessorMount

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

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