Struct prometheus_client::encoding::MetricEncoder

pub struct MetricEncoder<'a, 'b>(_);

Encoder for a metric.

Implementations

impl<'a, 'b> MetricEncoder<'a, 'b>

pub fn encode_counter<S: EncodeLabelSet, CounterValue: EncodeCounterValue, ExemplarValue: EncodeExemplarValue>(
    &mut self,
    v: &CounterValue,
    exemplar: Option<&Exemplar<S, ExemplarValue>>
) -> Result<(), Error>

Encode a counter.

Examples found in repository

src/metrics/counter.rs (line 182)

    fn encode(&self, mut encoder: MetricEncoder) -> Result<(), std::fmt::Error> {
        encoder.encode_counter::<(), _, u64>(&self.get(), None)
    }

src/metrics/exemplar.rs (line 160)

    fn encode(&self, mut encoder: MetricEncoder) -> Result<(), std::fmt::Error> {
        let (value, exemplar) = self.get();
        encoder.encode_counter(&value, exemplar.as_ref())
    }

pub fn encode_gauge<GaugeValue: EncodeGaugeValue>(
    &mut self,
    v: &GaugeValue
) -> Result<(), Error>

Encode a gauge.

Examples found in repository

src/metrics/gauge.rs (line 249)

    fn encode(&self, mut encoder: MetricEncoder) -> Result<(), std::fmt::Error> {
        encoder.encode_gauge(&self.get())
    }

pub fn encode_info(
    &mut self,
    label_set: &impl EncodeLabelSet
) -> Result<(), Error>

Encode an info.

Examples found in repository

src/metrics/info.rs (line 37)

    fn encode(&self, mut encoder: MetricEncoder) -> Result<(), std::fmt::Error> {
        encoder.encode_info(&self.0)
    }

pub fn encode_histogram<S: EncodeLabelSet>(
    &mut self,
    sum: f64,
    count: u64,
    buckets: &[(f64, u64)],
    exemplars: Option<&HashMap<usize, Exemplar<S, f64>>>
) -> Result<(), Error>

Encode a histogram.

Examples found in repository

src/metrics/histogram.rs (line 136)

    fn encode(&self, mut encoder: MetricEncoder) -> Result<(), std::fmt::Error> {
        let (sum, count, buckets) = self.get();
        encoder.encode_histogram::<()>(sum, count, &buckets, None)
    }

src/metrics/exemplar.rs (line 273)

    fn encode(&self, mut encoder: MetricEncoder) -> Result<(), std::fmt::Error> {
        let inner = self.inner();
        let (sum, count, buckets) = inner.histogram.get();
        encoder.encode_histogram(sum, count, &buckets, Some(&inner.exemplars))
    }

pub fn encode_family<'c, 'd, S: EncodeLabelSet>(
    &'c mut self,
    label_set: &'d S
) -> Result<MetricEncoder<'c, 'd>, Error>

Encode a metric family.

Examples found in repository

src/metrics/family.rs (line 318)

    fn encode(&self, mut encoder: MetricEncoder) -> Result<(), std::fmt::Error> {
        let guard = self.read();
        for (label_set, m) in guard.iter() {
            let encoder = encoder.encode_family(label_set)?;
            m.encode(encoder)?;
        }
        Ok(())
    }

Trait Implementations

impl<'a, 'b> Debug for MetricEncoder<'a, 'b>

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

Formats the value using the given formatter.