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

155 lines
5.3 KiB
Plaintext
Raw Normal View History

Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
[[cat-thread-pool]]
[DOCS] Renamed the "cat" chapters to be more searchable
2014-05-16 15:43:35 -04:00
== cat thread pool
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
The `thread_pool` command shows cluster wide thread pool statistics per node. By default the active, queue and rejected
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
statistics are returned for all thread pools.
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
[source,js]
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
--------------------------------------------------
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
GET /_cat/thread_pool
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
--------------------------------------------------
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
// CONSOLE
Which looks like:
[source,txt]
--------------------------------------------------
Introduce analyze thread pool (#29541) We want to remove the index thread pool as it is no longer needed since single-document indexing requests are executed as bulk requests now. Analyze requests are also executed on the index thread pool though and they need a thread pool to execute on. The bulk thread does not seem like the right thread pool, let us keep that thread pool conceptually for bulk requests and free for bulk requests. None of the existing thread pools make sense for analyze requests either. The generic thread pool would be a terrible choice since it has an unbounded queue and that is a bad idea for user-facing APIs. This commit introduces a small by default (size=1, queue_size=16) thread pool for analyze requests.
2018-04-17 06:46:15 -04:00
node-0 analyze 0 0 0
Docs: Add ccr to the cat thread pool doc test (#31442) Since #31251, we use the default distribution to test docs. With this distribution, the cat thread-pool response will include the ccr thread-pool. This commit adjusts /_cat/thread_pool doc to include ccr. Relates #31251
2018-06-20 20:36:37 -04:00
...
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
node-0 fetch_shard_started 0 0 0
node-0 fetch_shard_store 0 0 0
node-0 flush 0 0 0
Docs: Use the default distribution to test docs (#31251) This switches the docs tests from the `oss-zip` distribution to the `zip` distribution so they have xpack installed and configured with the default basic license. The goal is to be able to merge the `x-pack/docs` directory into the `docs` directory, marking the x-pack docs with some kind of marker. This is the first step in that process. This also enables `-Dtests.distribution` support for the `docs` directory so you can run the tests against the `oss-zip` distribution with something like ``` ./gradlew -p docs check -Dtests.distribution=oss-zip ``` We can set up Jenkins to run both. Relates to #30665
2018-06-18 12:06:42 -04:00
...
Rename the bulk thread pool to write thread pool (#29593) This commit renames the bulk thread pool to the write thread pool. This is to better reflect the fact that the underlying thread pool is used to execute any document write request (single-document index/delete/update requests, and bulk requests). With this change, we add support for fallback settings thread_pool.bulk.* which will be supported until 7.0.0. We also add a system property so that the display name of the thread pool remains as "bulk" if needed to avoid breaking users.
2018-04-19 07:47:20 -04:00
node-0 write 0 0 0
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
--------------------------------------------------
DOCS: Make ellipsis optional in /cat/thread_pool (#33186) The fix proposed in #31442 fails with the oss distro because the added 3dots does not match anything with the default oss while a 3dots expression requires matching at least one thread pool. This change makes an ellipsis optional so the thread_pool list can match both the oss distro (without ccr) and default distro (with ccr). Relates #31442
2018-08-27 18:33:57 -04:00
// TESTRESPONSE[s/\.\.\./(node-0 \\S+ 0 0 0\n)*/]
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
// TESTRESPONSE[s/\d+/\\d+/ _cat]
Docs: Use the default distribution to test docs (#31251) This switches the docs tests from the `oss-zip` distribution to the `zip` distribution so they have xpack installed and configured with the default basic license. The goal is to be able to merge the `x-pack/docs` directory into the `docs` directory, marking the x-pack docs with some kind of marker. This is the first step in that process. This also enables `-Dtests.distribution` support for the `docs` directory so you can run the tests against the `oss-zip` distribution with something like ``` ./gradlew -p docs check -Dtests.distribution=oss-zip ``` We can set up Jenkins to run both. Relates to #30665
2018-06-18 12:06:42 -04:00
// The substitutions do two things:
// 1. Expect any number of extra thread pools. This allows us to only list a
// few thread pools. The list would be super long otherwise. In addition,
// if xpack is installed then the list will contain more thread pools and
// this way we don't have to assert about them.
// 2. Expect any number of active, queued, or rejected items. We really don't
// know how many there will be and we just want to assert that there are
// numbers in the response, not *which* numbers are there.
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
The first column is the node name
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
[source,txt]
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
--------------------------------------------------
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
node_name
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
node-0
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
--------------------------------------------------
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
The second column is the thread pool name
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
[source,txt]
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
--------------------------------------------------
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
name
Introduce analyze thread pool (#29541) We want to remove the index thread pool as it is no longer needed since single-document indexing requests are executed as bulk requests now. Analyze requests are also executed on the index thread pool though and they need a thread pool to execute on. The bulk thread does not seem like the right thread pool, let us keep that thread pool conceptually for bulk requests and free for bulk requests. None of the existing thread pools make sense for analyze requests either. The generic thread pool would be a terrible choice since it has an unbounded queue and that is a bad idea for user-facing APIs. This commit introduces a small by default (size=1, queue_size=16) thread pool for analyze requests.
2018-04-17 06:46:15 -04:00
analyze
Docs: Add ccr to the cat thread pool doc test (#31442) Since #31251, we use the default distribution to test docs. With this distribution, the cat thread-pool response will include the ccr thread-pool. This commit adjusts /_cat/thread_pool doc to include ccr. Relates #31251
2018-06-20 20:36:37 -04:00
ccr (default distro only)
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
fetch_shard_started
fetch_shard_store
flush
force_merge
generic
get
listener
management
Docs: Use the default distribution to test docs (#31251) This switches the docs tests from the `oss-zip` distribution to the `zip` distribution so they have xpack installed and configured with the default basic license. The goal is to be able to merge the `x-pack/docs` directory into the `docs` directory, marking the x-pack docs with some kind of marker. This is the first step in that process. This also enables `-Dtests.distribution` support for the `docs` directory so you can run the tests against the `oss-zip` distribution with something like ``` ./gradlew -p docs check -Dtests.distribution=oss-zip ``` We can set up Jenkins to run both. Relates to #30665
2018-06-18 12:06:42 -04:00
ml_autodetect (default distro only)
ml_datafeed (default distro only)
ml_utility (default distro only)
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
refresh
Remove stray back tick that's messing up table format (#41705)
2019-05-21 08:59:40 -04:00
rollup_indexing (default distro only)
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
search
Docs: Use the default distribution to test docs (#31251) This switches the docs tests from the `oss-zip` distribution to the `zip` distribution so they have xpack installed and configured with the default basic license. The goal is to be able to merge the `x-pack/docs` directory into the `docs` directory, marking the x-pack docs with some kind of marker. This is the first step in that process. This also enables `-Dtests.distribution` support for the `docs` directory so you can run the tests against the `oss-zip` distribution with something like ``` ./gradlew -p docs check -Dtests.distribution=oss-zip ``` We can set up Jenkins to run both. Relates to #30665
2018-06-18 12:06:42 -04:00
security-token-key (default distro only)
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
snapshot
warmer
Docs: Use the default distribution to test docs (#31251) This switches the docs tests from the `oss-zip` distribution to the `zip` distribution so they have xpack installed and configured with the default basic license. The goal is to be able to merge the `x-pack/docs` directory into the `docs` directory, marking the x-pack docs with some kind of marker. This is the first step in that process. This also enables `-Dtests.distribution` support for the `docs` directory so you can run the tests against the `oss-zip` distribution with something like ``` ./gradlew -p docs check -Dtests.distribution=oss-zip ``` We can set up Jenkins to run both. Relates to #30665
2018-06-18 12:06:42 -04:00
watcher (default distro only)
Rename the bulk thread pool to write thread pool (#29593) This commit renames the bulk thread pool to the write thread pool. This is to better reflect the fact that the underlying thread pool is used to execute any document write request (single-document index/delete/update requests, and bulk requests). With this change, we add support for fallback settings thread_pool.bulk.* which will be supported until 7.0.0. We also add a system property so that the display name of the thread pool remains as "bulk" if needed to avoid breaking users.
2018-04-19 07:47:20 -04:00
write
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
--------------------------------------------------
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
The next three columns show the active, queue, and rejected statistics for each thread pool
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
[source,txt]
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
--------------------------------------------------
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
active queue rejected
0 0 0
0 0 0
0 0 0
0 0 0
0 0 0
0 0 0
0 0 0
0 0 0
0 0 0
Docs: Add ccr to the cat thread pool doc test (#31442) Since #31251, we use the default distribution to test docs. With this distribution, the cat thread-pool response will include the ccr thread-pool. This commit adjusts /_cat/thread_pool doc to include ccr. Relates #31251
2018-06-20 20:36:37 -04:00
0 0 0
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
1 0 0
0 0 0
0 0 0
0 0 0
0 0 0
Added dedicated thread pool cat api, that can show all thread pool related statistic (size, rejected, queue etc.) for all thread pools (get, search, index etc.) By default active, rejected and queue thread statistics are included for the index, bulk and search thread pool. Other thread statistics of other thread pools can be included via the `h` query string parameter. Closes #4907
2014-01-25 12:20:46 -05:00
--------------------------------------------------
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
The cat thread pool API accepts a `thread_pool_patterns` URL parameter for specifying a
comma-separated list of regular expressions to match thread pool names.
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
[source,js]
--------------------------------------------------
GET /_cat/thread_pool/generic?v&h=id,name,active,rejected,completed
--------------------------------------------------
// CONSOLE
which looks like:
Enforce that responses in docs are valid json (#26249) All of the snippets in our docs marked with `// TESTRESPONSE` are checked against the response from Elasticsearch but, due to the way they are implemented they are actually parsed as YAML instead of JSON. Luckilly, all valid JSON is valid YAML! Unfurtunately that means that invalid JSON has snuck into the exmples! This adds a step during the build to parse them as JSON and fail the build if they don't parse. But no! It isn't quite that simple. The displayed text of some of these responses looks like: ``` { ... "aggregations": { "range": { "buckets": [ { "to": 1.4436576E12, "to_as_string": "10-2015", "doc_count": 7, "key": "*-10-2015" }, { "from": 1.4436576E12, "from_as_string": "10-2015", "doc_count": 0, "key": "10-2015-*" } ] } } } ``` Note the `...` which isn't valid json but we like it anyway and want it in the output. We use substitution rules to convert the `...` into the response we expect. That yields a response that looks like: ``` { "took": $body.took,"timed_out": false,"_shards": $body._shards,"hits": $body.hits, "aggregations": { "range": { "buckets": [ { "to": 1.4436576E12, "to_as_string": "10-2015", "doc_count": 7, "key": "*-10-2015" }, { "from": 1.4436576E12, "from_as_string": "10-2015", "doc_count": 0, "key": "10-2015-*" } ] } } } ``` That is what the tests consume but it isn't valid JSON! Oh no! We don't want to go update all the substitution rules because that'd be huge and, ultimately, wouldn't buy much. So we quote the `$body.took` bits before parsing the JSON. Note the responses that we use for the `_cat` APIs are all converted into regexes and there is no expectation that they are valid JSON. Closes #26233
2017-08-17 09:02:10 -04:00
[source,txt]
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
--------------------------------------------------
id name active rejected completed
0EWUhXeBQtaVGlexUeVwMg generic 0 0 70
--------------------------------------------------
CONSOLEify remaining _cat docs Relates to #18160
2017-05-03 20:58:23 -04:00
// TESTRESPONSE[s/0EWUhXeBQtaVGlexUeVwMg/[\\w-]+/ s/\d+/\\d+/ _cat]
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
[DOCS] Fixed various typos in the 'cat APIs' section (#23216)
2017-02-16 14:41:42 -05:00
Here the host columns and the active, rejected and completed suggest thread pool statistics are displayed.
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
All <<modules-threadpool,built-in thread pools>> and custom thread pools are available.
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
[float]
==== Thread Pool Fields
For each thread pool, you can load details about it by using the field names
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
in the table below.
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
[cols="<,<,<",options="header"]
|=======================================================================
|Field Name |Alias |Description
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
|`type` |`t` |The current (*) type of thread pool (`fixed` or `scaling`)
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
|`active` |`a` |The number of active threads in the current thread pool
Align cat thread pool info to thread pool config (#29195) Today we report thread pool info using a common object. This means that we use a shared set of terminology that is not consistent with the terminology used to the configure thread pools. This holds in particular for the minimum and maximum number of threads in the thread pool where we use the following terminology: thread pool info | fixed | scaling min core size max max size A previous change addressed this for the nodes info API. This commit changes the display of thread pool info in the cat thread pool API too to be dependent on the type of the thread pool so that we can align the terminology in the output of thread pool info with the terminology used to configure a thread pool.
2018-04-03 17:27:26 -04:00
|`pool_size` |`psz` |The number of threads in the current thread pool
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
|`queue` |`q` |The number of tasks in the queue for the current thread pool
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
|`queue_size` |`qs` |The maximum number of tasks permitted in the queue for the current thread pool
|`rejected` |`r` |The number of tasks rejected by the thread pool executor
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
|`largest` |`l` |The highest number of active threads in the current thread pool
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
|`completed` |`c` |The number of tasks completed by the thread pool executor
Align cat thread pool info to thread pool config (#29195) Today we report thread pool info using a common object. This means that we use a shared set of terminology that is not consistent with the terminology used to the configure thread pools. This holds in particular for the minimum and maximum number of threads in the thread pool where we use the following terminology: thread pool info | fixed | scaling min core size max max size A previous change addressed this for the nodes info API. This commit changes the display of thread pool info in the cat thread pool API too to be dependent on the type of the thread pool so that we can align the terminology in the output of thread pool info with the terminology used to configure a thread pool.
2018-04-03 17:27:26 -04:00
|`core` |`cr` |The configured core number of active threads allowed in the current thread pool
|`max` |`mx` |The configured maximum number of active threads allowed in the current thread pool
|`size` |`sz` |The configured fixed number of active threads allowed in the current thread pool
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
|`keep_alive` |`k` |The configured keep alive time for threads
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
|=======================================================================
[float]
=== Other Fields
In addition to details about each thread pool, it is also convenient to get an
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
understanding of where those thread pools reside. As such, you can request
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
other details like the `ip` of the responding node(s).
[cols="<,<,<",options="header"]
|=======================================================================
|Field Name |Alias |Description
Improve cat thread pool API Today, when listing thread pools via the cat thread pool API, thread pools are listed in a column-delimited format. This is unfriendly to command-line tools, and inconsistent with other cat APIs. Instead, thread pools should be listed in a row-delimited format. Additionally, the cat thread pool API is limited to a fixed list of thread pools that excludes certain built-in thread pools as well as all custom thread pools. These thread pools should be available via the cat thread pool API. This commit improves the cat thread pool API by listing all thread pools (built-in or custom), and by listing them in a row-delimited format. Finally, for each node, the output thread pools are sorted by thread pool name. Relates #19721
2016-08-03 23:02:13 -04:00
|`node_id` |`id` |The unique node ID
|`ephemeral_id`|`eid` |The ephemeral node ID
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
|`pid` |`p` |The process ID of the running node
|`host` |`h` |The hostname for the current node
|`ip` |`i` |The IP address for the current node
|`port` |`po` |The bound transport port for the current node
Add Force Merge API, deprecate Optimize API This adds an API for force merging lucene segments. The `/_optimize` API is now deprecated and replaced by the `/_forcemerge` API, which has all the same flags and action, just a different name.
2015-09-17 16:36:25 -04:00
|=======================================================================