Add prometheus label whitelisting #1981
Closed
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.
Prometheus best practices state
Do not use labels to store dimensions with high cardinality (many different label values), such as user IDs, email addresses, or other unbounded sets of values.
. We should encourage users to follow this by allowing label whitelisting. This is initially only for prometheus, but flags are intentionally non-specific to allow for other storage plugins to make use of this as well. The default behavior is unchanged, as--enforce_storage_label_whitelist
is disabled by default.This PR adds two new flags:
enforce_storage_label_whitelist
, which turns on the whitelisting, andlabel_whitelist
, which is the set of labels allowed.Related: #1730
The daemonset (#1979) makes use of these flags so prometheus-to-sd doesn't exceed its label limit.