Skip to content

Commit b4b217b

Browse files
committed
Doc gen
Signed-off-by: Essam Eldaly <eeldaly@amazon.com>
1 parent 63708b6 commit b4b217b

4 files changed

Lines changed: 43 additions & 0 deletions

File tree

docs/blocks-storage/querier.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,11 @@ querier:
367367
# eligible for eviction. Queries younger than this are ignored.
368368
# CLI flag: -querier.query-protection.eviction.min-query-age
369369
[min_query_age: <duration> | default = 10s]
370+
371+
# EXPERIMENTAL: Maximum number of queries to evict in a single check cycle
372+
# when resource thresholds are breached.
373+
# CLI flag: -querier.query-protection.eviction.max-evictions-per-cycle
374+
[max_evictions_per_cycle: <int> | default = 1]
370375
```
371376
372377
### `blocks_storage_config`

docs/blocks-storage/store-gateway.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,11 @@ store_gateway:
409409
# CLI flag: -store-gateway.query-protection.eviction.min-query-age
410410
[min_query_age: <duration> | default = 10s]
411411

412+
# EXPERIMENTAL: Maximum number of queries to evict in a single check cycle
413+
# when resource thresholds are breached.
414+
# CLI flag: -store-gateway.query-protection.eviction.max-evictions-per-cycle
415+
[max_evictions_per_cycle: <int> | default = 1]
416+
412417
hedged_request:
413418
# If true, hedged requests are applied to object store calls. It can help
414419
# with reducing tail latency.

docs/configuration/config-file-reference.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3909,6 +3909,11 @@ query_protection:
39093909
# eligible for eviction. Queries younger than this are ignored.
39103910
# CLI flag: -ingester.query-protection.eviction.min-query-age
39113911
[min_query_age: <duration> | default = 10s]
3912+
3913+
# EXPERIMENTAL: Maximum number of queries to evict in a single check cycle
3914+
# when resource thresholds are breached.
3915+
# CLI flag: -ingester.query-protection.eviction.max-evictions-per-cycle
3916+
[max_evictions_per_cycle: <int> | default = 1]
39123917
```
39133918

39143919
### `ingester_client_config`
@@ -5090,6 +5095,11 @@ query_protection:
50905095
# eligible for eviction. Queries younger than this are ignored.
50915096
# CLI flag: -querier.query-protection.eviction.min-query-age
50925097
[min_query_age: <duration> | default = 10s]
5098+
5099+
# EXPERIMENTAL: Maximum number of queries to evict in a single check cycle
5100+
# when resource thresholds are breached.
5101+
# CLI flag: -querier.query-protection.eviction.max-evictions-per-cycle
5102+
[max_evictions_per_cycle: <int> | default = 1]
50935103
```
50945104
50955105
### `query_frontend_config`
@@ -6896,6 +6906,11 @@ query_protection:
68966906
# CLI flag: -store-gateway.query-protection.eviction.min-query-age
68976907
[min_query_age: <duration> | default = 10s]
68986908
6909+
# EXPERIMENTAL: Maximum number of queries to evict in a single check cycle
6910+
# when resource thresholds are breached.
6911+
# CLI flag: -store-gateway.query-protection.eviction.max-evictions-per-cycle
6912+
[max_evictions_per_cycle: <int> | default = 1]
6913+
68996914
hedged_request:
69006915
# If true, hedged requests are applied to object store calls. It can help with
69016916
# reducing tail latency.

schemas/cortex-config-schema.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4902,6 +4902,12 @@
49024902
"type": "string",
49034903
"x-cli-flag": "ingester.query-protection.eviction.eviction-metric"
49044904
},
4905+
"max_evictions_per_cycle": {
4906+
"default": 1,
4907+
"description": "EXPERIMENTAL: Maximum number of queries to evict in a single check cycle when resource thresholds are breached.",
4908+
"type": "number",
4909+
"x-cli-flag": "ingester.query-protection.eviction.max-evictions-per-cycle"
4910+
},
49054911
"min_query_age": {
49064912
"default": "10s",
49074913
"description": "EXPERIMENTAL: Minimum time a query must be running before it becomes eligible for eviction. Queries younger than this are ignored.",
@@ -6113,6 +6119,12 @@
61136119
"type": "string",
61146120
"x-cli-flag": "querier.query-protection.eviction.eviction-metric"
61156121
},
6122+
"max_evictions_per_cycle": {
6123+
"default": 1,
6124+
"description": "EXPERIMENTAL: Maximum number of queries to evict in a single check cycle when resource thresholds are breached.",
6125+
"type": "number",
6126+
"x-cli-flag": "querier.query-protection.eviction.max-evictions-per-cycle"
6127+
},
61166128
"min_query_age": {
61176129
"default": "10s",
61186130
"description": "EXPERIMENTAL: Minimum time a query must be running before it becomes eligible for eviction. Queries younger than this are ignored.",
@@ -8527,6 +8539,12 @@
85278539
"type": "string",
85288540
"x-cli-flag": "store-gateway.query-protection.eviction.eviction-metric"
85298541
},
8542+
"max_evictions_per_cycle": {
8543+
"default": 1,
8544+
"description": "EXPERIMENTAL: Maximum number of queries to evict in a single check cycle when resource thresholds are breached.",
8545+
"type": "number",
8546+
"x-cli-flag": "store-gateway.query-protection.eviction.max-evictions-per-cycle"
8547+
},
85308548
"min_query_age": {
85318549
"default": "10s",
85328550
"description": "EXPERIMENTAL: Minimum time a query must be running before it becomes eligible for eviction. Queries younger than this are ignored.",

0 commit comments

Comments
 (0)