Updated config description

Signed-off-by: Justin Jung <[email protected]>

Author: justinjung04

CHANGELOG.md

@@ -16,7 +16,7 @@
 * [ENHANCEMENT] Index Cache: Multi level cache adds config `max_backfill_items` to cap max items to backfill per async operation. #5686
 * [ENHANCEMENT] Query Frontend: Log number of split queries in `query stats` log. #5703
 * [ENHANCEMENT] Logging: Added new options for logging HTTP request headers: `-server.log-request-headers` enables logging HTTP request headers, `-server.log-request-headers-exclude-list` allows users to specify headers which should not be logged. #5744
-* [ENHANCEMENT] Query Frontend/Scheduler: Time check in query priority now considers range selectors, modifiers and lookback delta. #5758
+* [ENHANCEMENT] Query Frontend/Scheduler: Time check in query priority now considers overall data fetched time window (including range selectors, modifiers and lookback delta). #5758
 * [ENHANCEMENT] Querier: Added `querier.store-gateway-query-stats-enabled` to enable or disable store gateway query stats log. #5749
 * [BUGFIX] Distributor: Do not use label with empty values for sharding #5717
 * [BUGFIX] Query Frontend: queries with negative offset should check whether it is cacheable or not. #5719

docs/configuration/config-file-reference.md

@@ -5095,16 +5095,17 @@ otel:
 # Regex that the query string should match. If not set, it won't be checked.
 [regex: <string> | default = ""]
 
-# Time window that the evaluated query (including range selectors, modifiers and
-# lookback delta) should be within. If not set, it won't be checked.
+# Overall data fetch time window (including range selectors, modifiers and
+# lookback delta) that the query should be within. If not set, it won't be
+# checked.
 time_window:
-  # Start of the time window that the evaluated query (including range
-  # selectors, modifiers and lookback delta) should be within. If set to 0, it
-  # won't be checked.
+  # Start of the data fetch time window (including range selectors, modifiers
+  # and lookback delta) that the query should be within. If set to 0, it won't
+  # be checked.
   [start: <int> | default = 0]
 
-  # End of the time window that the evaluated query (including range selectors,
-  # modifiers and lookback delta) should be within. If set to 0, it won't be
+  # End of the data fetch time window (including range selectors, modifiers and
+  # lookback delta) that the query should be within. If set to 0, it won't be
   # checked.
   [end: <int> | default = 0]
 ```

pkg/util/validation/limits.go

@@ -64,13 +64,13 @@ type PriorityDef struct {
 
 type QueryAttribute struct {
 	Regex         string     `yaml:"regex" json:"regex" doc:"nocli|description=Regex that the query string should match. If not set, it won't be checked."`
-	TimeWindow    TimeWindow `yaml:"time_window" json:"time_window" doc:"nocli|description=Time window that the evaluated query (including range selectors, modifiers and lookback delta) should be within. If not set, it won't be checked."`
+	TimeWindow    TimeWindow `yaml:"time_window" json:"time_window" doc:"nocli|description=Overall data fetch time window (including range selectors, modifiers and lookback delta) that the query should be within. If not set, it won't be checked."`
 	CompiledRegex *regexp.Regexp
 }
 
 type TimeWindow struct {
-	Start model.Duration `yaml:"start" json:"start" doc:"nocli|description=Start of the time window that the evaluated query (including range selectors, modifiers and lookback delta) should be within. If set to 0, it won't be checked.|default=0"`
-	End   model.Duration `yaml:"end" json:"end" doc:"nocli|description=End of the time window that the evaluated query (including range selectors, modifiers and lookback delta) should be within. If set to 0, it won't be checked.|default=0"`
+	Start model.Duration `yaml:"start" json:"start" doc:"nocli|description=Start of the data fetch time window (including range selectors, modifiers and lookback delta) that the query should be within. If set to 0, it won't be checked.|default=0"`
+	End   model.Duration `yaml:"end" json:"end" doc:"nocli|description=End of the data fetch time window (including range selectors, modifiers and lookback delta) that the query should be within. If set to 0, it won't be checked.|default=0"`
 }
 
 // Limits describe all the limits for users; can be used to describe global default