OpenSearch/rest-api-spec/api/nodes.hot_threads.json
Michael McCandless 242e631e95 Core: ignore known idle threads by default in /_nodes/hot_threads
Add a new ignore_idle_threads boolean option (default true) to
/_nodes/hot_threads, to filter out threads in known idle places like
waiting on a socket select or on pulling the next task from an empty
queue.

Closes #8985

Closes #8908
2014-12-17 11:59:31 -05:00

41 lines
1.7 KiB
JSON

{
"nodes.hot_threads": {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html",
"methods": ["GET"],
"url": {
"path": "/_nodes/hot_threads",
"paths": ["/_cluster/nodes/hotthreads", "/_cluster/nodes/hot_threads", "/_cluster/nodes/{node_id}/hotthreads", "/_cluster/nodes/{node_id}/hot_threads", "/_nodes/hotthreads", "/_nodes/hot_threads", "/_nodes/{node_id}/hotthreads", "/_nodes/{node_id}/hot_threads"],
"parts": {
"node_id": {
"type" : "list",
"description" : "A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes"
}
},
"params": {
"interval": {
"type" : "time",
"description" : "The interval for the second sampling of threads"
},
"snapshots": {
"type" : "number",
"description" : "Number of samples of thread stacktrace (default: 10)"
},
"threads": {
"type" : "number",
"description" : "Specify the number of threads to provide information for (default: 3)"
},
"ignore_idle_threads": {
"type" : "boolean",
"description" : "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)"
},
"type": {
"type" : "enum",
"options" : ["cpu", "wait", "block"],
"description" : "The type to sample (default: cpu)"
}
}
},
"body": null
}
}