Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Summary metric type #67

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add Summary metric type #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
29661c0
Add Summary metric
palash25 Nov 21, 2022
2ab4ac1
Fix conflicts
palash25 Jan 28, 2023
9462cd6
Add serde style encoding for Summary
palash25 Jan 28, 2023
29f3d4b
Address review comments
palash25 Mar 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Expand Up @@ -24,6 +24,7 @@ parking_lot = "0.12"
prometheus-client-derive-encode = { version = "0.4.1", path = "derive-encode" }
prost = { version = "0.11.0", optional = true }
prost-types = { version = "0.11.0", optional = true }
quantiles = "0.7.1"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would guess that most users of this library don't need the Summary type. What do you think of feature flagging the type as well as the quantiles dependency. The latter will help keeping ones dependency tree lean, thus compile times short.


[dev-dependencies]
async-std = { version = "1", features = ["attributes"] }
Expand Down
15 changes: 15 additions & 0 deletions src/encoding.rs
View file
Open in desktop
Expand Up @@ -131,6 +131,21 @@ impl<'a, 'b> MetricEncoder<'a, 'b> {
)
}

/// Encode a summary.
pub fn encode_summary<S: EncodeLabelSet>(
&mut self,
sum: f64,
count: u64,
quantiles: &[(f64, f64)],
) -> Result<(), std::fmt::Error> {
for_both_mut!(
self,
MetricEncoderInner,
e,
e.encode_summary::<S>(sum, count, quantiles)
)
}

/// Encode a metric family.
pub fn encode_family<'c, 'd, S: EncodeLabelSet>(
&'c mut self,
Expand Down
73 changes: 73 additions & 0 deletions src/encoding/protobuf.rs
View file
Open in desktop
Expand Up @@ -99,6 +99,7 @@ impl From<MetricType> for openmetrics_data_model::MetricType {
MetricType::Counter => openmetrics_data_model::MetricType::Counter,
MetricType::Gauge => openmetrics_data_model::MetricType::Gauge,
MetricType::Histogram => openmetrics_data_model::MetricType::Histogram,
MetricType::Summary => openmetrics_data_model::MetricType::Summary,
MetricType::Info => openmetrics_data_model::MetricType::Info,
MetricType::Unknown => openmetrics_data_model::MetricType::Unknown,
}
Expand Down Expand Up @@ -247,6 +248,44 @@ impl<'a> MetricEncoder<'a> {

Ok(())
}

pub fn encode_summary<S: EncodeLabelSet>(
&mut self,
sum: f64,
count: u64,
quantile: &[(f64, f64)],
) -> Result<(), std::fmt::Error> {
let quantiles = quantiles
.iter()
.enumerate()
.map(|(_, (quantile, value))| {
Ok(openmetrics_data_model::summary_value::Quantile {
quantile: *quantile,
value: *value,
})
})
.collect::<Result<Vec<_>, std::fmt::Error>>()?;

self.family.push(openmetrics_data_model::Metric {
labels: self.labels.clone(),
metric_points: vec![openmetrics_data_model::MetricPoint {
value: Some(openmetrics_data_model::metric_point::Value::SummaryValue(
openmetrics_data_model::SummaryValue {
count,
created: None,
quantiles,
sum: Some(openmetrics_data_model::summary_value::Sum::DoubleValue(
sum,
)),
},
)),
..Default::default()
}],
});

Ok(())
}

}

impl<S: EncodeLabelSet, V: EncodeExemplarValue> TryFrom<&Exemplar<S, V>>
Expand Down Expand Up @@ -403,6 +442,7 @@ mod tests {
use crate::metrics::family::Family;
use crate::metrics::gauge::Gauge;
use crate::metrics::histogram::{exponential_buckets, Histogram};
use crate::metrics::summary::Summary;
use crate::metrics::info::Info;
use crate::registry::Unit;
use std::borrow::Cow;
Expand Down Expand Up @@ -643,6 +683,39 @@ mod tests {
}
}

#[test]
fn encode_summary() {
let mut registry = Registry::default();
let summary = Summary::new(5, 10, vec![0.5, 0.9, 0.99], 0.01);
registry.register("my_summary", "My summary", summary.clone());
summary.observe(1.0);

let metric_set = encode(&registry).unwrap();

let family = metric_set.metric_families.first().unwrap();
assert_eq!("my_summary", family.name);
assert_eq!("My summary.", family.help);

assert_eq!(
openmetrics_data_model::MetricType::Summary as i32,
extract_metric_type(&metric_set)
);

match extract_metric_point_value(metric_set) {
openmetrics_data_model::metric_point::Value::SummaryValue(value) => {
assert_eq!(
Some(openmetrics_data_model::summary_value::Sum::DoubleValue(
1.0
)),
value.sum
);
assert_eq!(1, value.count);
assert_eq!(11, value.quantile.len());
}
_ => panic!("wrong value type"),
}
}

#[test]
fn encode_histogram() {
let mut registry = Registry::default();
Expand Down
60 changes: 60 additions & 0 deletions src/encoding/text.rs
View file
Open in desktop
Expand Up @@ -211,6 +211,40 @@ impl<'a, 'b> MetricEncoder<'a, 'b> {
})
}

pub fn encode_summary<S: EncodeLabelSet>(
&mut self,
sum: f64,
count: u64,
quantiles: &[(f64, f64)],
) -> Result<(), std::fmt::Error> {
self.write_name_and_unit()?;
self.write_suffix("sum")?;
self.encode_labels::<()>(None)?;
self.writer.write_str(" ")?;
self.writer.write_str(dtoa::Buffer::new().format(sum))?;
self.newline()?;

self.write_name_and_unit()?;
self.write_suffix("count")?;
self.encode_labels::<()>(None)?;
self.writer.write_str(" ")?;
self.writer.write_str(itoa::Buffer::new().format(count))?;
self.newline()?;

for (_, (quantile, result)) in quantiles.iter().enumerate() {
self.write_name_and_unit()?;
self.encode_labels(Some(&[("quantile", *quantile)]))?;

self.writer.write_str(" ")?;
self.writer
.write_str(result.to_string().as_str())?;

self.newline()?;
}

Ok(())
}

pub fn encode_histogram<S: EncodeLabelSet>(
&mut self,
sum: f64,
Expand Down Expand Up @@ -511,6 +545,7 @@ mod tests {
use crate::metrics::family::Family;
use crate::metrics::gauge::Gauge;
use crate::metrics::histogram::{exponential_buckets, Histogram};
use crate::metrics::summary::Summary;
use crate::metrics::info::Info;
use crate::metrics::{counter::Counter, exemplar::CounterWithExemplar};
use pyo3::{prelude::*, types::PyModule};
Expand Down Expand Up @@ -723,6 +758,31 @@ mod tests {
parse_with_python_client(encoded);
}

#[test]
fn encode_summary() {
let mut registry = Registry::default();
let summary = Summary::new(3, 10, vec![0.5, 0.9, 0.99], 0.0);
registry.register("my_summary", "My summary", summary.clone());
summary.observe(0.10);
summary.observe(0.20);
summary.observe(0.30);

let mut encoded = String::new();
encode(&mut encoded, &registry).unwrap();

let expected = "# HELP my_summary My summary.\n".to_owned()
+ "# TYPE my_summary summary\n"
+ "my_summary_sum 0.6000000000000001\n"
+ "my_summary_count 3\n"
+ "my_summary{quantile=\"0.5\"} 0.2\n"
+ "my_summary{quantile=\"0.9\"} 0.3\n"
+ "my_summary{quantile=\"0.99\"} 0.3\n"
+ "# EOF\n";
assert_eq!(expected, encoded);

parse_with_python_client(encoded);
}

fn parse_with_python_client(input: String) {
pyo3::prepare_freethreaded_python();

Expand Down
3 changes: 3 additions & 0 deletions src/metrics.rs
View file
Open in desktop
Expand Up @@ -5,6 +5,7 @@ pub mod exemplar;
pub mod family;
pub mod gauge;
pub mod histogram;
pub mod summary;
pub mod info;

/// A metric that is aware of its Open Metrics metric type.
Expand All @@ -22,6 +23,7 @@ pub enum MetricType {
Histogram,
Info,
Unknown,
Summary,
// Not (yet) supported metric types.
//
// GaugeHistogram,
Expand All @@ -36,6 +38,7 @@ impl MetricType {
MetricType::Counter => "counter",
MetricType::Gauge => "gauge",
MetricType::Histogram => "histogram",
MetricType::Summary => "summary",
MetricType::Info => "info",
MetricType::Unknown => "unknown",
}
Expand Down