Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Watcher: fix metric stats names #34951

Merged
merged 3 commits into from Nov 1, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions x-pack/docs/en/rest-api/watcher/stats.asciidoc
Expand Up @@ -25,7 +25,7 @@ currently being executed by {watcher}. Additional information is shared per
watch that is currently executing. This information includes the `watch_id`,
the time its execution started and its current execution phase.

To include this metric, the `metric` option should be set to `executing_watches`
To include this metric, the `metric` option should be set to `current_watches`
or `_all`. In addition you can also specify the `emit_stacktraces=true`
parameter, which adds stack traces for each watch that is being executed. These
stack traces can give you more insight into an execution of a watch.
Expand All @@ -51,7 +51,7 @@ To include this metric, the `metric` option should include `queued_watches` or

`metric`::
(enum) Defines which additional metrics are included in the response.
`executing_watches`::: Includes the current executing watches in the response.
`current_watches`::: Includes the current executing watches in the response.
`queued_watches`::: Includes the watches queued for execution in the response.
`_all`::: Includes all metrics in the response.

Expand Down Expand Up @@ -98,7 +98,7 @@ and will include the basic metrics and metrics about the current executing watch

[source,js]
--------------------------------------------------
GET _xpack/watcher/stats?metric=executing_watches
GET _xpack/watcher/stats?metric=current_watches
--------------------------------------------------
// CONSOLE

Expand Down
Expand Up @@ -8,14 +8,14 @@
"parts": {
"metric": {
"type" : "enum",
"options" : ["_all", "queued_watches", "pending_watches"],
"options" : ["_all", "queued_watches", "current_watches", "pending_watches"],
"description" : "Controls what additional stat metrics should be include in the response"
}
},
"params": {
"metric": {
"type" : "enum",
"options" : ["_all", "queued_watches", "pending_watches"],
"options" : ["_all", "queued_watches", "current_watches", "pending_watches"],
"description" : "Controls what additional stat metrics should be include in the response"
},
"emit_stacktraces": {
Expand Down
Expand Up @@ -12,3 +12,55 @@
emit_stacktraces: "true"
- match: { "manually_stopped": false }
- match: { "stats.0.watcher_state": "started" }

---
"Test watcher stats current watches":
- skip:
version: " - 6.99.99"
reason: materics were fixed in 7.0.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: metrics?


- do:
xpack.watcher.stats:
metric: "current_watches"

- is_false: stats.0.queued_watches
- is_true: stats.0.current_watches

---
"Test watcher stats queued watches":
- skip:
version: " - 6.99.99"
reason: materics were fixed in 7.0.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: metrics?


- do:
xpack.watcher.stats:
metric: "queued_watches"

- is_false: stats.0.current_watches
- is_true: stats.0.queued_watches

---
"Test watcher stats queued watches using pending_watches":
- skip:
version: " - 6.99.99"
reason: materics were fixed in 7.0.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: metrics?

features: warnings

- do:
warnings:
- 'The pending_watches parameter is deprecated, use queued_watches instead'

xpack.watcher.stats:
metric: "pending_watches"

- is_false: stats.0.current_watches
- is_true: stats.0.queued_watches

---
"Test watcher stats all watches":
- do:
xpack.watcher.stats:
metric: "_all"

- is_true: stats.0.current_watches
- is_true: stats.0.queued_watches
Expand Up @@ -5,6 +5,9 @@
*/
package org.elasticsearch.xpack.watcher.rest.action;

import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;
import org.elasticsearch.common.logging.DeprecationLogger;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.rest.RestController;
Expand All @@ -21,6 +24,9 @@
import static org.elasticsearch.rest.RestRequest.Method.GET;

public class RestWatcherStatsAction extends WatcherRestHandler {
private static final Logger logger = LogManager.getLogger(RestWatcherStatsAction.class);
private static final DeprecationLogger deprecationLogger = new DeprecationLogger(logger);

public RestWatcherStatsAction(Settings settings, RestController controller) {
super(settings);
controller.registerHandler(GET, URI_BASE + "/stats", this);
Expand All @@ -41,8 +47,12 @@ protected RestChannelConsumer doPrepareRequest(final RestRequest restRequest, Wa
request.includeCurrentWatches(true);
request.includeQueuedWatches(true);
} else {
request.includeCurrentWatches(metrics.contains("queued_watches"));
request.includeQueuedWatches(metrics.contains("pending_watches"));
request.includeCurrentWatches(metrics.contains("current_watches"));
request.includeQueuedWatches(metrics.contains("queued_watches") || metrics.contains("pending_watches"));
}

if (metrics.contains("pending_watches")) {
deprecationLogger.deprecated("The pending_watches parameter is deprecated, use queued_watches instead");
}


Expand Down