mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[DOCS] Fixes URLs in Kibana Watcher info (#19151)
This commit is contained in:
parent
0ad665f216
commit
a36a043ffe
4 changed files with 19 additions and 13 deletions
|
@ -1,7 +1,8 @@
|
|||
[[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. Please reference the https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html[Elasticsearch query DSL] for more information.
|
||||
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 a new advanced watch:
|
||||
|
||||
|
@ -16,7 +17,9 @@ This screen lets you define the core properties of an advanced watch.
|
|||
|
||||
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 https://www.elastic.co/guide/en/x-pack/current/how-watcher-works.html#watch-definition[Watch definition documentation] for the Watch JSON.
|
||||
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
|
||||
|
@ -27,10 +30,10 @@ This screen allows you to override parts of the watch and then run a simulation
|
|||
|
||||
Some implementation details on overrides:
|
||||
|
||||
* Trigger overrides use https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#date-math[date math]
|
||||
* 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 https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html#watcher-api-execute-watch-action-mode[explained here]
|
||||
* Action overrides support multiple options, which are {ref}/watcher-api-execute-watch.html#watcher-api-execute-watch-action-mode[explained here].
|
||||
|
||||
[float]
|
||||
=== Simulated
|
||||
|
@ -46,5 +49,6 @@ The possible simulation statuses for watches are:
|
|||
* `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, https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html[please refer to the Elasticsearch docs].
|
||||
For more information on the various fields in the response, see the
|
||||
{ref}/watcher-api-execute-watch.html[Execute Watch API].
|
||||
|
||||
|
|
|
@ -61,15 +61,17 @@ Selecting an action will allow you to customize settings for the respective acti
|
|||
|
||||
image:management/watcher-ui/images/threshold-alert/threshold-alert-action.png["Threshold Alert Logging Action",link="management/watcher-ui/images/threshold-alert/threshold-alert-action.png"]
|
||||
|
||||
All fields for an alert support using http://mustache.github.io/mustache.5.html[mustache syntax] and expose a `{{ctx}}` variable which exposes https://www.elastic.co/guide/en/watcher/current/condition.html#accessing-watch-payload[various properties of the alert]
|
||||
All fields for an alert support using http://mustache.github.io/mustache.5.html[mustache syntax] and expose a `{{ctx}}` variable which exposes {stack-ov}/condition-script.html#accessing-watch-payload[various properties of the alert]
|
||||
|
||||
The supported actions are:
|
||||
|
||||
* https://www.elastic.co/guide/en/watcher/current/actions.html#actions-slack[Slack]
|
||||
* https://www.elastic.co/guide/en/watcher/current/actions.html#actions-logging[Logging]
|
||||
* https://www.elastic.co/guide/en/watcher/current/actions.html#actions-email[Email]
|
||||
* {stack-ov}/actions-slack.html[Slack]
|
||||
* {stack-ov}/actions-logging.html[Logging]
|
||||
* {stack-ov}/actions-email.html[Email]
|
||||
|
||||
Note that certain actions require configuration within ES, such as https://www.elastic.co/guide/en/x-pack/current/actions-email.html#configuring-email[email] and https://www.elastic.co/guide/en/x-pack/current/actions-slack.html#configuring-slack[slack].
|
||||
Note that certain actions require configuration within {es}, such as
|
||||
{stack-ov}/actions-email.html#configuring-email[email] and
|
||||
{stack-ov}/actions-slack.html#configuring-slack[slack].
|
||||
|
||||
include::create-advanced-watch.asciidoc[]
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
[[watcher-ui]]
|
||||
== Watcher UI
|
||||
|
||||
_Watcher UI_ enables you to monitor, manage, create and simulate {xpack-ref}/xpack-alerting.html[watches] for your Elasticsearch
|
||||
indices.
|
||||
_Watcher UI_ enables you to monitor, manage, create and simulate
|
||||
{stack-ov}/xpack-alerting.html[watches] for your Elasticsearch indices.
|
||||
|
||||
include::getting-started.asciidoc[]
|
||||
|
|
|
@ -7,4 +7,4 @@ The Watcher UI requires a user with `kibana_user` and the user must have either
|
|||
|
||||
`watcher_user` can view all existing watches, but is not able to create or edit watches.
|
||||
|
||||
Learn more about creating users and roles in the https://www.elastic.co/guide/en/kibana/current/xpack-security.html[Security documentation].
|
||||
Learn more about creating users and roles in <<xpack-security>>.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue