54 lines
2.4 KiB
Text
54 lines
2.4 KiB
Text
[[watcher-create-advanced-watch]]
|
|
=== Create Advanced Watch
|
|
|
|
Advanced watches are for people who are more familiar with Elasticsearch query syntax and the watcher framework overall. The creation UI is more closely aligned with using the REST apis directly. For
|
|
more information, see {ref}/query-dsl.html[Query DSL].
|
|
|
|
To create an advanced watch:
|
|
|
|
* Click the *Create advanced watch* button.
|
|
|
|
==== Advanced Watch UI
|
|
|
|
This screen lets you define the core properties of an advanced watch.
|
|
|
|
[role="screenshot"]
|
|
image:management/watcher-ui/images/advanced-watch/advanced-watch-create.png["Create Advanced Watch",link="management/watcher-ui/images/advanced-watch/advanced-watch-create.png"]
|
|
|
|
The `ID` refers to the identifier used by Elasticsearch, whereas `Name` is the more user-friendly way to identify the watch. Refer to the
|
|
{stack-ov}/how-watcher-works.html#watch-definition[Watch definition documentation]
|
|
for the Watch JSON.
|
|
|
|
[float]
|
|
=== Simulate
|
|
|
|
[role="screenshot"]
|
|
image:management/watcher-ui/images/advanced-watch/advanced-watch-simulate.png["Simulate Advanced Watch",link="management/watcher-ui/images/advanced-watch/advanced-watch-simulate.png"]
|
|
|
|
This screen allows you to override parts of the watch and then run a simulation of it.
|
|
|
|
Some implementation details on overrides:
|
|
|
|
* Trigger overrides use {ref}/common-options.html#date-math[date math].
|
|
* Input override accepts a JSON blob that overrides the `input`.
|
|
* Condition overrides is just a checkbox to indicate if you want to force the condition to always be true.
|
|
* Action overrides support multiple options, which are {ref}/watcher-api-execute-watch.html#watcher-api-execute-watch-action-mode[explained here].
|
|
|
|
[float]
|
|
=== Simulated
|
|
|
|
After starting the simulation, the UI will show a results screen.
|
|
|
|
[role="screenshot"]
|
|
image:management/watcher-ui/images/advanced-watch/advanced-watch-simulated.png["Simulated Advanced Watch",link="management/watcher-ui/images/advanced-watch/advanced-watch-simulated.png"]
|
|
|
|
The possible simulation statuses for watches are:
|
|
|
|
* `Firing` - The watch is currently triggered and is actively performing the associated actions.
|
|
* `Error` - The watch is an error state and not properly working.
|
|
* `Ok` - The watch is not actively firing but working properly.
|
|
* `Disabled` - The watch will not fire under any circumstance.
|
|
|
|
For more information on the various fields in the response, see the
|
|
{ref}/watcher-api-execute-watch.html[Execute Watch API].
|
|
|