IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Watcher schedule trigger Watcher always condition »
Elastic Docs ›Elasticsearch Guide [8.11] ›Watcher

Watcher conditions

edit

Watcher conditions

edit

When a watch is triggered, its condition determines whether or not to execute the watch actions. Watcher supports the following condition types:

  • always: The condition always evaluates to true, so the watch actions are always performed.
  • never: The condition always evaluates to false, so the watch actions are never executed.
  • compare: perform simple comparisons against values in the watch payload to determine whether or not to execute the watch actions.
  • array_compare: compare an array of values in the watch payload to a given value to determine whether or not to execute the watch actions.
  • script: use a script to determine whether or not to execute the watch actions.

If you omit the condition definition from a watch, the condition defaults to always.

When a condition is evaluated, it has full access to the watch execution context, including the watch payload (ctx.payload.*). The script, compare and array_compare conditions can use the payload data to determine whether or not the necessary conditions are met.

In addition to the watch wide condition, you can also configure conditions per action.

« Watcher schedule trigger Watcher always condition »