New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
From version 5.0 onward, Watcher is part of X-Pack. For more information, see Alerting on cluster and index events.
« Introduction Watch Log Data for Errors »
Elastic Docs ›Elasticsearch Watcher [2.0]

Getting Started

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Getting Started

edit

This getting started guide walks you through installing Watcher and creating your first watches, and introduces the building blocks you’ll use to create custom watches. You can install Watcher on nodes running Elasticsearch 2.0.0.

To install and run Watcher:

  1. Run bin/plugin install from ES_HOME to install the License plugin:

    bin/plugin install license

    You need to install the License and Watcher plugins on each node in your cluster.

  2. Run bin/plugin install to install the Watcher plugin.

    bin/plugin install watcher

    If you are using a DEB/RPM distribution of Elasticsearch, run the installation with superuser permissions. To perform an offline installation, download the Watcher binaries.

  3. Start Elasticsearch.

    bin/elasticsearch

  4. To verify that Watcher is set up, call the Watcher _stats API:

    curl -XGET 'http://localhost:9200/_watcher/stats?pretty'

    You haven’t set up any watches yet, so the watch_count is zero and the execution_thread_pool queue is empty:

    {
  "watcher_state": "started",
  "watch_count": 0,
  "execution_thread_pool": {
    "queue_size": 0,
    "max_size": 0
  }
 "manually_stopped" : false
}

Ready to start building watches? Choose one of the following scenarios:

« Introduction Watch Log Data for Errors »
Was this helpful?
Feedback