Get thread pool statistics
Generally available
All methods and paths for this operation:
Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
Required authorization
- Cluster privileges:
monitor
Path parameters
-
A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.
Query parameters
-
List of columns to appear in the response. Supports simple wildcards.
Supported values include:
active(ora): Number of active threads in the current thread pool.completed(orc): Number of tasks completed by the thread pool executor.core(orcr): Configured core number of active threads allowed in the current thread pool.ephemeral_id(oreid): Ephemeral node ID.host(orh): Hostname for the current node.ip(ori): IP address for the current node.keep_alive(ork): Configured keep alive time for threads.largest(orl): Highest number of active threads in the current thread pool.max(ormx): Configured maximum number of active threads allowed in the current thread pool.name: Name of the thread pool, such asanalyzeorgeneric.node_id(orid): ID of the node, such ask0zy.node_name: Node name, such asI8hydUG.pid(orp): Process ID of the running node.pool_size(orpsz): Number of threads in the current thread pool.port(orpo): Bound transport port for the current node.queue(orq): Number of tasks in the queue for the current thread pool.queue_size(orqs): Maximum number of tasks permitted in the queue for the current thread pool.rejected(orr): Number of tasks rejected by the thread pool executor.size(orsz): Configured fixed number of active threads allowed in the current thread pool.type(ort): Type of thread pool. Returned values arefixed,fixed_auto_queue_size,direct, orscaling.
Values are
active,a,completed,c,core,cr,ephemeral_id,eid,host,h,ip,i,keep_alive,k,largest,l,max,mx,name,node_id,id,node_name,pid,p,pool_size,psz,port,po,queue,q,queue_size,qs,rejected,r,size,sz,type, ort. -
A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting
:ascor:descas a suffix to the column name. -
The unit used to display time values.
Values are
nanos,micros,ms,s,m,h, ord. -
If
true, the request computes the list of selected nodes from the local cluster state. Iffalsethe list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. -
The period to wait for a connection to the master node.
Values are
-1or0.
GET /_cat/thread_pool?format=json
resp = client.cat.thread_pool(
format="json",
)const response = await client.cat.threadPool({
format: "json",
});response = client.cat.thread_pool(
format: "json"
)$resp = $client->cat()->threadPool([
"format" => "json",
]);curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/thread_pool?format=json"client.cat().threadPool();
[
{
"node_name": "node-0",
"name": "analyze",
"active": "0",
"queue": "0",
"rejected": "0"
},
{
"node_name": "node-0",
"name": "fetch_shard_started",
"active": "0",
"queue": "0",
"rejected": "0"
},
{
"node_name": "node-0",
"name": "fetch_shard_store",
"active": "0",
"queue": "0",
"rejected": "0"
},
{
"node_name": "node-0",
"name": "flush",
"active": "0",
"queue": "0",
"rejected": "0"
},
{
"node_name": "node-0",
"name": "write",
"active": "0",
"queue": "0",
"rejected": "0"
}
][
{
"id": "0EWUhXeBQtaVGlexUeVwMg",
"name": "generic",
"active": "0",
"rejected": "0",
"completed": "70"
}
]