[exporter/prometheusremotewrite] disallow setting compression type other than snappy #38371
+41
−1
Conversation
This file contains 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
ArthurSens
reviewed
Mar 11, 2025
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: | | ||
| This change ensures that, only snappy compression type can be set as it's required by the Prometheus Remote Write protocol. |
There was a problem hiding this comment.
Suggested change
| This change ensures that, only snappy compression type can be set as it's required by the Prometheus Remote Write protocol. | |
| This change ensures that only the snappy compression type can be set, as required by the Prometheus Remote Write protocol. |
| @@ -124,5 +124,9 @@ func (cfg *Config) Validate() error { | |||
| cfg.MaxBatchSizeBytes = 3000000 | |||
| } | |||
|
|
|||
| if len(cfg.ClientConfig.Compression) > 0 && cfg.ClientConfig.Compression != "snappy" { | |||
There was a problem hiding this comment.
CompressionType is a string[1], there's no need to check for length :)
Suggested change
| if len(cfg.ClientConfig.Compression) > 0 && cfg.ClientConfig.Compression != "snappy" { | |
| if cfg.ClientConfig.Compression != "snappy" { |
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.
The Prometheus Remote Write exporter only supports
snappycompression type as it's required by the remote write protocol.Description
This PR prevents users from accidentally setting the compression type other than
snappyand notifying them.Link to tracking issue
Fixes #37232
Testing
Documentation