Struct metrics_process::Collector

pub struct Collector { /* private fields */ }

Prometheus style process metrics collector

Implementations

impl Collector

pub fn new(prefix: impl Into<String>) -> Self

Create a new Collector instance

• prefix - A prefix string that is prepended to metric keys.

Examples

let collector = Collector::new("my_metrics_");

pub fn describe(&self)

Describe available metrics through describe_gauge! macro of metrics crate.

Example

// Recorder must be initialized prior to describe.
let builder = PrometheusBuilder::new();
builder.install().expect("failed to install recorder/exporter");

let collector = Collector::new("my_metrics_");
// Describe collector
collector.describe();

pub fn collect(&self)

Collect metrics and record through gauge! macro of metrics crate.

Example

// Recorder must be initialized prior to describe.
let builder = PrometheusBuilder::new();
builder.install().expect("failed to install recorder/exporter");

let collector = Collector::new("my_metrics_");
collector.describe();
// Collect metrics
collector.collect();

Trait Implementations

impl Clone for Collector

fn clone(&self) -> Collector

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Collector

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

Formats the value using the given formatter.

impl PartialEq<Collector> for Collector

fn eq(&self, other: &Collector) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Collector

impl StructuralEq for Collector

impl StructuralPartialEq for Collector