Enum Format

#[non_exhaustive]
pub enum Format {
    OpenMetrics,
    Prometheus,
    OpenMetricsForPrometheus,
}

Metrics export format.

Supported formats are quite similar, but differ how they encode counter values and whether they specify the # EOF terminator:

Format	_total suffix for counters	_info suffix for info	# EOF
Self::OpenMetrics	yes	yes	yes
Self::OpenMetricsForPrometheus	no	no	yes
Self::Prometheus	no	no	no

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OpenMetrics

OpenMetrics text format. This is the original format produced by prometheus-client, which this library is based upon.

Prometheus

Prometheus text format. Since it’s quite similar to the OpenMetrics format, it’s obtained by a streaming transform of OpenMetrics-encoded metrics that removes _total suffixes from reported counter values, _info suffixes from reported info values + changes info types to “gauge”, and removes the # EOF terminator.

OpenMetricsForPrometheus

OpenMetrics text format as understood by Prometheus.

Prometheus mostly understands the OpenMetrics format (e.g., enforcing no empty lines for it). The notable exception is counter and info definitions; OpenMetrics requires to append _total to the counter name and _info to the info name (like _sum / _count / _bucket are appended to histogram names), but Prometheus doesn’t understand this (yet?).

See also: issue in prometheus-client

Implementations

impl Format

pub const OPEN_METRICS_CONTENT_TYPE: &'static str = "application/openmetrics-text; version=1.0.0; charset=utf-8"

Content type for OpenMetrics text format.

pub const PROMETHEUS_CONTENT_TYPE: &'static str = "text/plain; version=0.0.4; charset=utf-8"

Content type for Prometheus test format.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl Hash for Format

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Format

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

impl Eq for Format

impl StructuralPartialEq for Format