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.

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

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

Merged
merged 8 commits into from
Aug 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* [CHANGE] Ingester: experimental `-blocks-storage.tsdb.new-chunk-disk-mapper` has been removed, new chunk disk mapper is now always used, and is no longer marked experimental. Default value of `-blocks-storage.tsdb.head-chunks-write-queue-size` has changed to 1000000, this enables async chunk queue by default, which leads to improved latency on the write path when new chunks are created in ingesters. #2762
* [CHANGE] Ingester: removed deprecated `-blocks-storage.tsdb.isolation-enabled` option. TSDB-level isolation is now always disabled in Mimir. #2782
* [CHANGE] Compactor: `-compactor.partial-block-deletion-delay` must either be set to 0 (to disable partial blocks deletion) or a value higher than `4h`. #2787
* [CHANGE] Query-frontend: CLI flag `-query-frontend.align-querier-with-step` has been deprecated. Please use `-query-frontend.align-queries-with-step` instead. #2840
* [FEATURE] Introduced an experimental anonymous usage statistics tracking (disabled by default), to help Mimir maintainers make better decisions to support the open source community. The tracking system anonymously collects non-sensitive, non-personally identifiable information about the running Mimir cluster, and is disabled by default. #2643 #2662 #2685 #2732 #2733 #2735
* [FEATURE] Introduced an experimental deployment mode called read-write and running a fully featured Mimir cluster with three components: write, read and backend. The read-write deployment mode is a trade-off between the monolithic mode (only one component, no isolation) and the microservices mode (many components, high isolation). #2754 #2838
* [ENHANCEMENT] Distributor: Add `cortex_distributor_query_ingester_chunks_deduped_total` and `cortex_distributor_query_ingester_chunks_total` metrics for determining how effective ingester chunk deduplication at query time is. #2713
Expand Down
2 changes: 1 addition & 1 deletion cmd/mimir/config-descriptor.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
{
Expand Down
2 changes: 2 additions & 0 deletions cmd/mimir/help-all.txt.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions cmd/mimir/help.txt.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions integration/query_frontend_cache_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
4 changes: 2 additions & 2 deletions operations/mimir-tests/test-autoscaling-generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion operations/mimir-tests/test-consul-generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion operations/mimir-tests/test-defaults-generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion operations/mimir-tests/test-helm-parity-generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion operations/mimir-tests/test-multi-zone-generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion operations/mimir-tests/test-storage-azure-generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion operations/mimir-tests/test-storage-gcs-generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion operations/mimir-tests/test-storage-s3-generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion operations/mimir/query-frontend.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 3 additions & 1 deletion pkg/frontend/querymiddleware/roundtrip.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 in Mimir 2.6.0.
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.")
Expand Down