mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
255c9a7f95
**Problem:** For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. **Solution:** - Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory - Update doc snippet tests to use security Rel: https://github.com/elastic/platform-docs-team/issues/208
42 lines
1.6 KiB
Text
42 lines
1.6 KiB
Text
[role="xpack"]
|
|
[[condition]]
|
|
== {watcher} conditions
|
|
++++
|
|
<titleabbrev>Conditions</titleabbrev>
|
|
++++
|
|
|
|
When a watch is triggered, its condition determines whether or not to execute
|
|
the watch actions. {watcher} supports the following condition types:
|
|
|
|
* <<condition-always,`always`>>: The condition always evaluates to `true`, so the watch actions are always performed.
|
|
* <<condition-never,`never`>>: The condition always evaluates to `false`, so the watch
|
|
actions are never executed.
|
|
* <<condition-compare,`compare`>>: perform simple comparisons against values
|
|
in the watch payload to determine whether or not to execute the watch actions.
|
|
* <<condition-array-compare,`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.
|
|
* <<condition-script,`script`>>: use a script to determine whether or not to
|
|
execute the watch actions.
|
|
|
|
NOTE: 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 <<condition-script,script>>,
|
|
<<condition-compare,compare>> and <<condition-array-compare,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-conditions,action>>.
|
|
|
|
include::condition/always.asciidoc[]
|
|
|
|
include::condition/never.asciidoc[]
|
|
|
|
include::condition/compare.asciidoc[]
|
|
|
|
include::condition/array-compare.asciidoc[]
|
|
|
|
include::condition/script.asciidoc[]
|