Get the hot threads for nodes Generally available

GET /_nodes/{node_id}/hot_threads
Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_nodes/hot_threads

GET /_nodes/{node_id}/hot_threads

Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.

Required authorization

  • Cluster privileges: monitor,manage

Path parameters

  • node_id string | array[string] Required

    List of node IDs or names used to limit returned information.

Query parameters

  • ignore_idle_threads 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.

    Default value is true.

  • interval string

    The interval to do the second sampling of threads.

    Default value is 500ms.

  • snapshots number

    Number of samples of thread stacktrace.

    Default value is 10.

  • threads number

    Specifies the number of hot threads to provide information for.

    Default value is 3.

  • timeout string

    Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

    Default value is 30s.

  • type string

    The type to sample.

    Supported values include:

    • cpu: Threads that consume the most CPU time.
    • wait: Threads that have been in a waiting state the longest.
    • block: Threads that have been blocked the longest.
    • gpu: Threads that consume the most GPU time.
    • mem: Threads that allocate the most memory.

    Default value is cpu.

  • sort string

    The sort order for 'cpu' type

    Supported values include:

    • cpu: Threads that consume the most CPU time.
    • wait: Threads that have been in a waiting state the longest.
    • block: Threads that have been blocked the longest.
    • gpu: Threads that consume the most GPU time.
    • mem: Threads that allocate the most memory.

    Default value is total.

Responses

  • 200 application/json
GET /_nodes/{node_id}/hot_threads 
GET /_nodes/hot_threads

resp = client.nodes.hot_threads()
const response = await client.nodes.hotThreads();
response = client.nodes.hot_threads
$resp = $client->nodes()->hotThreads();
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_nodes/hot_threads"
var response = await client.Nodes.HotThreadsAsync();
client.nodes().hotThreads(h -> h);