Document WithTimeout options for Query/QueryRange (#1037)

Signed-off-by: Joseph Woodward <[email protected]>
prometheus · Apr 29, 2022 · efe8e6f · efe8e6f
1 parent 4dcf02e
commit efe8e6f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/api/prometheus/v1/api.go b/api/prometheus/v1/api.go
@@ -824,6 +824,8 @@ type apiOptions struct {
 
 type Option func(c *apiOptions)
 
+// WithTimeout can be used to provide an optional query evaluation timeout for Query and QueryRange.
+// https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries
 func WithTimeout(timeout time.Duration) Option {
 	return func(o *apiOptions) {
 		o.timeout = timeout