honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Add reference docs for `search.max_buckets` setting (#56449) (#56511) 

Adds reference-style setting documentation for the `search.max_buckets`
setting.

This setting was previously only documented on the [bucket
aggregations][0] page.

[0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-aggregations-bucket.html
This commit is contained in:
James Rodewig 2020-05-11 09:45:09 -04:00 committed by GitHub
parent 02ab9112a9
commit ba67ab3b64
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/aggregations/bucket.asciidoc
View File

@ -13,9 +13,10 @@ aggregated for the buckets created by their "parent" bucket aggregation.
There are different bucket aggregators, each with a different "bucketing" strategy. Some define a single bucket, some
define fixed number of multiple buckets, and others dynamically create the buckets during the aggregation process.
NOTE: The maximum number of buckets allowed in a single response is limited by a dynamic cluster
setting named `search.max_buckets`. It defaults to 10,000, requests that try to return more than
the limit will fail with an exception.
NOTE: The maximum number of buckets allowed in a single response is limited by a
dynamic cluster setting named
<<search-settings-max-buckets,`search.max_buckets`>>. It defaults to 10,000,
requests that try to return more than the limit will fail with an exception.
include::bucket/adjacency-matrix-aggregation.asciidoc[]

16
docs/reference/modules/indices/search-settings.asciidoc
View File

@ -1,12 +1,14 @@
[[search-settings]]
=== Search Settings
The following _expert_ setting can be set to manage global search limits.
The following expert settings can be set to manage global search and aggregation
limits.
[[indices-query-bool-max-clause-count]]
`indices.query.bool.max_clause_count`::
Defaults to `1024`.
(<<cluster-update-settings,Dynamic>>, integer)
Maximum number of clauses a Lucene BooleanQuery can contain. Defaults to `1024`.
+
This setting limits the number of clauses a Lucene BooleanQuery can have. The
default of 1024 is quite high and should normally be sufficient. This limit does
not only affect Elasticsearchs `bool` query, but many other queries are rewritten to Lucene's
@ -15,3 +17,11 @@ and taking up too much CPU and memory. In case you're considering increasing thi
make sure you've exhausted all other options to avoid having to do this. Higher values can lead
to performance degradations and memory issues, especially in clusters with a high load or
few resources.
[[search-settings-max-buckets]]
`search.max_buckets`::
(<<cluster-update-settings,Dynamic>>, integer)
Maximum number of <<search-aggregations-bucket,aggregation buckets>> allowed in
a single response. Defaults to `10000`.
+
Requests that attempt to return more than this limit will return an error.