Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doc for dynamic threadpool settings #8588

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add doc for dynamic threadpool settings #8588

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions _install-and-configure/configuring-opensearch/index-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,17 @@

- `cluster.default_number_of_replicas` (Integer): Controls the default number of replicas for indexes in the cluster. The index-level `index.number_of_replicas` setting defaults to this value if not configured. Default is `1`.

- `cluster.thread_pool.<fixed-threadpool>.size` (Integer): Controls the size of fixed and resizable queue threadpool size. Overrides the defaults provided in yml.

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

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: threadpool. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: threadpool. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 84, "column": 31}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: resizable. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: resizable. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 84, "column": 91}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: yml. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: yml. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 84, "column": 159}}}, "severity": "ERROR"}

- `cluster.thread_pool.<scaling-threadpool>.max` (Integer): Controls the maximum size of scaling threadpool. Overrides the defaults provided in yml.

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

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: threadpool. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: threadpool. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 86, "column": 33}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingWords] There should be one space between words in 'of scaling'.

Raw Output:
{"message": "[OpenSearch.SpacingWords] There should be one space between words in 'of scaling'.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 86, "column": 87}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: yml. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: yml. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 86, "column": 146}}}, "severity": "ERROR"}

- `cluster.thread_pool.<scaling-threadpool>.core` (Integer): Controls the core size of scaling threadpool. Overrides the defaults provided in yml.

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

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: threadpool. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: threadpool. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 88, "column": 33}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingWords] There should be one space between words in 'of scaling'.

Raw Output:
{"message": "[OpenSearch.SpacingWords] There should be one space between words in 'of scaling'.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 88, "column": 85}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: yml. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: yml. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_install-and-configure/configuring-opensearch/index-settings.md", "range": {"start": {"line": 88, "column": 144}}}, "severity": "ERROR"}

### Notes for dynamically tuning Thread Pool Settings

These are expert level settings, which can potentially destabilize your cluster. It is not advised on heterogeneous clusters, as it will make threadpool count homogenous on all the nodes. It is not advised to tune threadpool which are used in both data node and cluster manager as well , due to the same reason. Post tuning these settings,
We recommend monitoring the cluster to ensure it is stable and performing as expected.

## Index-level index settings

You can specify index settings at index creation. There are two types of index settings:
Expand Down
Loading