AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityGenerally available since 5.5This functionality is generally available and ready for production usage.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
This API always returns basic metrics.
You retrieve more metrics by using the metric parameter.
Number of nodes that responded successfully to the request.
failednumberrequired
Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.
cluster_namestringrequired
manually_stoppedbooleanrequired
statsobject[]required
current_watchesobject[]
The current executing watches metric gives insight into the watches that are 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 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 run.
These stack traces can give you more insight into an execution of a watch.
execution_timeuniononeOfrequired
The time the watch was run.
This is just before the input is being run.
The time the watch was triggered by the trigger engine.
One of:stringornumber
executed_actionsstring[]
watch_idstringrequired
watch_record_idstringrequired
The watch record identifier.
execution_thread_poolobjectrequired
max_sizenumberrequired
The largest size of the execution thread pool, which indicates the largest number of concurrent running watches.
queue_sizenumberrequired
The number of watches that were triggered and are currently queued.
queued_watchesobject[]
Watcher moderates the execution of watches such that their execution won't put too much pressure on the node and its resources.
If too many watches trigger concurrently and there isn't enough capacity to run them all, some of the watches are queued, waiting for the current running watches to finish.s
The queued watches metric gives insight on these queued watches.
To include this metric, the metric option should include queued_watches or _all.
execution_timeuniononeOfrequired
The time the watch was run.
This is just before the input is being run.