Skip to main content

ScientificEncoder

Struct ScientificEncoder 

Source
pub struct ScientificEncoder;
Expand description

A Prometheus text-format encoder that renders counter values in scientific notation ({:.10E}) and appends a trailing comma after the last label.

This matches the output format produced by Kafka’s JMX-to-Prometheus exporters, making it useful for dashboards that expect that convention.

§Example

use prometheus::Opts;
use prometheus::core::Collector;
use prometheus_extensions::{AggregateCounter, ScientificEncoder};

let counter = AggregateCounter::new(
    Opts::new("bytes_in", "Bytes received"),
    &["topic"],
).unwrap();
counter.with_label_values(&["events"]).inc_by(4.6384186519e10);

let families = counter.collect();
let encoder = ScientificEncoder::new();
let mut buf = Vec::new();
encoder.encode(&families, &mut buf).unwrap();

let output = String::from_utf8(buf).unwrap();
assert!(output.contains("bytes_in{topic=\"events\",}"));
assert!(output.contains("E10"));

Implementations§

Source§

impl ScientificEncoder

Source

pub fn new() -> Self

Create a new encoder.

Source

pub fn encode<W: Write>( &self, metric_families: &[MetricFamily], writer: &mut W, ) -> Result<(), Error>

Encode metric_families into the Prometheus text exposition format with scientific-notation counter values.

Trait Implementations§

Source§

impl Default for ScientificEncoder

Source§

fn default() -> ScientificEncoder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.