Skip to content

feat(layers/prometheus_client): Add disable_label_root to allow skip root label in metrics #6071

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

Merged
merged 3 commits into from
Apr 21, 2025
Merged

feat(layers/prometheus_client): Add disable_label_root to allow skip root label in metrics #6071

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2fd25fe
allow disable high cardinality labels in prometheus client
flaneur2020 Apr 21, 2025
89bdf3d
rename as enable_label_root
flaneur2020 Apr 21, 2025
a401eb1
take disable_label_root
flaneur2020 Apr 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 29 additions & 8 deletions core/src/layers/prometheus_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ pub struct PrometheusClientLayerBuilder {
entries_rate_buckets: Vec<f64>,
duration_seconds_buckets: Vec<f64>,
ttfb_buckets: Vec<f64>,
enable_high_cardinality_labels: bool,
}

impl Default for PrometheusClientLayerBuilder {
Expand All @@ -118,6 +119,7 @@ impl Default for PrometheusClientLayerBuilder {
entries_rate_buckets: observe::DEFAULT_ENTRIES_RATE_BUCKETS.to_vec(),
duration_seconds_buckets: observe::DEFAULT_DURATION_SECONDS_BUCKETS.to_vec(),
ttfb_buckets: observe::DEFAULT_TTFB_BUCKETS.to_vec(),
enable_high_cardinality_labels: true,
}
}
}
Expand Down Expand Up @@ -171,6 +173,12 @@ impl PrometheusClientLayerBuilder {
self
}

/// Set enable high cardinality labels. The high cardinality labels might have risks of cardinality explosion, so we can disable it by default.
pub fn enable_high_cardinality_labels(mut self, enable: bool) -> Self {
self.enable_high_cardinality_labels = enable;
self
}

/// Register the metrics into the registry and return a [`PrometheusClientLayer`].
///
/// # Examples
Expand Down Expand Up @@ -359,6 +367,8 @@ impl PrometheusClientLayerBuilder {
http_response_duration_seconds,
http_connection_errors_total,
http_status_errors_total,

enable_high_cardinality_labels: self.enable_high_cardinality_labels,
},
}
}
Expand Down Expand Up @@ -395,11 +405,16 @@ pub struct PrometheusClientInterceptor {
http_response_duration_seconds: Family<OperationLabels, Histogram, HistogramConstructor>,
http_connection_errors_total: Family<OperationLabels, Counter>,
http_status_errors_total: Family<OperationLabels, Counter>,

enable_high_cardinality_labels: bool,
}

impl observe::MetricsIntercept for PrometheusClientInterceptor {
fn observe(&self, labels: observe::MetricLabels, value: observe::MetricValue) {
let labels = OperationLabels(labels);
let labels = OperationLabels {
labels,
enable_high_cardinality_labels: self.enable_high_cardinality_labels,
};
match value {
observe::MetricValue::OperationBytes(v) => self
.operation_bytes
Expand Down Expand Up @@ -473,19 +488,25 @@ impl observe::MetricsIntercept for PrometheusClientInterceptor {
}

#[derive(Clone, Debug, PartialEq, Eq, Hash)]
struct OperationLabels(observe::MetricLabels);
struct OperationLabels {
labels: observe::MetricLabels,
enable_high_cardinality_labels: bool,
}

impl EncodeLabelSet for OperationLabels {
fn encode(&self, mut encoder: LabelSetEncoder) -> Result<(), fmt::Error> {
(observe::LABEL_SCHEME, self.0.scheme.into_static()).encode(encoder.encode_label())?;
(observe::LABEL_NAMESPACE, self.0.namespace.as_ref()).encode(encoder.encode_label())?;
(observe::LABEL_ROOT, self.0.root.as_ref()).encode(encoder.encode_label())?;
(observe::LABEL_OPERATION, self.0.operation).encode(encoder.encode_label())?;
(observe::LABEL_SCHEME, self.labels.scheme.into_static()).encode(encoder.encode_label())?;
(observe::LABEL_NAMESPACE, self.labels.namespace.as_ref())
.encode(encoder.encode_label())?;
if self.enable_high_cardinality_labels {
(observe::LABEL_ROOT, self.labels.root.as_ref()).encode(encoder.encode_label())?;
}
(observe::LABEL_OPERATION, self.labels.operation).encode(encoder.encode_label())?;

if let Some(error) = &self.0.error {
if let Some(error) = &self.labels.error {
(observe::LABEL_ERROR, error.into_static()).encode(encoder.encode_label())?;
}
if let Some(code) = &self.0.status_code {
if let Some(code) = &self.labels.status_code {
(observe::LABEL_STATUS_CODE, code.as_str()).encode(encoder.encode_label())?;
}
Ok(())
Expand Down
Loading