elasticsearch/docs/reference/modules/indices
Tanguy Leroux 07b995152e
[7.17.1] Adjust indices.recovery.max_bytes_per_sec according to external settings (#83413)
* Adjust indices.recovery.max_bytes_per_sec according to external settings

Today the setting indices.recovery.max_bytes_per_sec defaults to different
values depending on the node roles, the JVM version and the system total
memory that can be detected.

The current logic to set the default value can be summarized as:

    40 MB for non-data nodes
    40 MB for data nodes that runs on a JVM version < 14
    40 MB for data nodes that have one of the data_hot, data_warm, data_content or data roles

Nodes with only data_cold and/or data_frozen roles as data roles have a
default value that depends of the available memory:

    with ≤ 4 GB of available memory, the default is 40 MB
    with more than 4 GB and less or equal to 8 GB, the default is 60 MB
    with more than 8 GB and less or equal to 16 GB, the default is 90 MB
    with more than 16 GB and less or equal to 32 GB, the default is 125 MB
    and above 32 GB, the default is 250 MB

While those defaults served us well, we want to evaluate if we can define
more appropriate defaults if Elasticsearch were to know better the limits
(or properties) of the hardware it is running on - something that Elasticsearch
cannot extract by itself but can derive from settings that are provided at startup.

This pull request introduces the following new node settings:

    node.bandwidth.recovery.network
    node.bandwidth.recovery.disk.read
    node.bandwidth.recovery.disk.write

Those settings are not dynamic and must be set before the node starts.
When they are set Elasticsearch detects the minimum available bandwidth
among the network, disk read and disk write available bandwidths and computes
a maximum bytes per seconds limit that will be a fraction of the min. available
bandwidth. By default 40% of the min. bandwidth is used but that can be
dynamically configured by an operator
(using the node.bandwidth.recovery.operator.factor setting) or by the user
directly (using a different setting node.bandwidth.recovery.factor).

The limit computed from available bandwidths is then compared to pre existing
limitations like the one set through the indices.recovery.max_bytes_per_sec setting
or the one that is computed by Elasticsearch from the node's physical memory
on dedicated cold/frozen nodes. Elasticsearch will try to use the highest possible
limit among those values, while not exceeding an overcommit ratio that is also
defined through a node setting
(see node.bandwidth.recovery.operator.factor.max_overcommit).

This overcommit ratio is here to prevent the rate limit to be set to a value that is
greater than 100 times (by default) the minimum available bandwidth.

Backport of #82819 for 7.17.1

* Add missing max overcommit factor to list of (dynamic) settings (#83350)

The setting node.bandwidth.recovery.operator.factor.max_overcommit
wasn't added to the list of cluster settings and to the list of settings to
consume for updates.

Relates #82819

* Operator factor settings should have the OperatorDynamic setting property (#83359)

Relates #82819

* Add docs for node bandwith settings (#83361)

Relates #82819

* Adjust for 7.17.1

* remove draft

* remove docs/changelog/83350.yaml

Co-authored-by: David Turner <david.turner@elastic.co>
2022-02-09 06:33:05 -05:00
..
circuit_breaker.asciidoc Script: Deprecate script context cache (#79508) 2021-10-19 20:15:45 -05:00
fielddata.asciidoc Clarify field data cache behavior in docs (#64375) 2020-11-20 13:56:02 -08:00
index_management.asciidoc [DOCS] Fix default value for closed indices (#78924) (#79055) 2021-10-13 08:26:32 -04:00
indexing_buffer.asciidoc [DOCS] Fix double spaces (#71082) (#71120) 2021-03-31 11:43:34 -04:00
query_cache.asciidoc [DOCS] Document dynamic cluster settings (#61760) (#61817) 2020-09-01 16:04:23 -04:00
recovery.asciidoc [7.17.1] Adjust indices.recovery.max_bytes_per_sec according to external settings (#83413) 2022-02-09 06:33:05 -05:00
request_cache.asciidoc Create a sha-256 hash of the shard request cache key (#74877) 2021-09-13 14:08:00 +01:00
search-settings.asciidoc [DOCS] Increase search.max_bucket default value by one 2021-06-29 08:38:43 -04:00