Struct Collector

pub struct Collector { /* private fields */ }

Available on crate feature metrics-rs only.

Prometheus style process metrics collector for the [metrics] crate.

This is a collector which will directly export the metrics to the registered [metrics] collector.

Implementations

impl Collector

pub fn prefix(self, prefix: impl Into<String>) -> Collector

👎Deprecated since 1.1.0: Use Collector::new(prefix).

Add an prefix that is prepended to metric keys.

Examples

let collector = Collector::default().prefix("my_prefix_");

Deprecated

The new interface for creating a Collector should be utilized.

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

pub fn new(prefix: impl AsRef<str>) -> Collector

Create a new Collector instance with the provided prefix that is prepended to metric keys.

Examples

let collector = Collector::default();

pub fn describe(&self)

Describe available metrics through describe_counter! and 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::default();
// Describe collector
collector.describe();

pub fn collect(&self)

Collect metrics and record through counter! and 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::default();
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<(), Error>

Formats the value using the given formatter.

impl Default for Collector

fn default() -> Collector

Returns the “default value” for a type.

impl PartialEq for Collector

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Collector

impl StructuralPartialEq for Collector

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes