Fix typo in -query-frontend.align-querier-with-step CLI flag

CHANGELOG.md

@@ -18,6 +18,7 @@
 * [ENHANCEMENT] Distributor: Add single forwarding remote-write endpoint for a tenant (`forwarding_endpoint`), instead of using per-rule endpoints. This takes precendence over per-rule endpoints. #2801
 * [ENHANCEMENT] Added `err-mimir-distributor-max-write-message-size` to the errors catalog. #2470
 * [ENHANCEMENT] Add sanity check at startup to ensure the configured filesystem directories don't overlap for different components. #2828
+* [ENHANCEMENT] Query-frontend: CLI flag `-query-frontend.align-querier-with-step` renamed to `query-frontend.align-queries-with-step`. #2840
 * [BUGFIX] Ruler: fix not restoring alerts' state at startup. #2648
 * [BUGFIX] Ingester: Fix disk filling up after restarting ingesters with out-of-order support disabled while it was enabled before. #2799
 * [BUGFIX] Memberlist: retry joining memberlist cluster on startup when no nodes are resolved. #2837

cmd/mimir/config-descriptor.json

@@ -3691,7 +3691,7 @@
           "desc": "Mutate incoming queries to align their start and end with their step.",
           "fieldValue": null,
           "fieldDefaultValue": false,
-          "fieldFlag": "query-frontend.align-querier-with-step",
+          "fieldFlag": "query-frontend.align-queries-with-step",
           "fieldType": "boolean"
         },
         {

cmd/mimir/help-all.txt.tmpl

@@ -1231,6 +1231,8 @@ Usage of ./cmd/mimir/mimir:
   -querier.timeout duration
     	The timeout for a query. This config option should be set on query-frontend too when query sharding is enabled. This also applies to queries evaluated by the ruler (internally or remotely). (default 2m0s)
   -query-frontend.align-querier-with-step
+    	Mutate incoming queries to align their start and end with their step. It has been deprecated. Please use -query-frontend.align-queries-with-step instead.
+  -query-frontend.align-queries-with-step
     	Mutate incoming queries to align their start and end with their step.
   -query-frontend.cache-results
     	Cache query results.

cmd/mimir/help.txt.tmpl

@@ -409,6 +409,8 @@ Usage of ./cmd/mimir/mimir:
   -querier.timeout duration
     	The timeout for a query. This config option should be set on query-frontend too when query sharding is enabled. This also applies to queries evaluated by the ruler (internally or remotely). (default 2m0s)
   -query-frontend.align-querier-with-step
+    	Mutate incoming queries to align their start and end with their step. It has been deprecated. Please use -query-frontend.align-queries-with-step instead.
+  -query-frontend.align-queries-with-step
     	Mutate incoming queries to align their start and end with their step.
   -query-frontend.cache-results
     	Cache query results.

docs/sources/operators-guide/architecture/components/query-frontend/index.md

@@ -61,7 +61,7 @@ If the cached results are incomplete, the query-frontend calculates the required
 The query-frontend can optionally align queries with their step parameter to improve the cacheability of the query results.
 The result cache is backed by Memcached.
 
-Although aligning the step parameter to the query time range increases the performance of Grafana Mimir, it violates the [PromQL conformance](https://prometheus.io/blog/2021/05/03/introducing-prometheus-conformance-program/) of Grafana Mimir. If PromQL conformance is not a priority to you, you can enable step alignment by setting `-query-frontend.align-querier-with-step=true`.
+Although aligning the step parameter to the query time range increases the performance of Grafana Mimir, it violates the [PromQL conformance](https://prometheus.io/blog/2021/05/03/introducing-prometheus-conformance-program/) of Grafana Mimir. If PromQL conformance is not a priority to you, you can enable step alignment by setting `-query-frontend.align-queries-with-step=true`.
 
 ### About query sharding
 

docs/sources/operators-guide/configure/reference-configuration-parameters/index.md

@@ -1060,7 +1060,7 @@ grpc_client_config:
 [split_queries_by_interval: <duration> | default = 24h]
 
 # Mutate incoming queries to align their start and end with their step.
-# CLI flag: -query-frontend.align-querier-with-step
+# CLI flag: -query-frontend.align-queries-with-step
 [align_queries_with_step: <boolean> | default = false]
 
 results_cache:

integration/query_frontend_cache_test.go

@@ -38,17 +38,17 @@ func TestQueryFrontendUnalignedQuery(t *testing.T) {
 	flags = mergeFlags(flags, map[string]string{
 		"-query-frontend.cache-results":                     "true",
 		"-query-frontend.split-queries-by-interval":         "2m",
-		"-query-frontend.align-querier-with-step":           "true",
+		"-query-frontend.align-queries-with-step":           "true",
 		"-query-frontend.max-cache-freshness":               "0", // Cache everything.
 		"-query-frontend.results-cache.backend":             "memcached",
 		"-query-frontend.results-cache.memcached.addresses": "dns+" + memcached.NetworkEndpoint(e2ecache.MemcachedPort),
 	})
 
 	// Start the query-frontend.
-	queryFrontendAligned := e2emimir.NewQueryFrontend("query-frontend-aligned", mergeFlags(flags, map[string]string{"-query-frontend.align-querier-with-step": "true"}), e2emimir.WithConfigFile(configFile))
+	queryFrontendAligned := e2emimir.NewQueryFrontend("query-frontend-aligned", mergeFlags(flags, map[string]string{"-query-frontend.align-queries-with-step": "true"}), e2emimir.WithConfigFile(configFile))
 	require.NoError(t, s.Start(queryFrontendAligned))
 
-	queryFrontendUnaligned := e2emimir.NewQueryFrontend("query-frontend-unaligned", mergeFlags(flags, map[string]string{"-query-frontend.align-querier-with-step": "false"}), e2emimir.WithConfigFile(configFile))
+	queryFrontendUnaligned := e2emimir.NewQueryFrontend("query-frontend-unaligned", mergeFlags(flags, map[string]string{"-query-frontend.align-queries-with-step": "false"}), e2emimir.WithConfigFile(configFile))
 	require.NoError(t, s.Start(queryFrontendUnaligned))
 
 	querierAligned := e2emimir.NewQuerier("querier-aligned", consul.NetworkHTTPEndpoint(), mergeFlags(flags, map[string]string{"-querier.frontend-address": queryFrontendAligned.NetworkGRPCEndpoint()}), e2emimir.WithConfigFile(configFile))

operations/mimir-tests/test-autoscaling-generated.yaml

@@ -644,7 +644,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached
@@ -963,7 +963,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=false
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.scheduler-address=ruler-query-scheduler-discovery.default.svc.cluster.local:9095

operations/mimir-tests/test-consul-generated.yaml

@@ -934,7 +934,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-consul-multi-zone-generated.yaml

@@ -1087,7 +1087,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-consul-ruler-disabled-generated.yaml

@@ -916,7 +916,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-defaults-generated.yaml

@@ -514,7 +514,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-disable-chunk-streaming-generated.yaml

@@ -568,7 +568,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-extra-runtime-config-generated.yaml

@@ -585,7 +585,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-helm-parity-generated.yaml

@@ -638,7 +638,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-cluster-label-migration-step-0-before-generated.yaml

@@ -567,7 +567,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-cluster-label-migration-step-1-generated.yaml

@@ -569,7 +569,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-cluster-label-migration-step-2-generated.yaml

@@ -571,7 +571,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-cluster-label-migration-step-3-generated.yaml

@@ -569,7 +569,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-migration-step-0-before-generated.yaml

@@ -934,7 +934,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-migration-step-1-generated.yaml

@@ -988,7 +988,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-migration-step-2-generated.yaml

@@ -988,7 +988,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-migration-step-3-generated.yaml

@@ -988,7 +988,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-migration-step-4-generated.yaml

@@ -988,7 +988,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-migration-step-5-generated.yaml

@@ -570,7 +570,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-memberlist-migration-step-6-final-generated.yaml

@@ -567,7 +567,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-multi-zone-generated.yaml

@@ -732,7 +732,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-multi-zone-with-ongoing-migration-generated.yaml

@@ -800,7 +800,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-query-sharding-generated.yaml

@@ -568,7 +568,7 @@ spec:
       containers:
       - args:
         - -querier.max-query-parallelism=240
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.parallelize-shardable-queries=true

operations/mimir-tests/test-ruler-remote-evaluation-generated.yaml

@@ -645,7 +645,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached
@@ -965,7 +965,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=false
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.scheduler-address=ruler-query-scheduler-discovery.default.svc.cluster.local:9095

operations/mimir-tests/test-ruler-remote-evaluation-migration-generated.yaml

@@ -645,7 +645,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached
@@ -964,7 +964,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=false
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.scheduler-address=ruler-query-scheduler-discovery.default.svc.cluster.local:9095

operations/mimir-tests/test-shuffle-sharding-generated.yaml

@@ -570,7 +570,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.max-queriers-per-tenant=10

operations/mimir-tests/test-shuffle-sharding-read-path-disabled-generated.yaml

@@ -570,7 +570,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.max-queriers-per-tenant=10

operations/mimir-tests/test-storage-azure-generated.yaml

@@ -569,7 +569,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-storage-gcs-generated.yaml

@@ -567,7 +567,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-storage-s3-generated.yaml

@@ -568,7 +568,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir-tests/test-without-query-scheduler-generated.yaml

@@ -476,7 +476,7 @@ spec:
     spec:
       containers:
       - args:
-        - -query-frontend.align-querier-with-step=false
+        - -query-frontend.align-queries-with-step=false
         - -query-frontend.cache-results=true
         - -query-frontend.max-cache-freshness=10m
         - -query-frontend.results-cache.backend=memcached

operations/mimir/query-frontend.libsonnet

@@ -13,7 +13,7 @@
       'server.http-write-timeout': '1m',
 
       // Cache query results.
-      'query-frontend.align-querier-with-step': false,
+      'query-frontend.align-queries-with-step': false,
       'query-frontend.cache-results': true,
       'query-frontend.results-cache.backend': 'memcached',
       'query-frontend.results-cache.memcached.addresses': 'dnssrvnoa+memcached-frontend.%(namespace)s.svc.cluster.local:11211' % $._config,

pkg/frontend/querymiddleware/roundtrip.go

@@ -49,7 +49,9 @@ type Config struct {
 func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
 	f.IntVar(&cfg.MaxRetries, "query-frontend.max-retries-per-request", 5, "Maximum number of retries for a single request; beyond this, the downstream error is returned.")
 	f.DurationVar(&cfg.SplitQueriesByInterval, "query-frontend.split-queries-by-interval", 24*time.Hour, "Split range queries by an interval and execute in parallel. You should use a multiple of 24 hours to optimize querying blocks. 0 to disable it.")
-	f.BoolVar(&cfg.AlignQueriesWithStep, "query-frontend.align-querier-with-step", false, "Mutate incoming queries to align their start and end with their step.")
+	f.BoolVar(&cfg.AlignQueriesWithStep, "query-frontend.align-queries-with-step", false, "Mutate incoming queries to align their start and end with their step.")
+	// TODO: Remove it after 2 releases.
+	f.BoolVar(&cfg.AlignQueriesWithStep, "query-frontend.align-querier-with-step", false, "Mutate incoming queries to align their start and end with their step. It has been deprecated. Please use -query-frontend.align-queries-with-step instead.")
 	f.BoolVar(&cfg.CacheResults, "query-frontend.cache-results", false, "Cache query results.")
 	f.BoolVar(&cfg.ShardedQueries, "query-frontend.parallelize-shardable-queries", false, "True to enable query sharding.")
 	f.BoolVar(&cfg.CacheUnalignedRequests, "query-frontend.cache-unaligned-requests", false, "Cache requests that are not step-aligned.")