Skip to content

Commit 4ec4cee

Browse files
committed
doc
Signed-off-by: Alan Protasio <[email protected]>
1 parent 0ae15e5 commit 4ec4cee

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

docs/configuration/config-file-reference.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ query_scheduler:
198198
[max_send_msg_size: <int> | default = 16777216]
199199

200200
# Use compression when sending messages. Supported values are: 'gzip',
201-
# 'snappy', 'zstd' and '' (disable compression)
201+
# 'snappy', 'snappy-block' ,'zstd' and '' (disable compression)
202202
# CLI flag: -query-scheduler.grpc-client-config.grpc-compression
203203
[grpc_compression: <string> | default = ""]
204204

@@ -2381,7 +2381,7 @@ grpc_client_config:
23812381
[max_send_msg_size: <int> | default = 16777216]
23822382
23832383
# Use compression when sending messages. Supported values are: 'gzip',
2384-
# 'snappy', 'zstd' and '' (disable compression)
2384+
# 'snappy', 'snappy-block' ,'zstd' and '' (disable compression)
23852385
# CLI flag: -querier.frontend-client.grpc-compression
23862386
[grpc_compression: <string> | default = ""]
23872387
@@ -2642,7 +2642,7 @@ grpc_client_config:
26422642
[max_send_msg_size: <int> | default = 16777216]
26432643
26442644
# Use compression when sending messages. Supported values are: 'gzip',
2645-
# 'snappy', 'zstd' and '' (disable compression)
2645+
# 'snappy', 'snappy-block' ,'zstd' and '' (disable compression)
26462646
# CLI flag: -ingester.client.grpc-compression
26472647
[grpc_compression: <string> | default = ""]
26482648
@@ -3435,7 +3435,7 @@ grpc_client_config:
34353435
[max_send_msg_size: <int> | default = 16777216]
34363436
34373437
# Use compression when sending messages. Supported values are: 'gzip',
3438-
# 'snappy', 'zstd' and '' (disable compression)
3438+
# 'snappy', 'snappy-block' ,'zstd' and '' (disable compression)
34393439
# CLI flag: -frontend.grpc-client-config.grpc-compression
34403440
[grpc_compression: <string> | default = ""]
34413441
@@ -3651,7 +3651,7 @@ ruler_client:
36513651
[max_send_msg_size: <int> | default = 16777216]
36523652
36533653
# Use compression when sending messages. Supported values are: 'gzip',
3654-
# 'snappy', 'zstd' and '' (disable compression)
3654+
# 'snappy', 'snappy-block' ,'zstd' and '' (disable compression)
36553655
# CLI flag: -ruler.client.grpc-compression
36563656
[grpc_compression: <string> | default = ""]
36573657

pkg/util/grpcclient/grpcclient.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313

1414
"github.com/cortexproject/cortex/pkg/util/backoff"
1515
"github.com/cortexproject/cortex/pkg/util/grpcencoding/snappy"
16+
"github.com/cortexproject/cortex/pkg/util/grpcencoding/snappyblock"
1617
"github.com/cortexproject/cortex/pkg/util/grpcencoding/zstd"
1718
"github.com/cortexproject/cortex/pkg/util/tls"
1819
)
@@ -41,7 +42,7 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
4142
func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
4243
f.IntVar(&cfg.MaxRecvMsgSize, prefix+".grpc-max-recv-msg-size", 100<<20, "gRPC client max receive message size (bytes).")
4344
f.IntVar(&cfg.MaxSendMsgSize, prefix+".grpc-max-send-msg-size", 16<<20, "gRPC client max send message size (bytes).")
44-
f.StringVar(&cfg.GRPCCompression, prefix+".grpc-compression", "", "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 'zstd' and '' (disable compression)")
45+
f.StringVar(&cfg.GRPCCompression, prefix+".grpc-compression", "", "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 'snappy-block' ,'zstd' and '' (disable compression)")
4546
f.Float64Var(&cfg.RateLimit, prefix+".grpc-client-rate-limit", 0., "Rate limit for gRPC client; 0 means disabled.")
4647
f.IntVar(&cfg.RateLimitBurst, prefix+".grpc-client-rate-limit-burst", 0, "Rate limit burst for gRPC client.")
4748
f.BoolVar(&cfg.BackoffOnRatelimits, prefix+".backoff-on-ratelimits", false, "Enable backoff and retry when we hit ratelimits.")
@@ -54,7 +55,7 @@ func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
5455

5556
func (cfg *Config) Validate(log log.Logger) error {
5657
switch cfg.GRPCCompression {
57-
case gzip.Name, snappy.Name, zstd.Name, "":
58+
case gzip.Name, snappy.Name, zstd.Name, snappyblock.Name, "":
5859
// valid
5960
default:
6061
return errors.Errorf("unsupported compression type: %s", cfg.GRPCCompression)

0 commit comments

Comments
 (0)