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

128 lines
4.4 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
Docs: Use "js" instead of "json" and "sh" instead of "shell" for source highlighting
2015-07-14 12:14:09 -04:00
[source,sh]
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
--------------------------------------------------
% curl 192.168.56.10:9200/_cat/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
0EWUhXe bulk 0 0 0
0EWUhXe fetch_shard_started 0 0 0
0EWUhXe fetch_shard_store 0 0 0
0EWUhXe flush 0 0 0
0EWUhXe force_merge 0 0 0
0EWUhXe generic 0 0 0
0EWUhXe get 0 0 0
0EWUhXe index 0 0 0
0EWUhXe listener 0 0 0
0EWUhXe management 1 0 0
0EWUhXe refresh 0 0 0
0EWUhXe search 0 0 0
0EWUhXe snapshot 0 0 0
0EWUhXe warmer 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 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
Docs: Use "js" instead of "json" and "sh" instead of "shell" for source highlighting
2015-07-14 12:14:09 -04:00
[source,sh]
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
0EWUhXe
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
Docs: Use "js" instead of "json" and "sh" instead of "shell" for source highlighting
2015-07-14 12:14:09 -04:00
[source,sh]
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
bulk
fetch_shard_started
fetch_shard_store
flush
force_merge
generic
get
index
listener
management
refresh
search
snapshot
warmer
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
Docs: Use "js" instead of "json" and "sh" instead of "shell" for source highlighting
2015-07-14 12:14:09 -04:00
[source,sh]
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
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
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
[source,sh]
--------------------------------------------------
% curl 'localhost:9200/_cat/thread_pool/generic?v&h=id,name,active,rejected,completed'
id name active rejected completed
0EWUhXeBQtaVGlexUeVwMg generic 0 0 70
--------------------------------------------------
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
|`size` |`s` |The number of threads in the current thread pool
|`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
Added type, max, min, queueSize & keepAlive to _cat/thread_pool Closes #5366
2014-03-27 02:46:11 -04:00
|`min` |`mi` |The configured minimum number of active threads allowed in the current thread pool
|`max` |`ma` |The configured maximum 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
|=======================================================================