[DOCS] Qualified Watcher topics to distinguish from Kib Alerting (#65908

) (#66064) * [DOCS] Qualified Watcher topics to distinguish from Kib Alerting * Reverted actions anchor due to client links. * Updated redirects. * Fixed links. * Roll back anchor changes * Apply suggestions from code review Co-authored-by: James Rodewig <[email protected]> * Incorporated review comments.
elastic · Dec 8, 2020 · 1a212bc · 1a212bc
1 parent bcb8ca0
commit 1a212bc
Show file tree

Hide file tree

Showing 38 changed files with 171 additions and 438 deletions.
diff --git a/x-pack/docs/en/watcher/actions.asciidoc b/x-pack/docs/en/watcher/actions.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[actions]]
-== Actions
+== {watcher} actions
+++++
+<titleabbrev>Actions</titleabbrev>
+++++
 
 When a watch's condition is met, its actions are executed unless it is being
 <<actions-ack-throttle,throttled>>. A watch can perform multiple actions.
@@ -15,10 +18,14 @@ Actions have access to the payload in the execution context. They can use it to
 support their execution in any way they need. For example, the payload might
 serve as a model for a templated email body.
 
-{watcher} supports the following types of actions:
-<<actions-email,`email`>>, <<actions-webhook,`webhook`>>, <<actions-index,`index`>>,
-<<actions-logging,`logging`>>, <<actions-slack,`slack`>>,
-and <<actions-pagerduty,`pagerduty`>>.
+{watcher} supports the following actions:
+
+* <<actions-email,`email`>>
+* <<actions-webhook,`webhook`>>
+* <<actions-index,`index`>>
+* <<actions-logging,`logging`>>
+* <<actions-slack,`slack`>>
+* <<actions-pagerduty,`pagerduty`>>
 
 [discrete]
 [[actions-ack-throttle]]
@@ -189,6 +196,21 @@ of a watch during its execution:
 
 image::images/action-throttling.jpg[align="center"]
 
+[discrete]
+[[actions-ssl-openjdk]]
+=== Using SSL/TLS with OpenJDK
+
+As each distributor is free to choose how to package OpenJDK, it may happen,
+that even despite the exact same version, an OpenJDK distribution contains
+different parts under different Linux distributions.
+
+This can lead to issues with any action or input that uses TLS, like the `jira`,
+`pagerduty`, `slack`, or `webhook` one, because of missing CA certs.
+If you encounter TLS errors, when writing watches that connect to TLS endpoints,
+you should try to upgrade to the latest available OpenJDK distribution for your
+platform and if that does not help, try to upgrade to Oracle JDK.
+
+
 [role="xpack"]
 [[action-foreach]]
 === Running an action for each element in an array
@@ -237,7 +259,10 @@ PUT _watcher/watch/log_event_watch
 
 [role="xpack"]
 [[action-conditions]]
-=== Adding conditions to actions
+=== Adding conditions to {watcher} actions
+++++
+<titleabbrev>Adding conditions to actions</titleabbrev>
+++++
 
 When a watch is triggered, its condition determines whether or not to execute the
 watch actions. Within each action, you can also add a condition per action. These
@@ -302,6 +327,7 @@ PUT _watcher/watch/log_event_watch
 <1> A `condition` that only applies to the `notify_pager` action, which
     restricts its execution to when the condition succeeds (at least 5 hits in this case).
 
+
 include::actions/email.asciidoc[]
 
 include::actions/webhook.asciidoc[]
@@ -316,16 +342,3 @@ include::actions/pagerduty.asciidoc[]
 
 include::actions/jira.asciidoc[]
 
-[discrete]
-[[actions-ssl-openjdk]]
-=== Using SSL/TLS with OpenJDK
-
-As each distributor is free to choose how to package OpenJDK, it may happen,
-that even despite the exact same version, an OpenJDK distribution contains
-different parts under different Linux distributions.
-
-This can lead to issues with any action or input that uses TLS, like the `jira`,
-`pagerduty`, `slack`, or `webhook` one, because of missing CA certs.
-If you encounter TLS errors, when writing watches that connect to TLS endpoints,
-you should try to upgrade to the latest available OpenJDK distribution for your
-platform and if that does not help, try to upgrade to Oracle JDK.
diff --git a/x-pack/docs/en/watcher/actions/email.asciidoc b/x-pack/docs/en/watcher/actions/email.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[actions-email]]
-=== Email action
+=== Watcher email action
+++++
+<titleabbrev>Email action</titleabbrev>
+++++
 
 Use the `email` action to send email notifications. To send email, you must
 <<configuring-email, configure at least one email account>> in

diff --git a/x-pack/docs/en/watcher/actions/index.asciidoc b/x-pack/docs/en/watcher/actions/index.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[actions-index]]
-=== Index action
+=== {watcher} index action
+++++
+<titleabbrev>Index action</titleabbrev>
+++++
 
 Use the `index` action to index data into Elasticsearch.
 See <<index-action-attributes>> for the supported attributes.

diff --git a/x-pack/docs/en/watcher/actions/jira.asciidoc b/x-pack/docs/en/watcher/actions/jira.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[actions-jira]]
-=== Jira action
+=== {watcher} Jira action
+++++
+<titleabbrev>Jira action</titleabbrev>
+++++
 
 Use the `jira` action to create issues in  https://www.atlassian.com/software/jira[Atlassian's Jira Software].
 To create issues you need to <<configuring-jira, configure at least one Jira account>> in `elasticsearch.yml`.

diff --git a/x-pack/docs/en/watcher/actions/logging.asciidoc b/x-pack/docs/en/watcher/actions/logging.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[actions-logging]]
-=== Logging Action
+=== {watcher} logging Action
+++++
+<titleabbrev>Logging action</titleabbrev>
+++++
 
 Use the `logging` action to log text to the standard Elasticsearch
 logs. See <<logging-action-attributes>> for the supported attributes.

diff --git a/x-pack/docs/en/watcher/actions/pagerduty.asciidoc b/x-pack/docs/en/watcher/actions/pagerduty.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[actions-pagerduty]]
-=== PagerDuty action
+=== {watcher} PagerDuty action
+++++
+<titleabbrev>PagerDuty action</titleabbrev>
+++++
 
 Use the PagerDuty action to create events in https://pagerduty.com/[
 PagerDuty]. To create PagerDuty events, you must <<configuring-pagerduty,

diff --git a/x-pack/docs/en/watcher/actions/slack.asciidoc b/x-pack/docs/en/watcher/actions/slack.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[actions-slack]]
-=== Slack Action
+=== {watcher} Slack Action
+++++
+<titleabbrev>Slack action</titleabbrev>
+++++
 
 Use the `slack` action to send messages to a https://slack.com/[Slack]
 team's channels or users. To send Slack messages, you need to 

diff --git a/x-pack/docs/en/watcher/actions/webhook.asciidoc b/x-pack/docs/en/watcher/actions/webhook.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[actions-webhook]]
-=== Webhook action
+=== {watcher} webhook action
+++++
+<titleabbrev>Webhook action</titleabbrev>
+++++
 
 Use the `webhook` action to send a request to any web service. The
 webhook action supports both HTTP and HTTPS connections. See

diff --git a/x-pack/docs/en/watcher/condition.asciidoc b/x-pack/docs/en/watcher/condition.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[condition]]
-== Conditions
+== {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: 

diff --git a/x-pack/docs/en/watcher/condition/always.asciidoc b/x-pack/docs/en/watcher/condition/always.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[condition-always]]
-=== Always condition
+=== {watcher} always condition
+++++
+<titleabbrev>Always condition</titleabbrev>
+++++
 
 Use the `always` condition to set the condition to `true`. This forces the watch 
 actions to be executed unless they are <<actions-ack-throttle,throttled>>. 

diff --git a/x-pack/docs/en/watcher/condition/array-compare.asciidoc b/x-pack/docs/en/watcher/condition/array-compare.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[condition-array-compare]]
-=== Array compare condition
+=== {watcher} array compare condition
+++++
+<titleabbrev>Array compare condition</titleabbrev>
+++++
 
 Use `array_compare` to compare an array of values in the execution context to a 
 given value. See <<condition-compare-operators>>

diff --git a/x-pack/docs/en/watcher/condition/compare.asciidoc b/x-pack/docs/en/watcher/condition/compare.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[condition-compare]]
-=== Compare condition
+=== {watcher} compare condition
+++++
+<titleabbrev>Compare condition</titleabbrev>
+++++
 
 Use the `compare` condition to perform a simple comparison against a value in 
 the watch payload. You can use the `compare` condition without enabling 

diff --git a/x-pack/docs/en/watcher/condition/never.asciidoc b/x-pack/docs/en/watcher/condition/never.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[condition-never]]
-=== Never condition
+=== {watcher} never condition
+++++
+<titleabbrev>Never condition</titleabbrev>
+++++
 
 Use the `never` condition to set the condition to `false`. This means the
 watch actions are never executed when the watch is triggered. The watch input is

diff --git a/x-pack/docs/en/watcher/condition/script.asciidoc b/x-pack/docs/en/watcher/condition/script.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[condition-script]]
-=== Script condition
+=== {watcher} script condition
+++++
+<titleabbrev>Script condition</titleabbrev>
+++++
 
 A watch <<condition,condition>> that evaluates a script. The default scripting
 language is `painless`. You can use any of the scripting languages supported by

diff --git a/x-pack/docs/en/watcher/gs-index.asciidoc b/x-pack/docs/en/watcher/gs-index.asciidoc
diff --git a/x-pack/docs/en/watcher/index.asciidoc b/x-pack/docs/en/watcher/index.asciidoc
@@ -1,11 +1,16 @@
 [role="xpack"]
 [[xpack-alerting]]
-= Alerting on cluster and index events
+= Watch for cluster and index events
 
 [partintro]
 --
-The {alert-features} enable you to watch
-for changes or anomalies in your data and perform the necessary actions in
+TIP: {kib} Alerting provides a set of built-in actions and alerts 
+that are integrated with applications such as APM, Metrics, Security, and Uptime.
+You can use {kib} Alerting to detect complex conditions within different {kib} apps 
+and trigger actions when those conditions are met. 
+For more information, see {kibana-ref}/alerting-getting-started.html[Alerting and actions].
+
+You can watch for changes or anomalies in your data and perform the necessary actions in
 response. For example, you might want to:
 
 * Monitor social media as another way to detect failures in user-facing

diff --git a/x-pack/docs/en/watcher/input.asciidoc b/x-pack/docs/en/watcher/input.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[input]]
-== Inputs
+== {watcher} inputs
+++++
+<titleabbrev>Inputs</titleabbrev>
+++++
 
 When a watch is triggered, its _input_ loads data into the execution 
 context. This payload is accessible during the subsequent watch execution 

diff --git a/x-pack/docs/en/watcher/input/chain.asciidoc b/x-pack/docs/en/watcher/input/chain.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[input-chain]]
-=== Chain input
+=== {watcher} chain input
+++++
+<titleabbrev>Chain input</titleabbrev>
+++++
 
 Use the `chain` input to load data from multiple sources into the watch 
 execution context when the watch is triggered. The inputs in a chain

diff --git a/x-pack/docs/en/watcher/input/http.asciidoc b/x-pack/docs/en/watcher/input/http.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[input-http]]
-=== HTTP input
+=== {watcher} HTTP input
+++++
+<titleabbrev>HTTP input</titleabbrev>
+++++
 
 Use the `http` input to submit a request to an HTTP endpoint and load the
 response into the watch execution context when the watch is triggered. See

diff --git a/x-pack/docs/en/watcher/input/search.asciidoc b/x-pack/docs/en/watcher/input/search.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[input-search]]
-=== Search input
+=== {watcher} search input
+++++
+<titleabbrev>Search input</titleabbrev>
+++++
 
 Use the `search` input to load the results of an Elasticsearch search request
 into the execution context when the watch is triggered. See

diff --git a/x-pack/docs/en/watcher/input/simple.asciidoc b/x-pack/docs/en/watcher/input/simple.asciidoc
@@ -1,6 +1,9 @@
 [role="xpack"]
 [[input-simple]]
-=== Simple input
+=== {watcher} simple input
+++++
+<titleabbrev>Simple input</titleabbrev>
+++++
 
 Use the `simple` input to load static data into the execution
 context when the watch is triggered. This enables you to store the data 

diff --git a/x-pack/docs/en/watcher/java/service.asciidoc b/x-pack/docs/en/watcher/java/service.asciidoc
@@ -1,6 +1,6 @@
 [discrete]
 [[api-java-service]]
-=== Service API
+=== {watcher} service API
 
 The {watcher} `service` API allows the control the lifecycle of the {watcher}
 service. The following example starts the watcher service:

diff --git a/x-pack/docs/en/watcher/java/stats.asciidoc b/x-pack/docs/en/watcher/java/stats.asciidoc
@@ -1,6 +1,6 @@
 [discrete]
 [[api-java-stats]]
-=== Stats API
+=== {watcher} stats API
 
 The `stats` API returns the current {watcher} metrics. You can control what
 metrics this API returns using the `metric` parameter.

diff --git a/x-pack/docs/en/watcher/limitations.asciidoc b/x-pack/docs/en/watcher/limitations.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[watcher-limitations]]
-== Watcher limitations
+== {watcher} limitations
 [subs="attributes"]
 ++++
 <titleabbrev>Limitations</titleabbrev>