From 44c74f1e793656b5fcfe51460edce1ba271fd3a9 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Fri, 22 Jan 2021 12:59:06 +0200 Subject: [PATCH] app/vmselect/promql: improve documentation for `-search.maxPointsPertimeseries` command-line flag This should reduce incorrect usage and assumptions for this flag. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1020 --- app/vmselect/promql/eval.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/app/vmselect/promql/eval.go b/app/vmselect/promql/eval.go index 64efb07eb..42d3d54b6 100644 --- a/app/vmselect/promql/eval.go +++ b/app/vmselect/promql/eval.go @@ -20,7 +20,9 @@ import ( var ( disableCache = flag.Bool("search.disableCache", false, "Whether to disable response caching. This may be useful during data backfilling") - maxPointsPerTimeseries = flag.Int("search.maxPointsPerTimeseries", 30e3, "The maximum points per a single timeseries returned from the search") + maxPointsPerTimeseries = flag.Int("search.maxPointsPerTimeseries", 30e3, "The maximum points per a single timeseries returned from /api/v1/query_range. "+ + "This option doesn't limit the number of scanned raw samples in the database. The main purpose of this option is to limit the number of per-series points "+ + "returned to graphing UI such as Grafana. There is no sense in setting this limit to values significantly exceeding horizontal resoultion of the graph") ) // The minimum number of points per timeseries for enabling time rounding.