metric(aggmetric): introduce options for high cardinality metrics #156712
+868
−31
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
Member
|
This change is |
aa-joshi
force-pushed
the
CRDB_54635_make_hcm_metrics_configurable
branch
from
ccd6ce8 to
cea5c59
Compare
aa-joshi
requested review from
Abhinav1299,
arjunmahishi and
dhartunian
and removed request for
a team
Previously, we have introduced high cardinality metrics. This patch introduces
`HighCardinalityMetricOptions` to support user defined configurations. It has
below fields:
- Metadata: Metadata represents the metadata associated with metrics.
- MaxLabelValues (default: 5000): MaxLabelValues sets the maximum
number of distinct label value combinations that can be stored before
eviction.
- RetentionTimeTillEviction (default: 20 seconds): specifies the time
duration after which unused label value combinations can be evicted.
Entries that haven't been accessed for longer than this duration may
be evicted.
A label value is removed when number of label values are greater than
MaxLabelValues and it has passed the RetentionTimeTillEviction.
This commit also introduces 2 environment variables:
- COCKROACH_HIGH_CARDINALITY_METRICS_MAX_LABEL_VALUES (default:0): The
maximum value of the variable and `MaxLabelValues` is used during
initialisation for max label combinations.
- COCKROACH_HIGH_CARDINALITY_METRICS_RETENTION_TIME_TILL_EVICTION
(default:10): The maximum value of the variable and
`RetentionTimeTillEviction` is used during initialisation for max
retention of a label.
Epic: CRDB-53398
Part of: CRDB-54635
Release notes: None
aa-joshi
force-pushed
the
CRDB_54635_make_hcm_metrics_configurable
branch
from
cea5c59 to
cfba6ea
Compare
Abhinav1299
reviewed
Nov 21, 2025
pkg/util/metric/aggmetric/testdata/HighCardinalityMetrics_custom_options_post_eviction.txt
Show resolved
Hide resolved
aa-joshi
commented
Nov 24, 2025
Contributor
Author
aa-joshi
left a comment
aa-joshi
left a comment
There was a problem hiding this comment.
Reviewable status:
complete! 0 of 0 LGTMs obtained (waiting on @Abhinav1299, @arjunmahishi, and @dhartunian)
pkg/util/metric/aggmetric/testdata/HighCardinalityMetrics_custom_options_post_eviction.txt
Show resolved
Hide resolved
Contributor
Author
|
TFTR! |
Contributor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Previously, we have introduced high cardinality metrics. This patch introduces
HighCardinalityMetricOptionsto support user defined configurations. It has below fields:- Metadata: Metadata represents the metadata associated with metrics.
- MaxLabelValues (default: 5000): MaxLabelValues sets the maximum number of distinct label value combinations that can be stored before eviction.
- RetentionTimeTillEviction (default: 20 seconds): specifies the time duration after which unused label value combinations can be evicted. Entries that haven't been accessed for longer than this duration may be evicted.
A label value is removed when number of label values are greater than MaxLabelValues and it has passed the RetentionTimeTillEviction.
This commit also introduces 2 environment variables:
- COCKROACH_HIGH_CARDINALITY_METRICS_MAX_LABEL_VALUES (default:0): The maximum value of the variable and
MaxLabelValuesis used during initialisation for max label combinations.- COCKROACH_HIGH_CARDINALITY_METRICS_RETENTION_TIME_TILL_EVICTION (default:10): The maximum value of the variable and
RetentionTimeTillEvictionis used during initialisation for max retention of a label value.Epic: CRDB-53398
Part of: CRDB-54635
Release notes: None