Improve docs a bit

Author: jhalterman

cmd/mimir/config-descriptor.json

@@ -4388,7 +4388,7 @@
               "kind": "field",
               "name": "enabled",
               "required": false,
-              "desc": "Enable reactive limiting when making requests to ingesters",
+              "desc": "Enable reactive limiting when making requests to a service",
               "fieldValue": null,
               "fieldDefaultValue": false,
               "fieldFlag": "ingester.push-reactive-limiter.enabled",
@@ -4432,7 +4432,7 @@
               "kind": "field",
               "name": "max_limit_factor",
               "required": false,
-              "desc": "The maximum limit as a multiple of current inflight requests",
+              "desc": "The maximum inflight limit as a multiple of current inflight requests",
               "fieldValue": null,
               "fieldDefaultValue": 5,
               "fieldFlag": "ingester.push-reactive-limiter.max-limit-factor",
@@ -4443,7 +4443,7 @@
               "kind": "field",
               "name": "recent_window_min_duration",
               "required": false,
-              "desc": "Minimum duration of the window that is used to determine the recent, short-term load on the system",
+              "desc": "Minimum duration of the window that is used to collect recent response time samples",
               "fieldValue": null,
               "fieldDefaultValue": 1000000000,
               "fieldFlag": "ingester.push-reactive-limiter.recent-window-min-duration",
@@ -4454,7 +4454,7 @@
               "kind": "field",
               "name": "recent_window_max_duration",
               "required": false,
-              "desc": "Maximum duration of the window that is used to determine the recent, short-term load on the system",
+              "desc": "Maximum duration of the window that is used to collect recent response time samples",
               "fieldValue": null,
               "fieldDefaultValue": 30000000000,
               "fieldFlag": "ingester.push-reactive-limiter.recent-window-max-duration",
@@ -4465,7 +4465,7 @@
               "kind": "field",
               "name": "recent_window_min_samples",
               "required": false,
-              "desc": "Minimum number of samples that must be recorded in the recent window",
+              "desc": "Minimum number of samples that must be recorded in the recent window before updating the limit",
               "fieldValue": null,
               "fieldDefaultValue": 50,
               "fieldFlag": "ingester.push-reactive-limiter.recent-window-min-samples",
@@ -4487,7 +4487,7 @@
               "kind": "field",
               "name": "baseline_window_age",
               "required": false,
-              "desc": "The long-term average age of aggregated recent samples that are stored",
+              "desc": "The average age of baseline samples aggregated recent samples are added to",
               "fieldValue": null,
               "fieldDefaultValue": 10,
               "fieldFlag": "ingester.push-reactive-limiter.baseline-window-age",
@@ -4541,7 +4541,7 @@
               "kind": "field",
               "name": "enabled",
               "required": false,
-              "desc": "Enable reactive limiting when making requests to ingesters",
+              "desc": "Enable reactive limiting when making requests to a service",
               "fieldValue": null,
               "fieldDefaultValue": false,
               "fieldFlag": "ingester.read-reactive-limiter.enabled",
@@ -4585,7 +4585,7 @@
               "kind": "field",
               "name": "max_limit_factor",
               "required": false,
-              "desc": "The maximum limit as a multiple of current inflight requests",
+              "desc": "The maximum inflight limit as a multiple of current inflight requests",
               "fieldValue": null,
               "fieldDefaultValue": 5,
               "fieldFlag": "ingester.read-reactive-limiter.max-limit-factor",
@@ -4596,7 +4596,7 @@
               "kind": "field",
               "name": "recent_window_min_duration",
               "required": false,
-              "desc": "Minimum duration of the window that is used to determine the recent, short-term load on the system",
+              "desc": "Minimum duration of the window that is used to collect recent response time samples",
               "fieldValue": null,
               "fieldDefaultValue": 1000000000,
               "fieldFlag": "ingester.read-reactive-limiter.recent-window-min-duration",
@@ -4607,7 +4607,7 @@
               "kind": "field",
               "name": "recent_window_max_duration",
               "required": false,
-              "desc": "Maximum duration of the window that is used to determine the recent, short-term load on the system",
+              "desc": "Maximum duration of the window that is used to collect recent response time samples",
               "fieldValue": null,
               "fieldDefaultValue": 30000000000,
               "fieldFlag": "ingester.read-reactive-limiter.recent-window-max-duration",
@@ -4618,7 +4618,7 @@
               "kind": "field",
               "name": "recent_window_min_samples",
               "required": false,
-              "desc": "Minimum number of samples that must be recorded in the recent window",
+              "desc": "Minimum number of samples that must be recorded in the recent window before updating the limit",
               "fieldValue": null,
               "fieldDefaultValue": 50,
               "fieldFlag": "ingester.read-reactive-limiter.recent-window-min-samples",
@@ -4640,7 +4640,7 @@
               "kind": "field",
               "name": "baseline_window_age",
               "required": false,
-              "desc": "The long-term average age of aggregated recent samples that are stored",
+              "desc": "The average age of baseline samples aggregated recent samples are added to",
               "fieldValue": null,
               "fieldDefaultValue": 10,
               "fieldFlag": "ingester.read-reactive-limiter.baseline-window-age",

cmd/mimir/help-all.txt.tmpl

@@ -1682,31 +1682,31 @@ Usage of ./cmd/mimir/mimir:
   -ingester.push-circuit-breaker.thresholding-period duration
     	[experimental] Moving window of time that the percentage of failed requests is computed over (default 1m0s)
   -ingester.push-reactive-limiter.baseline-window-age uint
-    	[experimental] The long-term average age of aggregated recent samples that are stored (default 10)
+    	[experimental] The average age of baseline samples aggregated recent samples are added to (default 10)
   -ingester.push-reactive-limiter.correlation-window uint
     	[experimental] How many recent limit and inflight time measurements are stored to detect whether increases in limits correlate with increases in inflight times (default 50)
   -ingester.push-reactive-limiter.enabled
-    	[experimental] Enable reactive limiting when making requests to ingesters
+    	[experimental] Enable reactive limiting when making requests to a service
   -ingester.push-reactive-limiter.initial-limit uint
     	[experimental] Initial inflight requests limit (default 20)
   -ingester.push-reactive-limiter.initial-rejection-factor float
     	[experimental] The number of allowed queued requests, as a multiple of current inflight requests, after which rejections start (default 2)
   -ingester.push-reactive-limiter.max-limit uint
     	[experimental] Maximum inflight requests limit (default 200)
   -ingester.push-reactive-limiter.max-limit-factor float
-    	[experimental] The maximum limit as a multiple of current inflight requests (default 5)
+    	[experimental] The maximum inflight limit as a multiple of current inflight requests (default 5)
   -ingester.push-reactive-limiter.max-rejection-factor float
     	[experimental] The number of allowed queued requests, as a multiple of current inflight requests, after which all requests are rejected (default 3)
   -ingester.push-reactive-limiter.min-limit uint
     	[experimental] Minimum inflight requests limit (default 2)
   -ingester.push-reactive-limiter.recent-quantile float
     	[experimental] The quantile of recent recorded response times to consider when adjusting the concurrency limit (default 0.9)
   -ingester.push-reactive-limiter.recent-window-max-duration duration
-    	[experimental] Maximum duration of the window that is used to determine the recent, short-term load on the system (default 30s)
+    	[experimental] Maximum duration of the window that is used to collect recent response time samples (default 30s)
   -ingester.push-reactive-limiter.recent-window-min-duration duration
-    	[experimental] Minimum duration of the window that is used to determine the recent, short-term load on the system (default 1s)
+    	[experimental] Minimum duration of the window that is used to collect recent response time samples (default 1s)
   -ingester.push-reactive-limiter.recent-window-min-samples uint
-    	[experimental] Minimum number of samples that must be recorded in the recent window (default 50)
+    	[experimental] Minimum number of samples that must be recorded in the recent window before updating the limit (default 50)
   -ingester.rate-update-period duration
     	Period with which to update the per-tenant ingestion rates. (default 15s)
   -ingester.read-circuit-breaker.cooldown-period duration
@@ -1728,31 +1728,31 @@ Usage of ./cmd/mimir/mimir:
   -ingester.read-path-memory-utilization-limit uint
     	[experimental] Memory limit, in bytes, for CPU/memory utilization based read request limiting. Use 0 to disable it.
   -ingester.read-reactive-limiter.baseline-window-age uint
-    	[experimental] The long-term average age of aggregated recent samples that are stored (default 10)
+    	[experimental] The average age of baseline samples aggregated recent samples are added to (default 10)
   -ingester.read-reactive-limiter.correlation-window uint
     	[experimental] How many recent limit and inflight time measurements are stored to detect whether increases in limits correlate with increases in inflight times (default 50)
   -ingester.read-reactive-limiter.enabled
-    	[experimental] Enable reactive limiting when making requests to ingesters
+    	[experimental] Enable reactive limiting when making requests to a service
   -ingester.read-reactive-limiter.initial-limit uint
     	[experimental] Initial inflight requests limit (default 20)
   -ingester.read-reactive-limiter.initial-rejection-factor float
     	[experimental] The number of allowed queued requests, as a multiple of current inflight requests, after which rejections start (default 2)
   -ingester.read-reactive-limiter.max-limit uint
     	[experimental] Maximum inflight requests limit (default 200)
   -ingester.read-reactive-limiter.max-limit-factor float
-    	[experimental] The maximum limit as a multiple of current inflight requests (default 5)
+    	[experimental] The maximum inflight limit as a multiple of current inflight requests (default 5)
   -ingester.read-reactive-limiter.max-rejection-factor float
     	[experimental] The number of allowed queued requests, as a multiple of current inflight requests, after which all requests are rejected (default 3)
   -ingester.read-reactive-limiter.min-limit uint
     	[experimental] Minimum inflight requests limit (default 2)
   -ingester.read-reactive-limiter.recent-quantile float
     	[experimental] The quantile of recent recorded response times to consider when adjusting the concurrency limit (default 0.9)
   -ingester.read-reactive-limiter.recent-window-max-duration duration
-    	[experimental] Maximum duration of the window that is used to determine the recent, short-term load on the system (default 30s)
+    	[experimental] Maximum duration of the window that is used to collect recent response time samples (default 30s)
   -ingester.read-reactive-limiter.recent-window-min-duration duration
-    	[experimental] Minimum duration of the window that is used to determine the recent, short-term load on the system (default 1s)
+    	[experimental] Minimum duration of the window that is used to collect recent response time samples (default 1s)
   -ingester.read-reactive-limiter.recent-window-min-samples uint
-    	[experimental] Minimum number of samples that must be recorded in the recent window (default 50)
+    	[experimental] Minimum number of samples that must be recorded in the recent window before updating the limit (default 50)
   -ingester.rejection-prioritizer.calibration-interval duration
     	[experimental] The interval at which the rejection threshold is calibrated (default 1s)
   -ingester.ring.consul.acl-token string

docs/sources/mimir/configure/configuration-parameters/index.md

@@ -2480,7 +2480,7 @@ rejection_prioritizer:
   [calibration_interval: <duration> | default = 1s]
 
 push_reactive_limiter:
-  # (experimental) Enable reactive limiting when making requests to ingesters
+  # (experimental) Enable reactive limiting when making requests to a service
   # CLI flag: -ingester.push-reactive-limiter.enabled
   [enabled: <boolean> | default = false]
 
@@ -2496,22 +2496,23 @@ push_reactive_limiter:
   # CLI flag: -ingester.push-reactive-limiter.initial-limit
   [initial_limit: <int> | default = 20]
 
-  # (experimental) The maximum limit as a multiple of current inflight requests
+  # (experimental) The maximum inflight limit as a multiple of current inflight
+  # requests
   # CLI flag: -ingester.push-reactive-limiter.max-limit-factor
   [max_limit_factor: <float> | default = 5]
 
-  # (experimental) Minimum duration of the window that is used to determine the
-  # recent, short-term load on the system
+  # (experimental) Minimum duration of the window that is used to collect recent
+  # response time samples
   # CLI flag: -ingester.push-reactive-limiter.recent-window-min-duration
   [recent_window_min_duration: <duration> | default = 1s]
 
-  # (experimental) Maximum duration of the window that is used to determine the
-  # recent, short-term load on the system
+  # (experimental) Maximum duration of the window that is used to collect recent
+  # response time samples
   # CLI flag: -ingester.push-reactive-limiter.recent-window-max-duration
   [recent_window_max_duration: <duration> | default = 30s]
 
   # (experimental) Minimum number of samples that must be recorded in the recent
-  # window
+  # window before updating the limit
   # CLI flag: -ingester.push-reactive-limiter.recent-window-min-samples
   [recent_window_min_samples: <int> | default = 50]
 
@@ -2520,8 +2521,8 @@ push_reactive_limiter:
   # CLI flag: -ingester.push-reactive-limiter.recent-quantile
   [recent_quantile: <float> | default = 0.9]
 
-  # (experimental) The long-term average age of aggregated recent samples that
-  # are stored
+  # (experimental) The average age of baseline samples aggregated recent samples
+  # are added to
   # CLI flag: -ingester.push-reactive-limiter.baseline-window-age
   [baseline_window_age: <int> | default = 10]
 
@@ -2542,7 +2543,7 @@ push_reactive_limiter:
   [max_rejection_factor: <float> | default = 3]
 
 read_reactive_limiter:
-  # (experimental) Enable reactive limiting when making requests to ingesters
+  # (experimental) Enable reactive limiting when making requests to a service
   # CLI flag: -ingester.read-reactive-limiter.enabled
   [enabled: <boolean> | default = false]
 
@@ -2558,22 +2559,23 @@ read_reactive_limiter:
   # CLI flag: -ingester.read-reactive-limiter.initial-limit
   [initial_limit: <int> | default = 20]
 
-  # (experimental) The maximum limit as a multiple of current inflight requests
+  # (experimental) The maximum inflight limit as a multiple of current inflight
+  # requests
   # CLI flag: -ingester.read-reactive-limiter.max-limit-factor
   [max_limit_factor: <float> | default = 5]
 
-  # (experimental) Minimum duration of the window that is used to determine the
-  # recent, short-term load on the system
+  # (experimental) Minimum duration of the window that is used to collect recent
+  # response time samples
   # CLI flag: -ingester.read-reactive-limiter.recent-window-min-duration
   [recent_window_min_duration: <duration> | default = 1s]
 
-  # (experimental) Maximum duration of the window that is used to determine the
-  # recent, short-term load on the system
+  # (experimental) Maximum duration of the window that is used to collect recent
+  # response time samples
   # CLI flag: -ingester.read-reactive-limiter.recent-window-max-duration
   [recent_window_max_duration: <duration> | default = 30s]
 
   # (experimental) Minimum number of samples that must be recorded in the recent
-  # window
+  # window before updating the limit
   # CLI flag: -ingester.read-reactive-limiter.recent-window-min-samples
   [recent_window_min_samples: <int> | default = 50]
 
@@ -2582,8 +2584,8 @@ read_reactive_limiter:
   # CLI flag: -ingester.read-reactive-limiter.recent-quantile
   [recent_quantile: <float> | default = 0.9]
 
-  # (experimental) The long-term average age of aggregated recent samples that
-  # are stored
+  # (experimental) The average age of baseline samples aggregated recent samples
+  # are added to
   # CLI flag: -ingester.read-reactive-limiter.baseline-window-age
   [baseline_window_age: <int> | default = 10]
 

operations/mimir/mimir-flags-defaults.json

@@ -286,27 +286,27 @@
   "ingester.read-circuit-breaker.initial-delay": 0,
   "ingester.read-circuit-breaker.request-timeout": 30000000000,
   "ingester.rejection-prioritizer.calibration-interval": 1000000000,
-  "ingester.push-reactive-limiter.short-window-min-duration": 1000000000,
-  "ingester.push-reactive-limiter.short-window-max-duration": 30000000000,
-  "ingester.push-reactive-limiter.short-window-min-samples": 50,
-  "ingester.push-reactive-limiter.long-window": 60,
-  "ingester.push-reactive-limiter.sample-quantile": 0.9,
-  "ingester.push-reactive-limiter.min-inflight-limit": 2,
-  "ingester.push-reactive-limiter.max-inflight-limit": 200,
-  "ingester.push-reactive-limiter.initial-inflight-limit": 20,
+  "ingester.push-reactive-limiter.min-limit": 2,
+  "ingester.push-reactive-limiter.max-limit": 200,
+  "ingester.push-reactive-limiter.initial-limit": 20,
   "ingester.push-reactive-limiter.max-limit-factor": 5,
+  "ingester.push-reactive-limiter.recent-window-min-duration": 1000000000,
+  "ingester.push-reactive-limiter.recent-window-max-duration": 30000000000,
+  "ingester.push-reactive-limiter.recent-window-min-samples": 50,
+  "ingester.push-reactive-limiter.recent-quantile": 0.9,
+  "ingester.push-reactive-limiter.baseline-window-age": 10,
   "ingester.push-reactive-limiter.correlation-window": 50,
   "ingester.push-reactive-limiter.initial-rejection-factor": 2,
   "ingester.push-reactive-limiter.max-rejection-factor": 3,
-  "ingester.read-reactive-limiter.short-window-min-duration": 1000000000,
-  "ingester.read-reactive-limiter.short-window-max-duration": 30000000000,
-  "ingester.read-reactive-limiter.short-window-min-samples": 50,
-  "ingester.read-reactive-limiter.long-window": 60,
-  "ingester.read-reactive-limiter.sample-quantile": 0.9,
-  "ingester.read-reactive-limiter.min-inflight-limit": 2,
-  "ingester.read-reactive-limiter.max-inflight-limit": 200,
-  "ingester.read-reactive-limiter.initial-inflight-limit": 20,
+  "ingester.read-reactive-limiter.min-limit": 2,
+  "ingester.read-reactive-limiter.max-limit": 200,
+  "ingester.read-reactive-limiter.initial-limit": 20,
   "ingester.read-reactive-limiter.max-limit-factor": 5,
+  "ingester.read-reactive-limiter.recent-window-min-duration": 1000000000,
+  "ingester.read-reactive-limiter.recent-window-max-duration": 30000000000,
+  "ingester.read-reactive-limiter.recent-window-min-samples": 50,
+  "ingester.read-reactive-limiter.recent-quantile": 0.9,
+  "ingester.read-reactive-limiter.baseline-window-age": 10,
   "ingester.read-reactive-limiter.correlation-window": 50,
   "ingester.read-reactive-limiter.initial-rejection-factor": 2,
   "ingester.read-reactive-limiter.max-rejection-factor": 3,
@@ -379,6 +379,7 @@
   "validation.max-cost-attribution-cardinality": 2000,
   "validation.cost-attribution-cooldown": 0,
   "ruler.evaluation-delay-duration": 60000000000,
+  "ruler.evaluation-consistency-max-delay": 0,
   "ruler.tenant-shard-size": 0,
   "ruler.max-rules-per-rule-group": 20,
   "ruler.max-rule-groups-per-tenant": 70,