Get Watcher statistics

This API always returns basic metrics. You retrieve more metrics by using the metric parameter.

Required authorization

metric union WatcherMetric | [] WatcherMetric optional

Defines which additional metrics are included in the response.

Supported values include: _all (or all), queued_watches, current_watches, pending_watches

Leave it out to use /_watcher/stats.

Values: _all all queued_watches current_watches pending_watches

application/json

Examples

A successful response from GET _watcher/stats.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _watcher/stats

JavaScript Elasticsearch JavaScript Client

const response = await client.watcher.stats();

Python Elasticsearch Python Client

resp = client.watcher.stats()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_watcher/stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.watcher().stats(s -> s);

PHP Elasticsearch PHP Client

$resp = $client->watcher()->stats();

Ruby Elasticsearch Ruby Client

response = client.watcher.stats

Response

{
  "watcher_state": "started",  
  "watch_count": 1, 
  "execution_thread_pool": {
    "size": 1000, 
    "max_size": 1 
  }
}