Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ingester: mark spread-minimizing tokens-related CLI flags as advanced #7169

Merged
merged 1 commit into from
Jan 19, 2024
Merged

Ingester: mark spread-minimizing tokens-related CLI flags as advanced #7169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
* [CHANGE] Distributor: report gRPC status codes as `status_code` labels in the `cortex_ingester_client_request_duration_seconds` metric by default. #7144
* [CHANGE] Distributor: CLI flag `-ingester.client.report-grpc-codes-in-instrumentation-label-enabled` has been deprecated, and its default value is set to `true`. #7144
* [CHANGE] Ingester: CLI flag `-ingester.return-only-grpc-errors` has been deprecated, and its default value is set to `true`. To ensure backwards compatibility, during a migration from a version prior to 2.11.0 to 2.12 or later, `-ingester.return-only-grpc-errors` should be set to `false`. Once all the components are migrated, the flag can be removed. #7151
* [CHANGE] Ingester: the following CLI flags have been moved from "experimental" to "advanced": #7169
* `-ingester.ring.token-generation-strategy`
* `-ingester.ring.spread-minimizing-zones`
* `-ingester.ring.spread-minimizing-join-ring-in-order`
* [FEATURE] Introduce `-tenant-federation.max-tenants` option to limit the max number of tenants allowed for requests when federation is enabled. #6959
* [FEATURE] Cardinality API: added a new `count_method` parameter which enables counting active label values. #7085
* [FEATURE] Querier / query-frontend: added `-querier.promql-experimental-functions-enabled` CLI flag (and respective YAML config option) to enable experimental PromQL functions. The experimental functions introduced are: `mad_over_time()`, `sort_by_label()` and `sort_by_label_desc()`. #7057
Expand Down
6 changes: 3 additions & 3 deletions cmd/mimir/config-descriptor.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2807,7 +2807,7 @@
"fieldDefaultValue": "random",
"fieldFlag": "ingester.ring.token-generation-strategy",
"fieldType": "string",
"fieldCategory": "experimental"
"fieldCategory": "advanced"
},
{
"kind": "field",
Expand All @@ -2818,7 +2818,7 @@
"fieldDefaultValue": false,
"fieldFlag": "ingester.ring.spread-minimizing-join-ring-in-order",
"fieldType": "boolean",
"fieldCategory": "experimental"
"fieldCategory": "advanced"
},
{
"kind": "field",
Expand All @@ -2829,7 +2829,7 @@
"fieldDefaultValue": "",
"fieldFlag": "ingester.ring.spread-minimizing-zones",
"fieldType": "string",
"fieldCategory": "experimental"
"fieldCategory": "advanced"
}
],
"fieldValue": null,
Expand Down
6 changes: 3 additions & 3 deletions cmd/mimir/help-all.txt.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1442,13 +1442,13 @@ Usage of ./cmd/mimir/mimir:
-ingester.ring.replication-factor int
Number of ingesters that each time series is replicated to. This option needs be set on ingesters, distributors, queriers and rulers when running in microservices mode. (default 3)
-ingester.ring.spread-minimizing-join-ring-in-order
[experimental] True to allow this ingester registering tokens in the ring only after all previous ingesters (with ID lower than the current one) have already been registered. This configuration option is supported only when the token generation strategy is set to "spread-minimizing".
True to allow this ingester registering tokens in the ring only after all previous ingesters (with ID lower than the current one) have already been registered. This configuration option is supported only when the token generation strategy is set to "spread-minimizing".
-ingester.ring.spread-minimizing-zones comma-separated-list-of-strings
[experimental] Comma-separated list of zones in which spread minimizing strategy is used for token generation. This value must include all zones in which ingesters are deployed, and must not change over time. This configuration is used only when "token-generation-strategy" is set to "spread-minimizing".
Comma-separated list of zones in which spread minimizing strategy is used for token generation. This value must include all zones in which ingesters are deployed, and must not change over time. This configuration is used only when "token-generation-strategy" is set to "spread-minimizing".
-ingester.ring.store string
Backend storage to use for the ring. Supported values are: consul, etcd, inmemory, memberlist, multi. (default "memberlist")
-ingester.ring.token-generation-strategy string
[experimental] Specifies the strategy used for generating tokens for ingesters. Supported values are: random,spread-minimizing. (default "random")
Specifies the strategy used for generating tokens for ingesters. Supported values are: random,spread-minimizing. (default "random")
-ingester.ring.tokens-file-path string
File path where tokens are stored. If empty, tokens are not stored at shutdown and restored at startup. Must be empty if -ingester.ring.token-generation-strategy is set to "spread-minimizing".
-ingester.ring.unregister-on-shutdown
Expand Down
4 changes: 0 additions & 4 deletions docs/sources/mimir/configure/about-versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,6 @@ The following features are currently experimental:
- Early TSDB Head compaction to reduce in-memory series:
- `-blocks-storage.tsdb.early-head-compaction-min-in-memory-series`
- `-blocks-storage.tsdb.early-head-compaction-min-estimated-series-reduction-percentage`
- Spread minimizing token generation strategy:
- `ingester.ring.token-generation-strategy`
- `ingester.ring.spread-minimizing-zones`
- `ingester.ring.spread-minimizing-join-ring-in-order`
- Ingester client
- Per-ingester circuit breaking based on requests timing out or hitting per-instance limits
- `-ingester.client.circuit-breaker.enabled`
Expand Down
17 changes: 8 additions & 9 deletions docs/sources/mimir/configure/configuration-parameters/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1069,23 +1069,22 @@ ring:
# CLI flag: -ingester.ring.final-sleep
[final_sleep: <duration> | default = 0s]

# (experimental) Specifies the strategy used for generating tokens for
# ingesters. Supported values are: random,spread-minimizing.
# (advanced) Specifies the strategy used for generating tokens for ingesters.
# Supported values are: random,spread-minimizing.
# CLI flag: -ingester.ring.token-generation-strategy
[token_generation_strategy: <string> | default = "random"]

# (experimental) True to allow this ingester registering tokens in the ring
# only after all previous ingesters (with ID lower than the current one) have
# (advanced) True to allow this ingester registering tokens in the ring only
# after all previous ingesters (with ID lower than the current one) have
# already been registered. This configuration option is supported only when
# the token generation strategy is set to "spread-minimizing".
# CLI flag: -ingester.ring.spread-minimizing-join-ring-in-order
[spread_minimizing_join_ring_in_order: <boolean> | default = false]

# (experimental) Comma-separated list of zones in which spread minimizing
# strategy is used for token generation. This value must include all zones in
# which ingesters are deployed, and must not change over time. This
# configuration is used only when "token-generation-strategy" is set to
# "spread-minimizing".
# (advanced) Comma-separated list of zones in which spread minimizing strategy
# is used for token generation. This value must include all zones in which
# ingesters are deployed, and must not change over time. This configuration is
# used only when "token-generation-strategy" is set to "spread-minimizing".
# CLI flag: -ingester.ring.spread-minimizing-zones
[spread_minimizing_zones: <string> | default = ""]

Expand Down
6 changes: 3 additions & 3 deletions pkg/ingester/ingester_ring.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ type RingConfig struct {
MinReadyDuration time.Duration `yaml:"min_ready_duration" category:"advanced"`
FinalSleep time.Duration `yaml:"final_sleep" category:"advanced"`

TokenGenerationStrategy string `yaml:"token_generation_strategy" category:"experimental"`
SpreadMinimizingJoinRingInOrder bool `yaml:"spread_minimizing_join_ring_in_order" category:"experimental"`
SpreadMinimizingZones flagext.StringSliceCSV `yaml:"spread_minimizing_zones" category:"experimental"`
TokenGenerationStrategy string `yaml:"token_generation_strategy" category:"advanced"`
SpreadMinimizingJoinRingInOrder bool `yaml:"spread_minimizing_join_ring_in_order" category:"advanced"`
SpreadMinimizingZones flagext.StringSliceCSV `yaml:"spread_minimizing_zones" category:"advanced"`

// Injected internally
ListenPort int `yaml:"-"`
Expand Down
Loading