OpenSearch/docs/reference/cluster/nodes-hot-threads.asciidoc

30 lines
1.2 KiB
Plaintext

[[cluster-nodes-hot-threads]]
=== Nodes hot_threads
This API yields a breakdown of the hot threads on each selected node in the
cluster. Its endpoints are `/_nodes/hot_threads` and
`/_nodes/{nodes}/hot_threads`:
[source,js]
--------------------------------------------------
GET /_nodes/hot_threads
GET /_nodes/nodeId1,nodeId2/hot_threads
--------------------------------------------------
// CONSOLE
The first command gets the hot threads of all the nodes in the cluster. The
second command gets the hot threads of only `nodeId1` and `nodeId2`. Nodes can
be selected using <<cluster-nodes,node filters>>.
The output is plain text with a breakdown of each node's top hot threads. The
allowed parameters are:
[horizontal]
`threads`:: number of hot threads to provide, defaults to 3.
`interval`:: the interval to do the second sampling of threads.
Defaults to 500ms.
`type`:: The type to sample, defaults to cpu, but supports wait and
block to see hot threads that are in wait or block state.
`ignore_idle_threads`:: If true, known idle threads (e.g. waiting in a socket select, or to
get a task from an empty queue) are filtered out. Defaults to true.