Struct metrix::instruments::polled::PollingInstrument

pub struct PollingInstrument<P> {
    pub name: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub poll: P,
    pub create_group_with_name: bool,
}

Create an instrument that delivers metrics based on querying values when a Snapshot is requested.

The Snapshot can be generated from anything that implements PutsSnapshot.

Fields

name: String

If create_group_with_name is true, this name will create a new named group.

title: Option<String>

description: Option<String>

poll: P

create_group_with_name: bool

Methods

impl<P> PollingInstrument<P> where
    P: PutsSnapshot, 

pub fn new_with_defaults<T: Into<String>>(
    name: T,
    poll: P
) -> PollingInstrument<P>

pub fn get_name(&self) -> &str

Gets the name of this PollingInstrument

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

Set the name if this PollingInstrument.

The name is a path segment within a Snapshot if self.create_group_with_name is set to true.

pub fn create_group_with_name(&self) -> bool

Returns whether a new group with the instruments name shall be craeted in the snapshot.

pub fn set_create_group_with_name(&mut self, create_group: bool)

Set to true if you want to create a new group with the name of this instrument when a Snapshot is requested.

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

Sets the title of this PollingInstrument.

A title can be part of a descriptive Snapshot

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

Sets the description of this PollingInstrument.

A description can be part of a descriptive Snapshot

Trait Implementations

impl<P> Descriptive for PollingInstrument<P>

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

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

impl<P> PutsSnapshot for PollingInstrument<P> where
    P: PutsSnapshot, 

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

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