Skip to content

Commit

Permalink
Drop Snappy compatibility mode
Browse files Browse the repository at this point in the history
Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
  • Loading branch information
aknuds1 committed Sep 25, 2024
1 parent 450e8df commit c9a3d50
Show file tree
Hide file tree
Showing 12 changed files with 38 additions and 48 deletions.
18 changes: 9 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@
* [FEATURE] Query frontend: added new query pruning middleware to enable pruning dead code (eg. expressions that cannot produce any results) and simplifying expressions (eg. expressions that can be evaluated immediately) in queries. #9086
* [FEATURE] Ruler: added experimental configuration, `-ruler.rule-evaluation-write-enabled`, to disable writing the result of rule evaluation to ingesters. This feature can be used for testing purposes. #9060
* [FEATURE] Ingester: added experimental configuration `ingester.ignore-ooo-exemplars`. When set to `true` out of order exemplars are no longer reported to the remote write client. #9151
* [FEATURE] gRPC: Add flags for using respectively S2 or Snappy compatible S2 gRPC compression. #9322
* `-alertmanager.alertmanager-client.grpc-compression`
* `-ingester.client.grpc-compression`
* `-querier.frontend-client.grpc-compression`
* `-querier.scheduler-client.grpc-compression`
* `-query-frontend.grpc-client-config.grpc-compression`
* `-query-scheduler.grpc-client-config.grpc-compression`
* `-ruler.client.grpc-compression`
* `-ruler.query-frontend.grpc-client-config.grpc-compression`
* [FEATURE] gRPC: Add flags for using S2 compression. #9322
* `-alertmanager.alertmanager-client.grpc-compression=s2`
* `-ingester.client.grpc-compression=s2`
* `-querier.frontend-client.grpc-compression=s2`
* `-querier.scheduler-client.grpc-compression=s2`
* `-query-frontend.grpc-client-config.grpc-compression=s2`
* `-query-scheduler.grpc-client-config.grpc-compression=s2`
* `-ruler.client.grpc-compression=s2`
* `-ruler.query-frontend.grpc-client-config.grpc-compression=s2`
* [ENHANCEMENT] Compactor: Add `cortex_compactor_compaction_job_duration_seconds` and `cortex_compactor_compaction_job_blocks` histogram metrics to track duration of individual compaction jobs and number of blocks per job. #8371
* [ENHANCEMENT] Rules: Added per namespace max rules per rule group limit. The maximum number of rules per rule groups for all namespaces continues to be configured by `-ruler.max-rules-per-rule-group`, but now, this can be superseded by the new `-ruler.max-rules-per-rule-group-by-namespace` option on a per namespace basis. This new limit can be overridden using the overrides mechanism to be applied per-tenant. #8378
* [ENHANCEMENT] Rules: Added per namespace max rule groups per tenant limit. The maximum number of rule groups per rule tenant for all namespaces continues to be configured by `-ruler.max-rule-groups-per-tenant`, but now, this can be superseded by the new `-ruler.max-rule-groups-per-tenant-by-namespace` option on a per namespace basis. This new limit can be overridden using the overrides mechanism to be applied per-tenant. #8425
Expand Down
16 changes: 8 additions & 8 deletions cmd/mimir/config-descriptor.json
Original file line number Diff line number Diff line change
Expand Up @@ -2101,7 +2101,7 @@
"kind": "field",
"name": "grpc_compression",
"required": false,
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)",
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "ingester.client.grpc-compression",
Expand Down Expand Up @@ -4838,7 +4838,7 @@
"kind": "field",
"name": "grpc_compression",
"required": false,
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)",
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "querier.frontend-client.grpc-compression",
Expand Down Expand Up @@ -5100,7 +5100,7 @@
"kind": "field",
"name": "grpc_compression",
"required": false,
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)",
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "querier.scheduler-client.grpc-compression",
Expand Down Expand Up @@ -5491,7 +5491,7 @@
"kind": "field",
"name": "grpc_compression",
"required": false,
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)",
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "query-frontend.grpc-client-config.grpc-compression",
Expand Down Expand Up @@ -11455,7 +11455,7 @@
"kind": "field",
"name": "grpc_compression",
"required": false,
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)",
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "ruler.client.grpc-compression",
Expand Down Expand Up @@ -12420,7 +12420,7 @@
"kind": "field",
"name": "grpc_compression",
"required": false,
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)",
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "ruler.query-frontend.grpc-client-config.grpc-compression",
Expand Down Expand Up @@ -14677,7 +14677,7 @@
"kind": "field",
"name": "grpc_compression",
"required": false,
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)",
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "alertmanager.alertmanager-client.grpc-compression",
Expand Down Expand Up @@ -16254,7 +16254,7 @@
"kind": "field",
"name": "grpc_compression",
"required": false,
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)",
"desc": "Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "query-scheduler.grpc-client-config.grpc-compression",
Expand Down
16 changes: 8 additions & 8 deletions cmd/mimir/help-all.txt.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Usage of ./cmd/mimir/mimir:
-alertmanager.alertmanager-client.grpc-client-rate-limit-burst int
Rate limit burst for gRPC client.
-alertmanager.alertmanager-client.grpc-compression string
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)
-alertmanager.alertmanager-client.grpc-max-recv-msg-size int
gRPC client max receive message size (bytes). (default 104857600)
-alertmanager.alertmanager-client.grpc-max-send-msg-size int
Expand Down Expand Up @@ -1414,7 +1414,7 @@ Usage of ./cmd/mimir/mimir:
-ingester.client.grpc-client-rate-limit-burst int
Rate limit burst for gRPC client.
-ingester.client.grpc-compression string
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)
-ingester.client.grpc-max-recv-msg-size int
gRPC client max receive message size (bytes). (default 104857600)
-ingester.client.grpc-max-send-msg-size int
Expand Down Expand Up @@ -1868,7 +1868,7 @@ Usage of ./cmd/mimir/mimir:
-querier.frontend-client.grpc-client-rate-limit-burst int
Rate limit burst for gRPC client.
-querier.frontend-client.grpc-compression string
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)
-querier.frontend-client.grpc-max-recv-msg-size int
gRPC client max receive message size (bytes). (default 104857600)
-querier.frontend-client.grpc-max-send-msg-size int
Expand Down Expand Up @@ -1972,7 +1972,7 @@ Usage of ./cmd/mimir/mimir:
-querier.scheduler-client.grpc-client-rate-limit-burst int
Rate limit burst for gRPC client.
-querier.scheduler-client.grpc-compression string
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)
-querier.scheduler-client.grpc-max-recv-msg-size int
gRPC client max receive message size (bytes). (default 104857600)
-querier.scheduler-client.grpc-max-send-msg-size int
Expand Down Expand Up @@ -2050,7 +2050,7 @@ Usage of ./cmd/mimir/mimir:
-query-frontend.grpc-client-config.grpc-client-rate-limit-burst int
Rate limit burst for gRPC client.
-query-frontend.grpc-client-config.grpc-compression string
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)
-query-frontend.grpc-client-config.grpc-max-recv-msg-size int
gRPC client max receive message size (bytes). (default 104857600)
-query-frontend.grpc-client-config.grpc-max-send-msg-size int
Expand Down Expand Up @@ -2256,7 +2256,7 @@ Usage of ./cmd/mimir/mimir:
-query-scheduler.grpc-client-config.grpc-client-rate-limit-burst int
Rate limit burst for gRPC client.
-query-scheduler.grpc-client-config.grpc-compression string
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)
-query-scheduler.grpc-client-config.grpc-max-recv-msg-size int
gRPC client max receive message size (bytes). (default 104857600)
-query-scheduler.grpc-client-config.grpc-max-send-msg-size int
Expand Down Expand Up @@ -2628,7 +2628,7 @@ Usage of ./cmd/mimir/mimir:
-ruler.client.grpc-client-rate-limit-burst int
Rate limit burst for gRPC client.
-ruler.client.grpc-compression string
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)
-ruler.client.grpc-max-recv-msg-size int
gRPC client max receive message size (bytes). (default 104857600)
-ruler.client.grpc-max-send-msg-size int
Expand Down Expand Up @@ -2716,7 +2716,7 @@ Usage of ./cmd/mimir/mimir:
-ruler.query-frontend.grpc-client-config.grpc-client-rate-limit-burst int
Rate limit burst for gRPC client.
-ruler.query-frontend.grpc-client-config.grpc-compression string
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
Use compression when sending messages. Supported values are: 'gzip', 'snappy', 's2' and '' (disable compression)
-ruler.query-frontend.grpc-client-config.grpc-max-recv-msg-size int
gRPC client max receive message size (bytes). (default 104857600)
-ruler.query-frontend.grpc-client-config.grpc-max-send-msg-size int
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2337,7 +2337,7 @@ alertmanager_client:
[max_send_msg_size: <int> | default = 104857600]
# (advanced) Use compression when sending messages. Supported values are:
# 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
# 'gzip', 'snappy', 's2' and '' (disable compression)
# CLI flag: -alertmanager.alertmanager-client.grpc-compression
[grpc_compression: <string> | default = ""]
Expand Down Expand Up @@ -2600,7 +2600,7 @@ The `grpc_client` block configures the gRPC client used to communicate between t
[max_send_msg_size: <int> | default = 104857600]
# (advanced) Use compression when sending messages. Supported values are:
# 'gzip', 'snappy', 's2', 's2-snappy' and '' (disable compression)
# 'gzip', 'snappy', 's2' and '' (disable compression)
# CLI flag: -<prefix>.grpc-compression
[grpc_compression: <string> | default = ""]
Expand Down
2 changes: 1 addition & 1 deletion pkg/alertmanager/alertmanager_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ type ClientConfig struct {

// RegisterFlagsWithPrefix registers flags with prefix.
func (cfg *ClientConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
cfg.GRPCClientConfig.CustomCompressors = []string{s2.Name, s2.SnappyCompatName}
cfg.GRPCClientConfig.CustomCompressors = []string{s2.Name}
cfg.GRPCClientConfig.RegisterFlagsWithPrefix(prefix, f)
f.DurationVar(&cfg.RemoteTimeout, prefix+".remote-timeout", 2*time.Second, "Timeout for downstream alertmanagers.")
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/frontend/v2/frontend.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet, logger log.Logger) {
f.StringVar(&cfg.Addr, "query-frontend.instance-addr", "", "IP address to advertise to the querier (via scheduler) (default is auto-detected from network interfaces).")
f.IntVar(&cfg.Port, "query-frontend.instance-port", 0, "Port to advertise to querier (via scheduler) (defaults to server.grpc-listen-port).")

cfg.GRPCClientConfig.CustomCompressors = []string{s2.Name, s2.SnappyCompatName}
cfg.GRPCClientConfig.CustomCompressors = []string{s2.Name}
cfg.GRPCClientConfig.RegisterFlagsWithPrefix("query-frontend.grpc-client-config", f)
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/ingester/client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ type Config struct {

// RegisterFlags registers configuration settings used by the ingester client config.
func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
cfg.GRPCClientConfig.CustomCompressors = []string{s2.Name, s2.SnappyCompatName}
cfg.GRPCClientConfig.CustomCompressors = []string{s2.Name}
cfg.GRPCClientConfig.RegisterFlagsWithPrefix("ingester.client", f)
}

Expand Down
4 changes: 2 additions & 2 deletions pkg/querier/worker/worker.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
f.StringVar(&cfg.QuerierID, "querier.id", "", "Querier ID, sent to the query-frontend to identify requests from the same querier. Defaults to hostname.")
f.BoolVar(&cfg.ResponseStreamingEnabled, "querier.response-streaming-enabled", false, "Enables streaming of responses from querier to query-frontend for response types that support it (currently only `active_series` responses do).")

cfg.QueryFrontendGRPCClientConfig.CustomCompressors = []string{s2.Name, s2.SnappyCompatName}
cfg.QueryFrontendGRPCClientConfig.CustomCompressors = []string{s2.Name}
cfg.QueryFrontendGRPCClientConfig.RegisterFlagsWithPrefix("querier.frontend-client", f)
cfg.QuerySchedulerGRPCClientConfig.CustomCompressors = []string{s2.Name, s2.SnappyCompatName}
cfg.QuerySchedulerGRPCClientConfig.CustomCompressors = []string{s2.Name}
cfg.QuerySchedulerGRPCClientConfig.RegisterFlagsWithPrefix("querier.scheduler-client", f)
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/ruler/remotequerier.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ func (c *QueryFrontendConfig) RegisterFlags(f *flag.FlagSet) {
"GRPC listen address of the query-frontend(s). Must be a DNS address (prefixed with dns:///) "+
"to enable client side load balancing.")

c.GRPCClientConfig.CustomCompressors = []string{s2.Name, s2.SnappyCompatName}
c.GRPCClientConfig.CustomCompressors = []string{s2.Name}
c.GRPCClientConfig.RegisterFlagsWithPrefix("ruler.query-frontend.grpc-client-config", f)

f.StringVar(&c.QueryResultResponseFormat, "ruler.query-frontend.query-result-response-format", formatProtobuf, fmt.Sprintf("Format to use when retrieving query results from query-frontends. Supported values: %s", strings.Join(allFormats, ", ")))
Expand Down
2 changes: 1 addition & 1 deletion pkg/ruler/ruler.go
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ func (cfg *Config) Validate(limits validation.Limits) error {

// RegisterFlags adds the flags required to config this to the given FlagSet
func (cfg *Config) RegisterFlags(f *flag.FlagSet, logger log.Logger) {
cfg.ClientTLSConfig.CustomCompressors = []string{s2.Name, s2.SnappyCompatName}
cfg.ClientTLSConfig.CustomCompressors = []string{s2.Name}
cfg.ClientTLSConfig.RegisterFlagsWithPrefix("ruler.client", f)
cfg.Ring.RegisterFlags(f, logger)
cfg.Notifier.RegisterFlags(f)
Expand Down
2 changes: 1 addition & 1 deletion pkg/scheduler/scheduler.go
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet, logger log.Logger) {
f.BoolVar(&cfg.PrioritizeQueryComponents, "query-scheduler.prioritize-query-components", false, "When enabled, the query scheduler primarily prioritizes dequeuing fairly from queue components and secondarily prioritizes dequeuing fairly across tenants. When disabled, the query scheduler primarily prioritizes tenant fairness. You must enable the `query-scheduler.use-multi-algorithm-query-queue` setting to use this flag.")
f.DurationVar(&cfg.QuerierForgetDelay, "query-scheduler.querier-forget-delay", 0, "If a querier disconnects without sending notification about graceful shutdown, the query-scheduler will keep the querier in the tenant's shard until the forget delay has passed. This feature is useful to reduce the blast radius when shuffle-sharding is enabled.")

cfg.GRPCClientConfig.CustomCompressors = []string{s2.Name, s2.SnappyCompatName}
cfg.GRPCClientConfig.CustomCompressors = []string{s2.Name}
cfg.GRPCClientConfig.RegisterFlagsWithPrefix("query-scheduler.grpc-client-config", f)
cfg.ServiceDiscovery.RegisterFlags(f, logger)
}
Expand Down
16 changes: 3 additions & 13 deletions pkg/util/grpcencoding/s2/s2.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ import (
const (
// Name is the name of the S2 compressor.
Name = "s2"
// SnappyCompatName is the name of the Snappy compatible S2 compressor.
SnappyCompatName = "s2-snappy"
)

type compressor struct {
Expand All @@ -40,21 +38,13 @@ type reader struct {
}

func init() {
encoding.RegisterCompressor(newCompressor(false))
encoding.RegisterCompressor(newCompressor(true))
encoding.RegisterCompressor(newCompressor())
}

func newCompressor(snappyCompat bool) *compressor {
func newCompressor() *compressor {
opts := []s2.WriterOption{s2.WriterConcurrency(1)}
var name string
if snappyCompat {
opts = append(opts, s2.WriterSnappyCompat())
name = SnappyCompatName
} else {
name = Name
}
c := &compressor{
name: name,
name: Name,
}
c.poolCompressor.New = func() interface{} {
w := s2.NewWriter(io.Discard, opts...)
Expand Down

0 comments on commit c9a3d50

Please sign in to comment.