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

68 lines
1.7 KiB
Plaintext

[[cluster-nodes-hot-threads]]
=== Nodes hot threads API
++++
<titleabbrev>Nodes hot threads</titleabbrev>
++++
Returns the hot threads on each selected node in the cluster.
[[cluster-nodes-hot-threads-api-request]]
==== {api-request-title}
`GET /_nodes/hot_threads` +
`GET /_nodes/<node_id>/hot_threads`
[[cluster-nodes-hot-threads-api-desc]]
==== {api-description-title}
This API yields a breakdown of the hot threads on each selected node in the
cluster. The output is plain text with a breakdown of each node's top hot
threads.
[[cluster-nodes-hot-threads-api-path-params]]
==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
[[cluster-nodes-hot-threads-api-query-params]]
==== {api-query-parms-title}
`ignore_idle_threads`::
(Optional, boolean) 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.
`interval`::
(Optional, <<time-units, time units>>) The interval to do the second
sampling of threads. Defaults to `500ms`.
`snapshots`::
(Optional, integer) Number of samples of thread stacktrace. Defaults to
`10`.
`threads`::
(Optional, integer) Specifies the number of hot threads to provide
information for. Defaults to `3`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
`type`::
(Optional, string) The type to sample. Available options are `block`, `cpu`, and
`wait`. Defaults to `cpu`.
[[cluster-nodes-hot-threads-api-example]]
==== {api-examples-title}
[source,console]
--------------------------------------------------
GET /_nodes/hot_threads
GET /_nodes/nodeId1,nodeId2/hot_threads
--------------------------------------------------