nodes-hot-threads.asciidoc 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. [[cluster-nodes-hot-threads]]
  2. === Nodes hot_threads
  3. Returns the hot threads on each selected node in the cluster.
  4. [[cluster-nodes-hot-threads-api-request]]
  5. ==== {api-request-title}
  6. `GET /_nodes/hot_threads` +
  7. `GET /_nodes/<node_id>/hot_threads`
  8. [[cluster-nodes-hot-threads-api-desc]]
  9. ==== {api-description-title}
  10. This API yields a breakdown of the hot threads on each selected node in the
  11. cluster. The output is plain text with a breakdown of each node's top hot
  12. threads.
  13. [[cluster-nodes-hot-threads-api-path-params]]
  14. ==== {api-path-parms-title}
  15. include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id]
  16. [[cluster-nodes-hot-threads-api-query-params]]
  17. ==== {api-query-parms-title}
  18. `ignore_idle_threads`::
  19. (Optional, boolean) If true, known idle threads (e.g. waiting in a socket
  20. select, or to get a task from an empty queue) are filtered out. Defaults to
  21. true.
  22. `interval`::
  23. (Optional, <<time-units, time units>>) The interval to do the second
  24. sampling of threads. Defaults to `500ms`.
  25. `snapshots`::
  26. (Optional, integer) Number of samples of thread stacktrace. Defaults to
  27. `10`.
  28. `threads`::
  29. (Optional, integer) Specifies the number of hot threads to provide
  30. information for. Defaults to `3`.
  31. include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
  32. `type`::
  33. (Optional, string) The type to sample. Available options are `block`, `cpu`, and
  34. `wait`. Defaults to `cpu`.
  35. [[cluster-nodes-hot-threads-api-example]]
  36. ==== {api-examples-title}
  37. [source,js]
  38. --------------------------------------------------
  39. GET /_nodes/hot_threads
  40. GET /_nodes/nodeId1,nodeId2/hot_threads
  41. --------------------------------------------------
  42. // CONSOLE