Documentation

CAT thread pool

Introduced 1.0

The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.

Endpoints

GET /_cat/thread_pool
GET /_cat/thread_pool/{thread_pool_patterns}

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Parameter Data type Description Default
cluster_manager_timeout String A timeout for connection to the cluster manager node. N/A
format String A short version of the Accept header, such as json or yaml. N/A
h List A comma-separated list of column names to display. N/A
help Boolean Returns help information. false
local Boolean Returns local information but does not retrieve the state from the cluster manager node. false
s List A comma-separated list of column names or column aliases to sort by. N/A
size Integer The multiplier in which to display values. N/A
v Boolean Enables verbose mode, which displays column headers. false

Example requests

The following example request gives information about thread pools on all nodes:

GET _cat/thread_pool?v

If you want to get information for more than one thread pool, separate the thread pool names with commas:

GET _cat/thread_pool/thread_pool_name_1,thread_pool_name_2,thread_pool_name_3

If you want to limit the information to a specific thread pool, add the thread pool name after your query:

GET _cat/thread_pool/<thread_pool_name>?v

Example response

node_name  name                      active queue rejected
odfe-node2 ad-batch-task-threadpool    0     0        0
odfe-node2 ad-threadpool               0     0        0
odfe-node2 analyze                     0     0        0s
350 characters left

Have a question? .

Want to contribute? or .