Skip to content

Commit 837a684

Browse files
szabostevejrodewig
andcommitted
[DOCS] Removes the default size definition of thread pool types (#49442)
Co-Authored-By: James Rodewig <[email protected]>
1 parent 6a13247 commit 837a684

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

docs/reference/modules/threadpool.asciidoc

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ of discarded.
1010
There are several thread pools, but the important ones include:
1111

1212
`generic`::
13-
For generic operations (e.g., background node discovery).
13+
For generic operations (for example, background node discovery).
1414
Thread pool type is `scaling`.
1515

1616
`search`::
@@ -20,16 +20,18 @@ There are several thread pools, but the important ones include:
2020
`1000`.
2121

2222
[[search-throttled]]`search_throttled`::
23-
For count/search/suggest/get operations on `search_throttled indices`. Thread pool type is
24-
`fixed_auto_queue_size` with a size of `1`, and initial queue_size of `100`.
23+
For count/search/suggest/get operations on `search_throttled indices`.
24+
Thread pool type is `fixed_auto_queue_size` with a size of `1`, and initial
25+
queue_size of `100`.
2526

2627
`get`::
2728
For get operations. Thread pool type is `fixed`
2829
with a size of `# of available processors`,
2930
queue_size of `1000`.
3031

3132
`analyze`::
32-
For analyze requests. Thread pool type is `fixed` with a size of 1, queue size of 16.
33+
For analyze requests. Thread pool type is `fixed` with a size of `1`, queue
34+
size of `16`.
3335

3436
`write`::
3537
For single-document index/delete/update and bulk requests. Thread pool type
@@ -49,8 +51,9 @@ There are several thread pools, but the important ones include:
4951
keep-alive of `5m` and a max of `min(10, (# of available processors)/2)`.
5052

5153
`listener`::
52-
Mainly for java client executing of action when listener threaded is set to true.
53-
Thread pool type is `scaling` with a default max of `min(10, (# of available processors)/2)`.
54+
Mainly for java client executing of action when listener threaded is set to
55+
`true`. Thread pool type is `scaling` with a default max of
56+
`min(10, (# of available processors)/2)`.
5457

5558
Changing a specific thread pool can be done by setting its type-specific
5659
parameters; for example, changing the number of threads in the `write` thread
@@ -77,8 +80,7 @@ The `fixed` thread pool holds a fixed size of threads to handle the
7780
requests with a queue (optionally bounded) for pending requests that
7881
have no threads to service them.
7982

80-
The `size` parameter controls the number of threads, and defaults to the
81-
number of cores times 5.
83+
The `size` parameter controls the number of threads.
8284

8385
The `queue_size` allows to control the size of the queue of pending
8486
requests that have no threads to execute them. By default, it is set to
@@ -107,8 +109,7 @@ https://en.wikipedia.org/wiki/Little%27s_law[Little's Law]. These calculations
107109
will potentially adjust the `queue_size` up or down by 50 every time
108110
`auto_queue_frame_size` operations have been completed.
109111

110-
The `size` parameter controls the number of threads, and defaults to the
111-
number of cores times 5.
112+
The `size` parameter controls the number of threads.
112113

113114
The `queue_size` allows to control the initial size of the queue of pending
114115
requests that have no threads to execute them.
@@ -163,6 +164,7 @@ thread_pool:
163164
[float]
164165
[[processors]]
165166
=== Processors setting
167+
166168
The number of processors is automatically detected, and the thread pool
167169
settings are automatically set based on it. In some cases it can be
168170
useful to override the number of detected processors. This can be done
@@ -176,15 +178,14 @@ processors: 2
176178
There are a few use-cases for explicitly overriding the `processors`
177179
setting:
178180

179-
. If you are running multiple instances of Elasticsearch on the same
180-
host but want Elasticsearch to size its thread pools as if it only has a
181-
fraction of the CPU, you should override the `processors` setting to the
182-
desired fraction (e.g., if you're running two instances of Elasticsearch
183-
on a 16-core machine, set `processors` to 8). Note that this is an
184-
expert-level use-case and there's a lot more involved than just setting
185-
the `processors` setting as there are other considerations like changing
186-
the number of garbage collector threads, pinning processes to cores,
187-
etc.
181+
. If you are running multiple instances of {es} on the same host but want {es}
182+
to size its thread pools as if it only has a fraction of the CPU, you should
183+
override the `processors` setting to the desired fraction, for example, if
184+
you're running two instances of {es} on a 16-core machine, set `processors` to 8.
185+
Note that this is an expert-level use case and there's a lot more involved
186+
than just setting the `processors` setting as there are other considerations
187+
like changing the number of garbage collector threads, pinning processes to
188+
cores, and so on.
188189
. Sometimes the number of processors is wrongly detected and in such
189190
cases explicitly setting the `processors` setting will workaround such
190191
issues.

0 commit comments

Comments
 (0)