How Watcher Works

You add watches to automatically perform an action when certain conditions are met. The conditions are generally based on data you’ve loaded into the watch, also known as the Watch Payload. This payload can be loaded from different sources - from Elasticsearch, an external HTTP service, or even a combination of the two.

For example, you could configure a watch to send an email to the sysadmin when a search in the logs data indicates that there are too many 503 errors in the last 5 minutes.

This topic describes the elements of a watch and how watches operate.

A watch consists of a trigger, input, condition, and actions. The actions define what needs to be done once the condition is met. In addition, you can define conditions and transforms to process and prepare the watch payload before executing the actions.

For example, the following snippet shows a Put Watch request that defines a watch that looks for log error events:

PUT _xpack/watcher/watch/log_errors
{
  "metadata" : { 
    "color" : "red"
  },
  "trigger" : { 
    "schedule" : {
      "interval" : "5m"
    }
  },
  "input" : { 
    "search" : {
      "request" : {
        "indices" : "log-events",
        "body" : {
          "size" : 0,
          "query" : { "match" : { "status" : "error" } }
        }
      }
    }
  },
  "condition" : { 
    "compare" : { "ctx.payload.hits.total" : { "gt" : 5 }}
  },
  "transform" : { 
    "search" : {
        "request" : {
          "indices" : "log-events",
          "body" : {
            "query" : { "match" : { "status" : "error" } }
          }
        }
    }
  },
  "actions" : { 
    "my_webhook" : {
      "webhook" : {
        "method" : "POST",
        "host" : "mylisteninghost",
        "port" : 9200,
        "path" : "/{{watch_id}}",
        "body" : "Encountered {{ctx.payload.hits.total}} errors"
      }
    },
    "email_administrator" : {
      "email" : {
        "to" : "[email protected]",
        "subject" : "Encountered {{ctx.payload.hits.total}} errors",
        "body" : "Too many error in the system, see attached data",
        "attachments" : {
          "attached_data" : {
            "data" : {
              "format" : "json"
            }
          }
        },
        "priority" : "high"
      }
    }
  }
}

When you add a watch, Watcher immediately registers its trigger with the appropriate trigger engine. Watches that have a schedule trigger are registered with the scheduler trigger engine.

The scheduler tracks time and triggers watches according to their schedules. The scheduler runs on the master node and is bound to the lifecycle of the Watcher service. When the Watcher service is stopped, the scheduler stops with it. Trigger engines use a separate thread pool from the one used to execute watches.

When a watch is triggered, Watcher queues it up for execution. A watch_record document is created and added to the watch history and the watch’s status is set to awaits_execution.

When execution starts, Watcher creates a watch execution context for the watch. The execution context provides scripts and templates with access to the watch metadata, payload, watch ID, execution time, and trigger information. For more information, see Watch Execution Context.

During the execution process, Watcher:

When the watch execution finishes, the execution result is recorded as a Watch Record in the watch history. The watch record includes the execution time and duration, whether the watch condition was met, and the status of each action that was executed.

The following diagram shows the watch execution process:

Watcher supports both time-based and acknowledgment-based throttling. This enables you to prevent actions from being repeatedly executed for the same event.

By default, Watcher uses time-based throttling with a throttle period of 5 seconds. This means that if a watch is executed every second, its actions are performed a maximum of once every 5 seconds, even when the condition is always met. You can configure the throttle period on a per-action basis or at the watch level.

Acknowledgment-based throttling enables you to tell Watcher not to send any more notifications about a watch as long as its condition is met. Once the condition evaluates to false, the acknowledgment is cleared and Watcher resumes executing the watch actions normally.

For more information, see Acknowledgement and Throttling.

By default, when you add a watch it is immediately set to the active state, registered with the appropriate trigger engine, and executed according to its configured trigger.

You can also set a watch to the inactive state. Inactive watches are not registered with a trigger engine and can never be triggered.

To set a watch to the inactive state when you create it, set the active parameter to inactive. To deactivate an existing watch, use the Deactivate Watch API. To reactivate an inactive watch, use the Activate Watch API.

Deactivating watches is useful in a variety of situations. For example, if you have a watch that monitors an external system and you need to take that system down for maintenance, you can deactivate the watch to prevent it from falsely reporting availability issues during the maintenance window.

Deactivating a watch also enables you to keep it around for future use without deleting it from the system.

You can use scripts and templates when defining a watch. Scripts and templates can reference elements in the watch execution context, including the watch payload. The execution context defines variables you can use in a script and parameter placeholders in a template.

Watcher uses the Elasticsearch script infrastructure, which supports inline, stored, and file-based scripts. Scripts and templates are compiled and cached by Elasticsearch to optimize recurring execution. Autoloading is also supported. For more information, see Scripting and How to use scripts in the Elasticsearch Reference.

The following snippet shows the basic structure of the Watch Execution Context:

{
  "ctx" : {
    "metadata" : { ... }, 
    "payload" : { ... }, 
    "watch_id" : "<id>", 
    "execution_time" : "20150220T00:00:10Z", 
    "trigger" : { 
      "triggered_time" : "20150220T00:00:10Z",
      "scheduled_time" : "20150220T00:00:00Z"
    },
    "vars" : { ... } 
}

You can use scripts to define conditions and transforms. The default scripting language is Painless.

Scripts can reference any of the values in the watch execution context or values explicitly passed through script parameters.

For example, if the watch metadata contains a color field (e.g. "metadata" : {"color": "red"}), you can access its value with the via the ctx.metadata.color variable. If you pass in a color parameter as part of the condition or transform definition (e.g. "params" : {"color": "red"}), you can access its value via the color variable.

You use templates to define dynamic content for a watch. At execution time, templates pull in data from the watch execution context. For example, you can use a template to populate the subject field for an email action with data stored in the watch payload. Templates can also access values explicitly passed through template parameters.

You specify templates using the Mustache scripting language.

For example, the following snippet shows how templates enable dynamic subjects in sent emails:

{
  "actions" : {
    "email_notification" : {
      "email" : {
        "subject" : "{{ctx.metadata.color}} alert"
      }
    }
  }
}

To define an inline template or script, you simply specify it directly in the value of a field. For example, the following snippet configures the subject of the email action using an inline template that references the color value in the context metadata.

"actions" : {
  "email_notification" : {
     "email" : {
       "subject" : "{{ctx.metadata.color}} alert"
     }
   }
  }
}

For a script, you simply specify the inline script as the value of the script field. For example:

"condition" : {
  "script" : "return true"
}

You can also explicitly specify the inline type by using a formal object definition as the field value. For example:

"actions" : {
  "email_notification" : {
    "email" : {
      "subject" : {
         "source" : "{{ctx.metadata.color}} alert"
      }
    }
  }
}

The formal object definition for a script would be:

"condition" : {
  "script" : {
    "source": "return true"
  }
}

If you store your templates and scripts, you can reference them by id.

To reference a stored script or template, you use the formal object definition and specify its id in the id field. For example, the following snippet references the email_notification_subject template:

{
  ...
  "actions" : {
    "email_notification" : {
      "email" : {
        "subject" : {
          "id" : "email_notification_subject",
          "params" : {
            "color" : "red"
          }
        }
      }
    }
  }
}

If you store templates or scripts in the $ES_HOME/config/scripts directory, you can reference them by name. Template files must be saved with the extension .mustache. Script files must be saved with the appropriate file extension, such as .painless.

To reference a file-based stored or script, you use the formal object definition and specify its name in the file field. For example, the following snippet references the script file threshold_hits.painless:

"condition" : {
    "script" : {
      "file" : "threshold_hits",
      "params" : {
        "threshold" : 0
      }
    }
  }