Skip to content

Commit e8dbbd3

Browse files
gotjoshjtlisi
authored andcommitted
[Querier] Deprecate -querier.compress-http-responses-deprecated (#3544)
* [Querier] Deprecate `-querier.compress-http-responses` In favour of `-api.response-compression-enabled` which apply to every other API endpoint we register. Signed-off-by: gotjosh <[email protected]> * 1.8 since we're cutting 1.6 when this goes out Signed-off-by: gotjosh <[email protected]>
1 parent 1b2b989 commit e8dbbd3

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
## 1.6.0-rc.0
66

7+
* [CHANGE] Query Frontend: deprecate `-querier.compress-http-responses` in favour of `-api.response-compression-enabled`. #3544
78
* [CHANGE] Querier: deprecated `-store.max-look-back-period`. You should use `-querier.max-query-lookback` instead. #3452
89
* [CHANGE] Blocks storage: increased `-blocks-storage.bucket-store.chunks-cache.attributes-ttl` default from `24h` to `168h` (1 week). #3528
910
* [CHANGE] Blocks storage: the config option `-blocks-storage.bucket-store.index-cache.postings-compression-enabled` has been deprecated and postings compression is always enabled. #3538

docs/configuration/config-file-reference.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -967,7 +967,8 @@ grpc_client_config:
967967
# CLI flag: -frontend.instance-interface-names
968968
[instance_interface_names: <list of string> | default = [eth0 en0]]
969969
970-
# Compress HTTP responses.
970+
# This flag is about to be deprecated. Please use
971+
# -api.response-compression-enabled instead.
971972
# CLI flag: -querier.compress-http-responses
972973
[compress_responses: <boolean> | default = false]
973974

pkg/frontend/config.go

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,20 @@ type CombinedFrontendConfig struct {
2020
FrontendV1 v1.Config `yaml:",inline"`
2121
FrontendV2 v2.Config `yaml:",inline"`
2222

23-
CompressResponses bool `yaml:"compress_responses"`
24-
DownstreamURL string `yaml:"downstream_url"`
23+
// Deprecated. Replaced with pkg/api/Config.ResponseCompression field.
24+
// TODO: To be removed in Cortex 1.8.
25+
CompressResponses bool `yaml:"compress_responses"`
26+
27+
DownstreamURL string `yaml:"downstream_url"`
2528
}
2629

2730
func (cfg *CombinedFrontendConfig) RegisterFlags(f *flag.FlagSet) {
2831
cfg.Handler.RegisterFlags(f)
2932
cfg.FrontendV1.RegisterFlags(f)
3033
cfg.FrontendV2.RegisterFlags(f)
3134

32-
f.BoolVar(&cfg.CompressResponses, "querier.compress-http-responses", false, "Compress HTTP responses.")
35+
f.BoolVar(&cfg.CompressResponses, "querier.compress-http-responses", false, "This flag is about to be deprecated. Please use -api.response-compression-enabled instead.")
36+
3337
f.StringVar(&cfg.DownstreamURL, "frontend.downstream-url", "", "URL of downstream Prometheus.")
3438
}
3539

0 commit comments

Comments
 (0)