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

Add doc note regarding processors bound 

This commit expands the thread pool docs regarding the processor
setting.

Relates #20895
This commit is contained in:
Jason Tedor 2016-10-14 05:48:41 -04:00
parent cff5993318
commit 370253f95a
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/reference/modules/threadpool.asciidoc
View File

@ -118,14 +118,30 @@ thread_pool:
[[processors]] [[processors]]
=== Processors setting === Processors setting
The number of processors is automatically detected, and the thread pool The number of processors is automatically detected, and the thread pool
settings are automatically set based on it. Sometimes, the number of processors settings are automatically set based on it. In some cases it can be
are wrongly detected, in such cases, the number of processors can be useful to override the number of detected processors. This can be done
explicitly set using the `processors` setting. by explicitly setting the `processors` setting.
[source,yaml] [source,yaml]
-------------------------------------------------- --------------------------------------------------
processors: 2 processors: 2
-------------------------------------------------- --------------------------------------------------
There are a few use-cases for explicitly overriding the `processors`
setting:
. If you are running multiple instances of Elasticsearch on the same
host but want Elasticsearch to size its thread pools as if it only has a
fraction of the CPU, you should override the `processors` setting to the
desired fraction (e.g., if you're running two instances of Elasticsearch
on a 16-core machine, set `processors` to 8). Note that this is an
expert-level use-case and there's a lot more involved than just setting
the `processors` setting as there are other considerations like changing
the number of garbage collector threads, pinning processes to cores,
etc.
. Sometimes the number of processors is wrongly detected and in such
cases explicitly setting the `processors` setting will workaround such
issues.
In order to check the number of processors detected, use the nodes info In order to check the number of processors detected, use the nodes info
API with the `os` flag. API with the `os` flag.