Resurrect hot_threads routes #73855
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| { | ||
| "nodes.hotthreads":{ | ||
| "documentation":{ | ||
| "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html", | ||
| "description":"Returns information about hot threads on each node in the cluster." | ||
| }, | ||
| "stability":"stable", | ||
| "visibility":"public", | ||
| "headers":{ | ||
| "accept": [ "text/plain"] | ||
| }, | ||
| "url":{ | ||
| "paths":[ | ||
| { | ||
| "path":"/_cluster/nodes/hotthreads", | ||
| "methods":[ | ||
| "GET" | ||
| ] | ||
| }, | ||
| { | ||
| "path":"/_cluster/nodes/hot_threads", | ||
| "methods":[ | ||
| "GET" | ||
| ] | ||
| }, | ||
| { | ||
| "path":"/_clusters/nodes/{node_id}/hotthreads", | ||
| "methods":[ | ||
| "GET" | ||
| ], | ||
| "parts":{ | ||
| "node_id":{ | ||
| "type":"list", | ||
| "description":"A comma-separated list of node IDs or names to limit the returned information; leave empty to get information from all nodes" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "path":"/_clusters/nodes/{node_id}/hot_threads", | ||
| "methods":[ | ||
| "GET" | ||
| ], | ||
| "parts":{ | ||
| "node_id":{ | ||
| "type":"list", | ||
| "description":"A comma-separated list of node IDs or names to limit the returned information; leave empty to get information from all nodes" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "path":"/_nodes/hotthreads", | ||
| "methods":[ | ||
| "GET" | ||
| ] | ||
| }, | ||
| { | ||
| "path":"/_nodes/{node_id}/hotthreads", | ||
| "methods":[ | ||
| "GET" | ||
| ], | ||
| "parts":{ | ||
| "node_id":{ | ||
| "type":"list", | ||
| "description":"A comma-separated list of node IDs or names to limit the returned information; 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)" | ||
| }, | ||
| "timeout":{ | ||
| "type":"time", | ||
| "description":"Explicit operation timeout" | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| setup: | ||
| - skip: | ||
| version: "9.0.0 - " | ||
| reason: "compatible from 8.x to 7.x" | ||
| features: | ||
| - "headers" | ||
| - "warnings_regex" | ||
|
|
||
| --- | ||
| "Get hot threads": | ||
|
|
||
| - do: | ||
| headers: | ||
| Content-Type: "application/vnd.elasticsearch+json;compatible-with=7" | ||
| Accept: "application/vnd.elasticsearch+json;compatible-with=7" | ||
| nodes.hotthreads: {} | ||
| warnings_regex: | ||
| - ".*hot_?threads.* is a deprecated endpoint.*" | ||
| - match: | ||
| $body: /:::/ | ||
|
There was a problem hiding this comment. This There was a problem hiding this comment. Anyway, there is a |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would it more correct to re-introduce this path (and the like) as deprecated in the spec for 7.x and add the allowed warning (for any tests that call this API) ?
This would allow you to avoid introducing the spec only for compatibility.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like that idea! Just to make sure I'm following -- that'd be a PR pointed at 7.x (no version that hits master) that adds these as deprecated endpoints to the
rest-api-spec, and then in this PR we wouldn't need a new test or any specs, because this would all execute automatically by way of theyamlRestCompatTesttests.Is there any downside to adding these as deprecated in 7.x? I'm thinking, for example, that perhaps the autogenerated client code might actually start using them (if so, that'd be strictly worse, and we probably wouldn't want to go this way).
@pgomulka what do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i like that idea too!
if a test client will use it, maybe we can ignore the warning in 7.x for this? Like we do for types removal in 7.x
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, that is what i meant. I think it works well in this case (and any other one off cases) since it probably should have been that way from the start and should have minimal pollution in 7.x.
However, I don't think this should be a rule of thumb for all missing paths. For example, for the
_xpack/prefix i can see the argument for not polluting 7.x since there are so many, somewhat inconsistent (depending on when it was added), and has a lot of associated tests that would need to allow warnings.