add instant-query flag example case documentation.

Signed-off-by: Tim Reddehase <tim.reddehase@xing.com>
thanos-io · Aug 21, 2019 · 4765b2a · 4765b2a
1 parent aa1d23f
commit 4765b2a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/cmd/thanos/query.go b/cmd/thanos/query.go
@@ -67,7 +67,7 @@ func registerQuery(m map[string]setupFunc, app *kingpin.Application, name string
 	replicaLabel := cmd.Flag("query.replica-label", "Label to treat as a replica indicator along which data is deduplicated. Still you will be able to query without deduplication using 'dedup=false' parameter.").
 		String()
 
-	defaultMaxSourceResolution := modelDuration(cmd.Flag("query.instant.default.max_source_resolution", "default value for max_source_resolution for instant queries. If not set, defaults to 0s only taking raw resolution into account.").Default("0s"))
+	defaultMaxSourceResolution := modelDuration(cmd.Flag("query.instant.default.max_source_resolution", "default value for max_source_resolution for instant queries. If not set, defaults to 0s only taking raw resolution into account. 1h can be a good value if you use instant queries over time ranges that incorporate times outside of your raw-retention.").Default("0s"))
 
 	selectorLabels := cmd.Flag("selector-label", "Query selector labels that will be exposed in info endpoint (repeated).").
 		PlaceHolder("<name>=\"<value>\"").Strings()

diff --git a/docs/components/query.md b/docs/components/query.md
@@ -238,7 +238,10 @@ Flags:
       --query.instant.default.max_source_resolution=0s
                                  default value for max_source_resolution for
                                  instant queries. If not set, defaults to 0s
-                                 only taking raw resolution into account.
+                                 only taking raw resolution into account. 1h can
+                                 be a good value if you use instant queries over
+                                 time ranges that incorporate times outside of
+                                 your raw-retention.
       --selector-label=<name>="<value>" ...
                                  Query selector labels that will be exposed in
                                  info endpoint (repeated).