Struct PrometheusEncoder 

pub struct PrometheusEncoder { /* private fields */ }

Encoder for Prometheus text exposition snapshots.

The encoder is intentionally transport-agnostic: callers can write the returned text to a file, serve it from their own HTTP endpoint, or pass it to another delivery mechanism without enabling the pushgateway feature.

Implementations

impl PrometheusEncoder

pub const DEFAULT_PREFIX: &'static str = "iperf3"

Default metric prefix used by the CLI, PrometheusEncoder, and Pushgateway helpers.

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

Build an encoder with a custom metric name prefix.

pub fn with_labels<I, K, V>( metric_prefix: impl Into<String>, labels: I, ) -> Result<Self>

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Build an encoder with fixed labels on every emitted sample.

pub fn metric_prefix(&self) -> &str

Return the metric prefix used by this encoder.

pub fn labels(&self) -> &[(String, String)]

Return fixed labels applied to every emitted sample.

pub fn encode_interval(&self, metrics: &Metrics) -> String

Encode one immediate interval sample as Prometheus text exposition.

pub fn encode_window(&self, metrics: &WindowMetrics) -> String

Encode one aggregated window summary as Prometheus text exposition.

Trait Implementations

impl Clone for PrometheusEncoder

fn clone(&self) -> PrometheusEncoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrometheusEncoder

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

Formats the value using the given formatter.

impl Default for PrometheusEncoder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PrometheusEncoder

fn eq(&self, other: &PrometheusEncoder) -> 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 PrometheusEncoder

impl StructuralPartialEq for PrometheusEncoder