Skip to content

Commit

Permalink
Update arguments.md (#6460)
Browse files Browse the repository at this point in the history
* Update arguments.md

Removed obsolete `-promql.lookback-delta` option (deprecated since Cortex 1.2, replaced with `-querier.lookback-delta`). #3144

Signed-off-by: Charlie Le <[email protected]>
Signed-off-by: Charlie Le <[email protected]>

* Rename `-querier.split-queries-by-day` to `-querier.split-queries-by-...

...interval`

Query-frontend: removed `-querier.split-queries-by-day` (deprecated in Cortex 0.4.0). Please use `-querier.split-queries-by-interval` instead. #3813
Signed-off-by: Charlie Le <[email protected]>

* Fix typo and add description for `max_samples_per_query`

Flag `ingester.max-samples-per-query` was removed in #4812 as part of the chunk storage removal.

Signed-off-by: Charlie Le <[email protected]>

* Remove 'Storage' section from arguments documentation

Removed in 73567bc#diff-ed3c6bb08ff3f85373c673fd92d1429599243584fc46d51a3221782263f26821L130

Signed-off-by: Charlie Le <[email protected]>

* Update arguments.md

* Remove deprecated flag

Signed-off-by: Charlie Le <[email protected]>

---------

Signed-off-by: Charlie Le <[email protected]>
Signed-off-by: Charlie Le <[email protected]>
  • Loading branch information
CharlieTLe authored Dec 30, 2024
1 parent 8a46d20 commit c243963
Showing 1 changed file with 3 additions and 15 deletions.
18 changes: 3 additions & 15 deletions docs/configuration/arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The next three options only apply when the querier is used together with the Que

## Querier and Ruler

- `-promql.lookback-delta`
- `-querier.lookback-delta`

Time since the last sample after which a time series is considered stale and ignored by expression evaluations.

Expand All @@ -63,9 +63,9 @@ The next three options only apply when the querier is used together with the Que

If set to true, will cause the query frontend to mutate incoming queries and align their start and end parameters to the step parameter of the query. This improves the cacheability of the query results.

- `-querier.split-queries-by-day`
- `-querier.split-queries-by-interval`

If set to true, will cause the query frontend to split multi-day queries into multiple single-day queries and execute them in parallel.
If set, will cause the query frontend to split multi-day queries into multiple queries and execute them in parallel. A multiple of 24h should be used when setting this flag.

- `-querier.cache-results`

Expand Down Expand Up @@ -391,12 +391,6 @@ Valid per-tenant limits are (with their corresponding flags for default values):

Requires `-distributor.replication-factor`, `-distributor.shard-by-all-labels`, `-distributor.sharding-strategy` and `-distributor.zone-awareness-enabled` set for the ingesters too.

- `max_series_per_query` / `-ingester.max-series-per-query`

- `max_samples_per_query` / `-ingester.max-samples-per-query`

Limits on the number of timeseries and samples returns by a single ingester during a query.

- `max_metadata_per_user` / `-ingester.max-metadata-per-user`
- `max_metadata_per_metric` / `-ingester.max-metadata-per-metric`
Enforced by the ingesters; limits the number of active metadata a user (or a given metric) can have. When running with `-distributor.shard-by-all-labels=false` (the default), this limit will enforce the maximum number of metadata a metric can have 'globally', as all metadata for a single metric will be sent to the same replication set of ingesters. This is not the case when running with `-distributor.shard-by-all-labels=true`, so the actual limit will be N/RF times higher, where N is number of ingester replicas and RF is configured replication factor.
Expand Down Expand Up @@ -443,12 +437,6 @@ Valid ingester instance limits are (with their corresponding flags):

Limit the maximum number of requests being handled by an ingester at once. This setting is critical for preventing ingesters from using an excessive amount of memory during high load or temporary slow downs. When this limit is reached, new requests will fail with an HTTP 500 error.

## Storage

- `s3.force-path-style`

Set this to `true` to force the request to use path-style addressing (`http://s3.amazonaws.com/BUCKET/KEY`). By default, the S3 client will use virtual hosted bucket addressing when possible (`http://BUCKET.s3.amazonaws.com/KEY`).

## DNS Service Discovery

Some clients in Cortex support service discovery via DNS to find addresses of backend servers to connect to (ie. caching servers). The clients supporting it are:
Expand Down

0 comments on commit c243963

Please sign in to comment.