Skip to content
This repository has been archived by the owner on Mar 27, 2021. It is now read-only.

Commit

Permalink
add some docs on limits (#668)
Browse files Browse the repository at this point in the history
* add some docs on limits

* edits.
  • Loading branch information
sjoeboo authored Jul 8, 2020
1 parent 436e7fd commit 3924b96
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/content/_docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -516,6 +516,44 @@ type: json
path: <string>
```

#### [Limits](#limits)

The metrics config supports the setting of query limits to control the number of results/size of results returned for a given query. These may be provided here as defaults, and may also be overridden at query time via `options`, ie:

```json
'options': { 'aggregationLimit': 4000000,
'dataLimit': 80000000,
'failOnLimits': True,
'groupLimit': 8000,
'seriesLimit': 40},
```

##### aggregationLimit

Maximum number of data points a single aggregation is allowed to output.

##### dataLimit

Maximum number of data points a single request may fetch from the backends.

##### groupLimit

Maximum number of distinct groups a single result group may contain.

##### seriesLimit

Maximum amount of time series a single request is allowed to fetch, per cluster (if federated).

A note: when using resource identifiers this limit only applies to the number of series found in the metadata backend, *not* the total series returned.

It is therefore possible to have a low limit *not* be exceeded with the number of series found in metadata, however, return far more series from the metrics backend when resource identifiers are taken into account (which may trigger additional limits).

##### failOnLimits

When true, any limits applied will be reported as a failure.



### [`<metadata_backend>`](#metadata_backend)

Metadata acts as the index to time series data, it is the driving force behind our [Query Language](docs/query_language).
Expand Down

0 comments on commit 3924b96

Please sign in to comment.