Add native histogram max sample size limit validation #6834
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
PaurushGarg
changed the title
harry671003
approved these changes
Jun 20, 2025
pkg/util/validation/limits.go
Outdated
| MaxLabelValueLength int `yaml:"max_label_value_length" json:"max_label_value_length"` | ||
| MaxLabelNamesPerSeries int `yaml:"max_label_names_per_series" json:"max_label_names_per_series"` | ||
| MaxLabelsSizeBytes int `yaml:"max_labels_size_bytes" json:"max_labels_size_bytes"` | ||
| MaxNativeHistogramsSampleSizeBytes int `yaml:"max_native_histograms_sample_size_bytes" json:"max_native_histograms_sample_size_bytes"` |
There was a problem hiding this comment.
nit: MaxNativeHistogramSampleSizeBytes
This is for a single sample. Not like the labels limit which is for all the labels.
There was a problem hiding this comment.
Thanks. Updated.
yeya24
approved these changes
Jun 21, 2025
pkg/util/validation/errors.go
Outdated
| @@ -262,6 +262,26 @@ func (e *nativeHistogramSchemaInvalidError) Error() string { | |||
| return fmt.Sprintf("invalid native histogram schema %d for metric: %.200q. supported schema from %d to %d", e.receivedSchema, formatLabelSet(e.series), histogram.ExponentialSchemaMin, histogram.ExponentialSchemaMax) | |||
| } | |||
|
|
|||
| // nativeHistogramSchemaInvalidError is a ValidationError implementation for samples with native histogram | |||
| // exceeding the valid schema range. | |||
There was a problem hiding this comment.
Need to update the comment. Not nativeHistogramSchemaInvalidError
There was a problem hiding this comment.
Thanks. Updated.
pkg/util/validation/validate.go
Outdated
| @@ -339,6 +340,13 @@ func ValidateMetadata(validateMetrics *ValidateMetrics, cfg *Limits, userID stri | |||
|
|
|||
| func ValidateNativeHistogram(validateMetrics *ValidateMetrics, limits *Limits, userID string, ls []cortexpb.LabelAdapter, histogramSample cortexpb.Histogram) (cortexpb.Histogram, error) { | |||
|
|
|||
| // sample size validation for native histogram | |||
| nhSampleSize := histogramSample.Size() | |||
There was a problem hiding this comment.
Nit: we can only calculate the sample size if the limit is > 0.
There was a problem hiding this comment.
Thanks. Updated.
PaurushGarg
changed the title
Signed-off-by: Paurush Garg <[email protected]>
PaurushGarg
force-pushed
the
native-histograms-sample-size-limit
branch
from
ec63c2b to
e33587b
Compare
Signed-off-by: Paurush Garg <[email protected]>
yeya24
approved these changes
Jun 24, 2025
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.
What this PR does:
Add native histogram max sample size bytes limit validation.
This is added b/c native histogram can have infinite buckets for a given schema increasing the size of a nh sample. Size of a NH sample can also grow due to other factors like Spans. Although max_bucket_count limit reduces resolution of NH samples, but this limit is added to discard samples if the sample size is excessive and can load Distributors.
This limit is not added as per-user override.
Which issue(s) this PR fixes:
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]