feat(prometheus): support disabling labels and metrics to reduce cardinality#13202
Open
janiussyafiq wants to merge 8 commits intoapache:masterfrom
Open
feat(prometheus): support disabling labels and metrics to reduce cardinality#13202janiussyafiq wants to merge 8 commits intoapache:masterfrom
janiussyafiq wants to merge 8 commits intoapache:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a new per-metric configuration option to the Prometheus plugin's
plugin_attr:disable_labels: A list of built-in label names whose values will be collapsed to an empty string""for a given metric, reducing cardinality without changing the metric schema.This is a non-breaking change — all labels remain registered and present in the output, so existing Prometheus dashboards and recording rules are unaffected. Only the label values of the specified labels are zeroed out.
An alternative approach of
disable: true(removing a metric entirely from/metrics) was considered but excluded from this PR as it is a breaking change — it would cause dashboards to show "No data", misfireabsent()alerts, and break recording rules. Instead, the same effect of suppressing all label cardinality on a metric can be achieved by listing all its labels underdisable_labels, which keeps the metric present in the output with empty-string values while remaining fully non-breaking.Configured under
plugin_attr.prometheus.metrics.<metric_name>alongside the existingexpireandextra_labelsfields.Example config:
With the above config,
nodeandconsumerwill appear asnode="",consumer=""in the metric output instead of carrying real values, effectively collapsing all time series that differ only by those labels.This addresses high-cardinality issues in dynamic environments (e.g. Kubernetes autoscaling where pod IPs churn rapidly), which can cause Prometheus shared dict overflow and excessive memory consumption.
Which issue(s) this PR fixes:
Fixes #12679
Checklist