1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
//! Types and utilities for calling Prometheus remote write API endpoints.
/// Special label for the name of a metric.
pub const LABEL_NAME: &str = "__name__";
pub const CONTENT_TYPE: &str = "application/x-protobuf";
pub const HEADER_NAME_REMOTE_WRITE_VERSION: &str = "X-Prometheus-Remote-Write-Version";
pub const REMOTE_WRITE_VERSION_01: &str = "0.1.0";
/// A write request.
///
/// .proto:
/// ```protobuf
/// message WriteRequest {
/// repeated TimeSeries timeseries = 1;
/// // Cortex uses this field to determine the source of the write request.
/// // We reserve it to avoid any compatibility issues.
/// reserved 2;
/// // Prometheus uses this field to send metadata, but this is
/// // omitted from v1 of the spec as it is experimental.
/// reserved 3;
/// }
/// ```
#[derive(prost::Message, Clone, PartialEq)]
pub struct WriteRequest {
#[prost(message, repeated, tag = "1")]
pub timeseries: Vec<TimeSeries>,
}
impl WriteRequest {
/// Prepare the write request for sending.
///
/// Ensures that the request conforms to the specification.
/// See https://prometheus.io/docs/concepts/remote_write_spec.
pub fn sort(&mut self) {
for series in &mut self.timeseries {
series.sort_labels_and_samples();
}
}
pub fn sorted(mut self) -> Self {
self.sort();
self
}
/// Encode this write request as a protobuf message.
///
/// NOTE: The API requires snappy compression, not a raw protobuf message.
pub fn encode_proto3(self) -> Vec<u8> {
prost::Message::encode_to_vec(&self.sorted())
}
/// Encode this write request as a snappy-compressed protobuf message.
#[cfg(feature = "compression")]
pub fn encode_compressed(self) -> Result<Vec<u8>, snap::Error> {
snap::raw::Encoder::new().compress_vec(&self.encode_proto3())
}
/// Parse metrics from the Prometheus text format, and convert them into a
/// [`WriteRequest`].
#[cfg(feature = "parse")]
pub fn from_text_format(
text: String,
) -> Result<Self, Box<dyn std::error::Error + Send + Sync>> {
fn samples_to_timeseries(
samples: Vec<prometheus_parse::Sample>,
) -> Result<Vec<TimeSeries>, Box<dyn std::error::Error + Send + Sync>> {
let mut all_series = std::collections::HashMap::<String, TimeSeries>::new();
for sample in &samples {
let mut labels = sample
.labels
.iter()
.map(|(k, v)| (k.as_str(), v.as_str()))
.collect::<Vec<_>>();
labels.sort_by(|a, b| a.0.cmp(b.0));
let mut ident = sample.metric.clone();
ident.push_str("_$$_");
for (k, v) in &labels {
ident.push_str(k);
ident.push('=');
ident.push_str(v);
}
let series = all_series.entry(ident).or_insert_with(|| {
let labels = labels
.iter()
.map(|(k, v)| Label {
name: k.to_string(),
value: v.to_string(),
})
.collect::<Vec<_>>();
TimeSeries {
labels,
samples: vec![],
}
});
let value = match sample.value {
prometheus_parse::Value::Counter(v) => v,
prometheus_parse::Value::Gauge(v) => v,
prometheus_parse::Value::Histogram(_) => {
Err("histogram not supported yet".to_string())?
}
prometheus_parse::Value::Summary(_) => {
Err("summary not supported yet".to_string())?
}
prometheus_parse::Value::Untyped(v) => v,
};
series.samples.push(Sample {
value,
timestamp: sample.timestamp.timestamp_millis(),
});
}
Ok(all_series.into_values().collect())
}
let iter = [text].into_iter().map(Ok::<_, std::io::Error>);
let parsed = prometheus_parse::Scrape::parse(iter)
.map_err(|err| format!("could not parse input as Prometheus text format: {err}"))?;
let series = samples_to_timeseries(parsed.samples)?;
let s = Self { timeseries: series };
Ok(s.sorted())
}
/// Build a fully prepared HTTP request that an be sent to a remote write endpoint.
#[cfg(feature = "http")]
pub fn build_http_request(
self,
endpoint: &url::Url,
user_agent: &str,
) -> Result<http::Request<Vec<u8>>, Box<dyn std::error::Error + Send + Sync>> {
let req = http::Request::builder()
.method(http::Method::POST)
.uri(endpoint.as_str())
.header(http::header::CONTENT_TYPE, CONTENT_TYPE)
.header(HEADER_NAME_REMOTE_WRITE_VERSION, REMOTE_WRITE_VERSION_01)
.header(http::header::CONTENT_ENCODING, "snappy")
.header(http::header::USER_AGENT, user_agent)
.body(self.encode_compressed()?)?;
Ok(req)
}
}
/// A time series.
///
/// .proto:
/// ```protobuf
/// message TimeSeries {
/// repeated Label labels = 1;
/// repeated Sample samples = 2;
/// }
/// ```
#[derive(prost::Message, Clone, PartialEq)]
pub struct TimeSeries {
#[prost(message, repeated, tag = "1")]
pub labels: Vec<Label>,
#[prost(message, repeated, tag = "2")]
pub samples: Vec<Sample>,
}
impl TimeSeries {
/// Sort labels by name, and the samples by timestamp.
///
/// Required by the specification.
pub fn sort_labels_and_samples(&mut self) {
self.labels.sort_by(|a, b| a.name.cmp(&b.name));
self.samples.sort_by(|a, b| a.timestamp.cmp(&b.timestamp));
}
}
/// A label.
///
/// .proto:
/// ```protobuf
/// message Label {
/// string name = 1;
/// string value = 2;
/// }
/// ```
#[derive(prost::Message, Clone, Hash, PartialEq, Eq)]
pub struct Label {
#[prost(string, tag = "1")]
pub name: String,
#[prost(string, tag = "2")]
pub value: String,
}
/// A sample.
///
/// .proto:
/// ```protobuf
/// message Sample {
/// double value = 1;
/// int64 timestamp = 2;
/// }
/// ```
#[derive(prost::Message, Clone, PartialEq)]
pub struct Sample {
#[prost(double, tag = "1")]
pub value: f64,
#[prost(int64, tag = "2")]
pub timestamp: i64,
}