Enum prometheus_client::metrics::MetricType

source ·

pub enum MetricType {
    Counter,
    Gauge,
    Histogram,
    Info,
    Unknown,
}

Expand description

OpenMetrics metric type.

Variants§

§

Unknown

Implementations§

source §

impl MetricType

source

pub fn as_str(&self) -> &str

Returns the given metric type’s str representation.

Examples found in repository ?

src/encoding/text.rs (line 59)

pub fn encode<W>(writer: &mut W, registry: &Registry) -> Result<(), std::fmt::Error>
where
    W: Write,
{
    for (desc, metric) in registry.iter() {
        writer.write_str("# HELP ")?;
        writer.write_str(desc.name())?;
        if let Some(unit) = desc.unit() {
            writer.write_str("_")?;
            writer.write_str(unit.as_str())?;
        }
        writer.write_str(" ")?;
        writer.write_str(desc.help())?;
        writer.write_str("\n")?;

        writer.write_str("# TYPE ")?;
        writer.write_str(desc.name())?;
        if let Some(unit) = desc.unit() {
            writer.write_str("_")?;
            writer.write_str(unit.as_str())?;
        }
        writer.write_str(" ")?;
        writer.write_str(EncodeMetric::metric_type(metric.as_ref()).as_str())?;
        writer.write_str("\n")?;

        if let Some(unit) = desc.unit() {
            writer.write_str("# UNIT ")?;
            writer.write_str(desc.name())?;
            writer.write_str("_")?;
            writer.write_str(unit.as_str())?;
            writer.write_str(" ")?;
            writer.write_str(unit.as_str())?;
            writer.write_str("\n")?;
        }

        let encoder = MetricEncoder {
            writer,
            name: desc.name(),
            unit: desc.unit(),
            const_labels: desc.labels(),
            family_labels: None,
        }
        .into();

        EncodeMetric::encode(metric.as_ref(), encoder)?;
    }

    writer.write_str("# EOF\n")?;

    Ok(())
}