Struct metrix::processor::TelemetryProcessor

pub struct TelemetryProcessor<L> { /* fields omitted */ }

The counterpart of the TelemetryTransmitter. It receives the Observations and other messages and processes them.

A TelemetryProcessor is tied to a specific kind of label which is used to determine which metrics are triggered.

The TelemetryProcessor<L> owns a Receiver for TelemetryMessage<L>.

Implementations

impl<L> TelemetryProcessor<L> where
    L: Clone + Eq + Send + 'static, 

pub fn new_pair<T: Into<String>>(
    name: T
) -> (TelemetryTransmitter<L>, TelemetryProcessor<L>)

Creates a TelemetryTransmitter and the corresponding TelemetryProcessor

The name will cause a grouping in the Snapshot.

It is important that the returned TelemetryProcessor gets mounted on a driver soon since otherwise the internal queue will get flooded with unprocessed observations

pub fn new_pair_bounded<T: Into<String>>(
    name: T,
    cap: usize,
    block_on_full: bool
) -> (TelemetryTransmitter<L>, TelemetryProcessor<L>)

Creates a TelemetryTransmitter and the corresponding TelemetryProcessor

The name will cause a grouping in the Snapshot.

The message queue will be bound to cap elements. If block_on_full is false messages will be dropped if cap elements are in the queue.

pub fn new_pair_without_name(
) -> (TelemetryTransmitter<L>, TelemetryProcessor<L>)

Creates a TelemetryTransmitter and the corresponding TelemetryProcessor

No grouping will occur unless the name is set.

It is important that the returned TelemetryProcessor gets mounted on a driver soon since otherwise the internal queue will get flooded with unprocessed observations

pub fn new_pair_bounded_without_name(
    cap: usize,
    block_on_full: bool
) -> (TelemetryTransmitter<L>, TelemetryProcessor<L>)

Creates a TelemetryTransmitter and the corresponding TelemetryProcessor

The name will cause a grouping in the Snapshot.

The message queue will be bound to cap elements. If block_on_full is false messages will be dropped if cap elements are in the queue.

pub fn add_cockpit(&mut self, cockpit: Cockpit<L>)

Add a Cockpit

If the cockpit has a name and another cockpit with the same name is already present the cockpit will not be added.

pub fn cockpit(self, cockpit: Cockpit<L>) -> Self

Add a Cockpit

If the cockpit has a name and another cockpit with the same name is already present the cockpit will not be added.

pub fn get_cockpits(&self) -> Vec<&Cockpit<L>>

Returns all contained Cockpits

pub fn add_handler<T: HandlesObservations<Label = L>>(&mut self, handler: T)

Add a (custom) handler for Observations.

pub fn handler<T: HandlesObservations<Label = L>>(self, handler: T) -> Self

Add a (custom) handler for Observations.

pub fn get_handlers(&self) -> Vec<&dyn HandlesObservations<Label = L>>

Returns all the handlers

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

Add a snapshooter that simply creates some Snapshot defined by it’s internal logic. Usually it polls something when a Snapshot is requested.

pub fn snapshooter<S: PutsSnapshot>(self, snapshooter: S) -> Self

Add a snapshooter that simply creates some Snapshot defined by it’s internal logic. Usually it polls something when a Snapshot is requested.

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

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

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

Sets the name which will cause a grouoing in the Snapshot

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 inactivity_limit(self, limit: Duration) -> Self

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

pub fn set_show_activity_state(&mut self, show: bool)

Set whether to show if the processor is inactive or not if inactivity_limit is set.

The default is true. Only has an effect if a inactivity_limit is set.

pub fn show_activity_state(self, show: bool) -> Self

Set whether to show if the processor is inactive or not if inactivity_limit is set.

The default is true. Only has an effect if a inactivity_limit is set.

Trait Implementations

impl<L> Descriptive for TelemetryProcessor<L>

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

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

impl<L> ProcessesTelemetryMessages for TelemetryProcessor<L> where
    L: Clone + Eq + Send + 'static, 

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

Receive and handle pending operations

impl<L> PutsSnapshot for TelemetryProcessor<L> where
    L: Clone + Eq + Send + 'static, 

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

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