Skip to content

Commit 2bc6996

Browse files
authored
Update docs to reflect node.processors (#54855)
We namespaced the previous setting "processors" into "node.processors". This commit updates some of the documentation to reflect this.
1 parent b7f02d8 commit 2bc6996

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

docs/reference/modules/threadpool.asciidoc

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -145,27 +145,26 @@ thread_pool:
145145
The number of processors is automatically detected, and the thread pool
146146
settings are automatically set based on it. In some cases it can be
147147
useful to override the number of detected processors. This can be done
148-
by explicitly setting the `processors` setting.
148+
by explicitly setting the `node.processors` setting.
149149

150150
[source,yaml]
151151
--------------------------------------------------
152-
processors: 2
152+
node.processors: 2
153153
--------------------------------------------------
154154

155-
There are a few use-cases for explicitly overriding the `processors`
155+
There are a few use-cases for explicitly overriding the `node.processors`
156156
setting:
157157

158-
. If you are running multiple instances of {es} on the same host but want {es}
159-
to size its thread pools as if it only has a fraction of the CPU, you should
160-
override the `processors` setting to the desired fraction, for example, if
161-
you're running two instances of {es} on a 16-core machine, set `processors` to 8.
162-
Note that this is an expert-level use case and there's a lot more involved
163-
than just setting the `processors` setting as there are other considerations
164-
like changing the number of garbage collector threads, pinning processes to
165-
cores, and so on.
166-
. Sometimes the number of processors is wrongly detected and in such
167-
cases explicitly setting the `processors` setting will workaround such
168-
issues.
158+
. If you are running multiple instances of {es} on the same host but want want
159+
{es} to size its thread pools as if it only has a fraction of the CPU, you
160+
should override the `node.processors` setting to the desired fraction, for
161+
example, if you're running two instances of {es} on a 16-core machine, set
162+
`node.processors` to 8. Note that this is an expert-level use case and there's
163+
a lot more involved than just setting the `node.processors` setting as there are
164+
other considerations like changing the number of garbage collector threads,
165+
pinning processes to cores, and so on.
166+
. Sometimes the number of processors is wrongly detected and in such cases
167+
explicitly setting the `node.processors` setting will workaround such issues.
169168

170169
In order to check the number of processors detected, use the nodes info
171170
API with the `os` flag.

0 commit comments

Comments
 (0)