Skip to content

Commit

Permalink
Add documentation for indices.replication.max_bytes_per_sec
Browse files Browse the repository at this point in the history 
Signed-off-by: Marc Handalian <marc.handalian@gmail.com>
  • Loading branch information
@mch2
mch2 committed Apr 29, 2024
1 parent cac36b2 commit 14ddc8e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions _install-and-configure/configuring-opensearch/index-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ OpenSearch supports the following cluster-level index settings. All settings in

- `indices.recovery.max_concurrent_remote_store_streams` (Integer): The number of streams to the remote repository that can be opened in parallel when recovering a remote store index. Default is `20`.

- `indices.replication.max_bytes_per_sec` (String): Limits the total inbound and outbound replication traffic for each node. If a value is not specified the configured value of `indices.recovery.max_bytes_per_sec` will be used, which is by default 40mb. If you set the replication traffic value to less than or equal to 0mb, rate limiting will be disabled, which causes replication data to be transferred at the highest possible rate.

Check warning on line 38 in _install-and-configure/configuring-opensearch/index-settings.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.UnitsSpacing] Put a space between the number and the units in '40mb.'.

Raw Output:
{"message": "[OpenSearch.UnitsSpacing] Put a space between the number and the units in '40mb.'.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 38, "column": 249}}}, "severity": "WARNING"}

Check failure on line 38 in _install-and-configure/configuring-opensearch/index-settings.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'mb. If'.

Raw Output:
{"message": "[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'mb. If'.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 38, "column": 251}}}, "severity": "ERROR"}

Check warning on line 38 in _install-and-configure/configuring-opensearch/index-settings.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.UnitsSpacing] Put a space between the number and the units in '0mb,'.

Raw Output:
{"message": "[OpenSearch.UnitsSpacing] Put a space between the number and the units in '0mb,'.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 38, "column": 322}}}, "severity": "WARNING"}

- `indices.fielddata.cache.size` (String): The maximum size of the field data cache. May be specified as an absolute value (for example, `8GB`) or a percentage of the node heap (for example, `50%`). This value is static so you must specify it in the `opensearch.yml` file. If you don't specify this setting, the maximum size is unlimited. This value should be smaller than the `indices.breaker.fielddata.limit`. For more information, see [Field data circuit breaker]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/circuit-breaker/#field-data-circuit-breaker-settings).

## Index-level index settings
Expand Down

0 comments on commit 14ddc8e

Please sign in to comment.