Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chencs committed Aug 13, 2024
1 parent 6a42596 commit 7bc9422
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions cmd/mimir/config-descriptor.json
Original file line number Diff line number Diff line change
Expand Up @@ -5714,7 +5714,7 @@
"kind": "field",
"name": "additional_query_queue_dimensions_enabled",
"required": false,
"desc": "NO-OP: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)",
"desc": "Non-operational: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)",
"fieldValue": null,
"fieldDefaultValue": false,
"fieldFlag": "query-frontend.additional-query-queue-dimensions-enabled",
Expand Down Expand Up @@ -16004,7 +16004,7 @@
"kind": "field",
"name": "additional_query_queue_dimensions_enabled",
"required": false,
"desc": "NO-OP: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)",
"desc": "Non-operational: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)",
"fieldValue": null,
"fieldDefaultValue": false,
"fieldFlag": "query-scheduler.additional-query-queue-dimensions-enabled",
Expand Down
4 changes: 2 additions & 2 deletions cmd/mimir/help-all.txt.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -1990,7 +1990,7 @@ Usage of ./cmd/mimir/mimir:
-query-frontend.active-series-write-timeout duration
[experimental] Timeout for writing active series responses. 0 means the value from `-server.http-write-timeout` is used. (default 5m0s)
-query-frontend.additional-query-queue-dimensions-enabled
[experimental] NO-OP: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)
[experimental] Non-operational: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)
-query-frontend.align-queries-with-step
Mutate incoming queries to align their start and end with their step to improve result caching.
-query-frontend.cache-results
Expand Down Expand Up @@ -2204,7 +2204,7 @@ Usage of ./cmd/mimir/mimir:
-query-frontend.use-active-series-decoder
[experimental] Set to true to use the zero-allocation response decoder for active series queries.
-query-scheduler.additional-query-queue-dimensions-enabled
[experimental] NO-OP: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)
[experimental] Non-operational: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)
-query-scheduler.grpc-client-config.backoff-max-period duration
Maximum delay when backing off. (default 10s)
-query-scheduler.grpc-client-config.backoff-min-period duration
Expand Down
20 changes: 10 additions & 10 deletions docs/sources/mimir/configure/configuration-parameters/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -1611,11 +1611,11 @@ The `frontend` block configures the query-frontend.
# CLI flag: -query-frontend.instance-port
[port: <int> | default = 0]

# (experimental) NO-OP: Enqueue query requests with additional queue dimensions
# to split tenant request queues into subqueues. This enables separate requests
# to proceed from a tenant's subqueues even when other subqueues are blocked on
# slow query requests. Must be set on both query-frontend and scheduler to take
# effect. (default false)
# (experimental) Non-operational: Enqueue query requests with additional queue
# dimensions to split tenant request queues into subqueues. This enables
# separate requests to proceed from a tenant's subqueues even when other
# subqueues are blocked on slow query requests. Must be set on both
# query-frontend and scheduler to take effect. (default false)
# CLI flag: -query-frontend.additional-query-queue-dimensions-enabled
[additional_query_queue_dimensions_enabled: <boolean> | default = false]

Expand Down Expand Up @@ -1702,11 +1702,11 @@ The `query_scheduler` block configures the query-scheduler.
# CLI flag: -query-scheduler.max-outstanding-requests-per-tenant
[max_outstanding_requests_per_tenant: <int> | default = 100]
# (experimental) NO-OP: Enqueue query requests with additional queue dimensions
# to split tenant request queues into subqueues. This enables separate requests
# to proceed from a tenant's subqueues even when other subqueues are blocked on
# slow query requests. Must be set on both query-frontend and scheduler to take
# effect. (default false)
# (experimental) Non-operational: Enqueue query requests with additional queue
# dimensions to split tenant request queues into subqueues. This enables
# separate requests to proceed from a tenant's subqueues even when other
# subqueues are blocked on slow query requests. Must be set on both
# query-frontend and scheduler to take effect. (default false)
# CLI flag: -query-scheduler.additional-query-queue-dimensions-enabled
[additional_query_queue_dimensions_enabled: <boolean> | default = false]
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 @@ -78,7 +78,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).")

f.BoolVar(&cfg.AdditionalQueryQueueDimensionsEnabled, "query-frontend.additional-query-queue-dimensions-enabled", false, "NO-OP: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)")
f.BoolVar(&cfg.AdditionalQueryQueueDimensionsEnabled, "query-frontend.additional-query-queue-dimensions-enabled", false, "Non-operational: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)")

cfg.GRPCClientConfig.RegisterFlagsWithPrefix("query-frontend.grpc-client-config", 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 @@ -104,7 +104,7 @@ type Config struct {

func (cfg *Config) RegisterFlags(f *flag.FlagSet, logger log.Logger) {
f.IntVar(&cfg.MaxOutstandingPerTenant, "query-scheduler.max-outstanding-requests-per-tenant", 100, "Maximum number of outstanding requests per tenant per query-scheduler. In-flight requests above this limit will fail with HTTP response status code 429.")
f.BoolVar(&cfg.AdditionalQueryQueueDimensionsEnabled, "query-scheduler.additional-query-queue-dimensions-enabled", false, "NO-OP: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)")
f.BoolVar(&cfg.AdditionalQueryQueueDimensionsEnabled, "query-scheduler.additional-query-queue-dimensions-enabled", false, "Non-operational: Enqueue query requests with additional queue dimensions to split tenant request queues into subqueues. This enables separate requests to proceed from a tenant's subqueues even when other subqueues are blocked on slow query requests. Must be set on both query-frontend and scheduler to take effect. (default false)")
f.BoolVar(&cfg.UseMultiAlgorithmQueryQueue, "query-scheduler.use-multi-algorithm-query-queue", false, "Use an experimental version of the query queue which has the same behavior as the existing queue, but integrates tenant selection into the tree model.")
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.")

Expand Down

0 comments on commit 7bc9422

Please sign in to comment.