From 55a9977d30697d1d94dff3e5b352b1b649179277 Mon Sep 17 00:00:00 2001 From: debadair Date: Tue, 8 Dec 2020 13:33:10 -0800 Subject: [PATCH] [DOCS] Qualified Watcher topics to distinguish from Kib Alerting (#65908) (#66065) * [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 <40268737+jrodewig@users.noreply.github.com> * Incorporated review comments. --- x-pack/docs/en/watcher/actions.asciidoc | 51 +-- x-pack/docs/en/watcher/actions/email.asciidoc | 5 +- x-pack/docs/en/watcher/actions/index.asciidoc | 5 +- x-pack/docs/en/watcher/actions/jira.asciidoc | 5 +- .../docs/en/watcher/actions/logging.asciidoc | 5 +- .../en/watcher/actions/pagerduty.asciidoc | 5 +- x-pack/docs/en/watcher/actions/slack.asciidoc | 5 +- .../docs/en/watcher/actions/webhook.asciidoc | 5 +- x-pack/docs/en/watcher/condition.asciidoc | 5 +- .../docs/en/watcher/condition/always.asciidoc | 5 +- .../watcher/condition/array-compare.asciidoc | 5 +- .../en/watcher/condition/compare.asciidoc | 5 +- .../docs/en/watcher/condition/never.asciidoc | 5 +- .../docs/en/watcher/condition/script.asciidoc | 5 +- x-pack/docs/en/watcher/gs-index.asciidoc | 68 ---- x-pack/docs/en/watcher/index.asciidoc | 11 +- x-pack/docs/en/watcher/input.asciidoc | 5 +- x-pack/docs/en/watcher/input/chain.asciidoc | 5 +- x-pack/docs/en/watcher/input/http.asciidoc | 5 +- x-pack/docs/en/watcher/input/search.asciidoc | 5 +- x-pack/docs/en/watcher/input/simple.asciidoc | 5 +- x-pack/docs/en/watcher/java/service.asciidoc | 2 +- x-pack/docs/en/watcher/java/stats.asciidoc | 2 +- x-pack/docs/en/watcher/limitations.asciidoc | 2 +- x-pack/docs/en/watcher/release-notes.asciidoc | 313 ------------------ x-pack/docs/en/watcher/transform.asciidoc | 10 +- .../docs/en/watcher/transform/chain.asciidoc | 5 +- .../docs/en/watcher/transform/script.asciidoc | 5 +- .../docs/en/watcher/transform/search.asciidoc | 5 +- x-pack/docs/en/watcher/trigger.asciidoc | 5 +- .../docs/en/watcher/trigger/schedule.asciidoc | 5 +- .../en/watcher/trigger/schedule/cron.asciidoc | 5 +- .../watcher/trigger/schedule/daily.asciidoc | 5 +- .../watcher/trigger/schedule/hourly.asciidoc | 5 +- .../trigger/schedule/interval.asciidoc | 5 +- .../watcher/trigger/schedule/monthly.asciidoc | 5 +- .../watcher/trigger/schedule/weekly.asciidoc | 5 +- .../watcher/trigger/schedule/yearly.asciidoc | 5 +- 38 files changed, 171 insertions(+), 438 deletions(-) delete mode 100644 x-pack/docs/en/watcher/gs-index.asciidoc delete mode 100644 x-pack/docs/en/watcher/release-notes.asciidoc diff --git a/x-pack/docs/en/watcher/actions.asciidoc b/x-pack/docs/en/watcher/actions.asciidoc index 589d87c1cd2..fecf712800b 100644 --- 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 +++++ +Actions +++++ When a watch's condition is met, its actions are executed unless it is being <>. 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: -<>, <>, <>, -<>, <>, -and <>. +{watcher} supports the following actions: + +* <> +* <> +* <> +* <> +* <> +* <> [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 +++++ +Adding conditions to actions +++++ 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 index 06df6941985..c6edc79a712 100644 --- 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 +++++ +Email action +++++ Use the `email` action to send email notifications. To send email, you must <> in diff --git a/x-pack/docs/en/watcher/actions/index.asciidoc b/x-pack/docs/en/watcher/actions/index.asciidoc index e967cfa0af7..78c99a9797c 100644 --- 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 +++++ +Index action +++++ Use the `index` action to index data into Elasticsearch. See <> for the supported attributes. diff --git a/x-pack/docs/en/watcher/actions/jira.asciidoc b/x-pack/docs/en/watcher/actions/jira.asciidoc index 0819f503356..318eb3c251b 100644 --- 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 +++++ +Jira action +++++ Use the `jira` action to create issues in https://www.atlassian.com/software/jira[Atlassian's Jira Software]. To create issues you need to <> in `elasticsearch.yml`. diff --git a/x-pack/docs/en/watcher/actions/logging.asciidoc b/x-pack/docs/en/watcher/actions/logging.asciidoc index a279c83c208..837aaf64ae1 100644 --- 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 +++++ +Logging action +++++ Use the `logging` action to log text to the standard Elasticsearch logs. See <> for the supported attributes. diff --git a/x-pack/docs/en/watcher/actions/pagerduty.asciidoc b/x-pack/docs/en/watcher/actions/pagerduty.asciidoc index 67d559495f0..82cd22386fc 100644 --- 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 +++++ +PagerDuty action +++++ Use the PagerDuty action to create events in https://pagerduty.com/[ PagerDuty]. To create PagerDuty events, you must <Slack action +++++ 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 index 65e88425c8a..73ec2bee16c 100644 --- 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 +++++ +Webhook action +++++ 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 index 6995d88a2f6..c38d95733d3 100644 --- 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 +++++ +Conditions +++++ 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 index bba7b1696e6..0cc922ba886 100644 --- 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 +++++ +Always condition +++++ Use the `always` condition to set the condition to `true`. This forces the watch actions to be executed unless they are <>. diff --git a/x-pack/docs/en/watcher/condition/array-compare.asciidoc b/x-pack/docs/en/watcher/condition/array-compare.asciidoc index 1e8ae5d9cbf..2c74a40e1e9 100644 --- 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 +++++ +Array compare condition +++++ Use `array_compare` to compare an array of values in the execution context to a given value. See <> diff --git a/x-pack/docs/en/watcher/condition/compare.asciidoc b/x-pack/docs/en/watcher/condition/compare.asciidoc index 466cbe05ef6..fa0399e4038 100644 --- 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 +++++ +Compare condition +++++ 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 index 0328601f00e..d4e36323e57 100644 --- 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 +++++ +Never condition +++++ 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 index 4dcc23ff25f..9fb9193d811 100644 --- 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 +++++ +Script condition +++++ A watch <> 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 deleted file mode 100644 index 0e9163b571f..00000000000 --- a/x-pack/docs/en/watcher/gs-index.asciidoc +++ /dev/null @@ -1,68 +0,0 @@ -[role="xpack"] -[[xpack-alerting]] -= Alerting on cluster and index events - -[partintro] --- -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 - automated systems like ATMs or ticketing systems. When the number of tweets - and posts in an area exceeds a threshold of significance, notify a service - technician. - -* Monitor your infrastructure, tracking disk usage over time. Open a helpdesk - ticket when any servers are likely to run out of free space in the next few - days. - -* Track network activity to detect malicious activity, and proactively change - firewall configuration to reject the malicious user. - -* Monitor Elasticsearch, and send immediate notification to the system - administrator if nodes leave the cluster or query throughput exceeds an - expected range. - -* Track application response times and if page-load time exceeds SLAs for more - than 5 minutes, open a helpdesk ticket. If SLAs are exceeded for an hour, - page the administrator on duty. - -All of these use-cases share a few key properties: - -* The relevant data or changes in data can be identified with a periodic - Elasticsearch query. - -* The results of the query can be checked against a condition. - -* One or more actions are taken if the condition is true -- an email is sent, a - 3rd party system is notified, or the query results are stored. - -[discrete] -=== How watches work - -The {alert-features} provide an API for creating, managing and testing _watches_. -A watch describes a single alert and can contain multiple notification actions. - -A watch is constructed from four simple building blocks: - -Schedule:: A schedule for running a query and checking the condition. - -Query:: The query to run as input to the condition. Watches - support the full Elasticsearch query language, including - aggregations. - -Condition:: A condition that determines whether or not to execute the actions. - You can use simple conditions (always true), or use scripting for - more sophisticated scenarios. - -Actions:: One or more actions, such as sending email, pushing data to - 3rd party systems through a webhook, or indexing the results of - the query. - -A full history of all watches is maintained in an Elasticsearch index. This -history keeps track of each time a watch is triggered and records the results -from the query, whether the condition was met, and what actions were taken. - --- - -include::getting-started.asciidoc[] diff --git a/x-pack/docs/en/watcher/index.asciidoc b/x-pack/docs/en/watcher/index.asciidoc index 5b1ba8a5598..267306af046 100644 --- 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 index 45a33379a8e..c7e1d1707cf 100644 --- 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 +++++ +Inputs +++++ 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 index 69afe310463..1b49a44e658 100644 --- 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 +++++ +Chain input +++++ 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 index bd48d339d64..00c8d7b14b2 100644 --- 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 +++++ +HTTP input +++++ 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 index 3dbf59e35b9..94dffbb4254 100644 --- 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 +++++ +Search input +++++ 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 index e69c79f53e1..3e2cafc6d95 100644 --- 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 +++++ +Simple input +++++ 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 index 9e18c880075..1a6cd6c520e 100644 --- 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 index ee7afe854b3..b66000855f1 100644 --- 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 index 6b5c47886a4..213403e0f68 100644 --- 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"] ++++ Limitations diff --git a/x-pack/docs/en/watcher/release-notes.asciidoc b/x-pack/docs/en/watcher/release-notes.asciidoc deleted file mode 100644 index 17594136863..00000000000 --- a/x-pack/docs/en/watcher/release-notes.asciidoc +++ /dev/null @@ -1,313 +0,0 @@ -[role="xpack"] -[[watcher-release-notes]] -== Watcher Release Notes (Pre-5.0) - -[discrete] -[[watcher-change-list]] -=== Change List - -[discrete] -==== 2.4.2 -November 22, 2016 - -.Bug Fixes -* Deleting a watch now is independent from its current execution state in -order to prevent failed deletions with watches having small intervals -* Chain input: Parsing now throws an exception if a data structure is added, that cannot keep its order - -[discrete] -==== 2.4.1 -September 28, 2016 - -.Bug Fixes -* Fixed a serialization error that resulted in the watch history not being -written when a proxy is specified in a watch. -* Triggered watches are now correctly deleted from the `.triggered-watches` -index if they are rejected due to a full thread pool. -* Deleting or closing the `.watches` index now correctly cleans up the -in-memory watch store so the watches are no longer executed. -* If the HTTP request for an attachment fails, the error message is included -in the watch history. -* Fixed a possible exception when chained inputs don't execute successfully. - -.Enhancements -* Hostname verification can be disabled for Watcher -HTTP actions. -* Running watches can be updated and deleted. - -[discrete] -==== 2.4.0 -August 31, 2016 - -.Enhancements -* The HTTP headers of a response are now part of the payload and can be accessed via `ctx.payload._headers` - - -[discrete] -==== 2.3.5 -August 3, 2016 - -.Bug Fixes -* The watch history was not written, if one of the chained inputs resulted in a failure as well as an input containing a field name with dots -* Status of an acked watch, whose condition evaluates to false again is now properly persisted and not lost in case of a master node switch -* Fixed the watch history template so payloads and request bodies are handled -correctly. To update an existing installation, delete the existing watch history -template by running `DELETE /_template/watch_history` and the correct template -will be autocreated. To verify the template is recreated, call `GET -/_template/watch_history`. Note that this just updates the template, so you -need to wait one day for this update to take effect when a new history index is -created. -* The `watcher.http.proxy.port` setting for global proxy configuration was not applied correctly. - -[discrete] -==== 2.3.4 -July 7, 2016 - -.Bug Fixes -* Putting a new watch with state `active=false` now stores that state correctly -on a multi node cluster. -* Fixed the watch history template so nested request bodies are handled -correctly. To update an existing installation, delete the existing watch history -template by running `DELETE /_template/watch_history` and the correct template -will be autocreated. To verify the template is recreated, call `GET -/_template/watch_history`. Note that this just updates the template, so you -need to wait one day for this update to take effect when a new history index is -created. -* The HTML sanitizer now supports border and cellpadding attributes on table -elements and the colspan and rowspan attributes on and elements. -* Fixed the Watcher/Marvel examples in the documentation. - -[discrete] -==== 2.3.3 -May 18, 2016 - -.Enhancements -* Adds support for Elasticsearch 2.3.3 - -[discrete] -==== 2.3.2 -April 26, 2016 - -.Bug Fixes -* All SMTP connection timeouts are now set to two minutes by default to prevent -a watch from getting stuck. -* HTTP headers from responses that contained dots led to exceptions when the -HTTP response was stored in the watch history. All dots in any header names -are now replaced with underscores. For example, a header called `foo.bar` -becomes `foo_bar` -* Hipchat action: Fall back to the default Hipchat color and format if they -are not specified at the account level or within the action itself, instead -of failing. - -[discrete] -==== 2.3.1 -April 4, 2016 - -.Enhancements -* Adds support for Elasticsearch 2.3.1 - -[discrete] -==== 2.3.0 -March 30, 2016 - -.Bug fixes -* The http client does not do any URL escaping by itself anymore, preventing - potential wrong double escapes. - -.Enhancement -* Support `url` in http requests as a shortcut for `path`, `scheme`, `port`, `params` -* Support `ignore_condition` and `record_execution` as parameters in the - {ref}/watcher-api-execute-watch.html[Execute Watch API] - -.New Features -* Added <> -* Added support for adding <> - via HTTP requests and superseding and deprecating the usage of `attach_data` - in order to use this feature - -[discrete] -==== 2.2.1 -March 10, 2016 - -.Bug Fixes -* The `croneval` CLI tool sets the correct environment to run - -[discrete] -==== 2.2.0 -February 2, 2016 - -.Enhancements -* Adds support for Elasticsearch 2.2.0. - -[discrete] -==== 2.1.2 -February 2, 2016 - -.Enhancements -* Adds support for Elasticsearch 2.1.2 - -[discrete] -==== 2.1.1 -December 17, 2015 - -.Bug Fixes -* Fixed an issue that prevented sending of emails - -[discrete] -==== 2.1.0 -November 24, 2015 - -.New Features -* Adds support for <> - -.Enhancements -* Adds support for Elasticsearch 2.1.0. -* Adds support for configuring a proxy in the webhook action, http input and - configuring a default proxy (which is also used by the slack action), using the - `watcher.http.proxy.host` and `watcher.http.proxy.port` settings. - -.Bug Fixes -* Fixed an issue where the scheduler may get stuck during Watcher startup. This - caused no watches to ever fire. -* Fixed an issue where under specific conditions Watcher would not start if there - are not finished watch executions from the previous time that watcher was - running and those watch execution are unable the execute during the current - start process. - -[discrete] -==== 2.0.1 -November 24, 2015 - -.Enhancement -* Adds support for Elasticsearch 2.0.1. - -.Bug fixes -* Fixed an issue where under specific conditions Watcher would not start if - there are not finished watch executions from the previous time that watcher - was running and those watch execution are unable the execute during the current - start process. - -[discrete] -==== 2.0.0 -October 28, 2015 - -.Breaking Changes -* The dynamic index names support has been removed and Elasticsearch's date math - index names support should be used instead. The only difference between Watcher's - dynamic index names support and Elasticsearch's date math index names support is - how timezones are expressed. In Watcher this is done via node settings, in - Elasticsearch the timezone is part of the date math index names support. Only - if you're using dynamic index names with timezones in Watcher then you need to - upgrade your watches after the upgrade, otherwise your watches will work as - they did before the upgrade. For example if `watcher.dynamic_indices.time_zone` - setting was set to `+01:00` and a watch has the following index name - `` then after the upgrade you need to update this watch to - use the following index name ``. - -.New Features -* Added new <> -* Added new <> -* Watches now have an <>. In addition, a new - API was added to {ref}/watcher-api-activate-watch.html[activate] - /{ref}watcher-api-deactivate-watch.html[deactivate] registered watches. -* Added new <>, that can compare an array - of values in the <> - to a given value. - -.Enhancements -* Watcher continuously checks if the index templates for `.watches`, - `.triggered_watches` and `.watch_history-*` exist. Whereas before the existence - of these index templates was only checked at Watcher startup time. The absence - of these index templates leads to watcher data being indexed incorrectly, which - then can cause Watcher to behave incorrectly. -* If Watcher was stopped via the stop Watcher api and after that a master - election took place then Watcher would then unexpectedly start. -* During Watcher start up only wait for the shards of the `.watches` and - `.triggered_watches` indices to be available. Before Watcher also waited for - the shards of the `.watch_history-*` indices, which wasn't needed. This - improved time it takes for Watcher to startup. -* If `action.auto_create_index` setting has been configured then Watcher will - check if the setting is too restrictive. If the `action.auto_create_index` is - too restrictive then Watcher will fail during startup with a descriptive error - message. - -.Bug Fixes -* If Watcher was installed with Security then the Watcher index templates couldn't - be stored and could lead to Watcher behaving incorrectly. This was caused by - Watcher not detecting correctly if Security was installed. -* Update `croneval` command line utility to properly handle whitespaces in the - elasticsearch home path. -* Fixed an issue where the scheduler may get stuck during Watcher startup. This - caused no watches to ever fire. -* Fixed url encoding issue in http input and webhook output. The url params were - url encoded twice. - -[discrete] -==== 1.0.1 -July 29, 2015 - -.Enhancements -* Dynamic index names now support specifying a time zone to be used when - computing the names of the indices. The default is UTC. Previously, the - computation was fixed to always use UTC when computing the names of the - indices. - -.Bug Fixes -* Fixed a compatibility issue with Elasticsearch 1.6.1 and 1.7.2, which were - released earlier today. - -[discrete] -==== 1.0.0 -June 25, 2015 - -.Enhancements -* Added execution time aware dynamic index names support to `index` - action, `search` input, and `search` transform. -* You must now explicitly specify the unit when configuring any time value. - (Numeric-only values are no longer supported.) -* Cleaned up the {ref}/watcher-api-get-watch.html[Get Watch API] response. -* Cleaned up the <> response. - - -[discrete] -==== 1.0.0-rc1 -June 19, 2015 - -.New Features -* Added <> support to the Execute API - -.Enhancements -* Added execution context <> support. -* Email html body sanitization is now <>. -* It is now possible to configure timeouts for http requests in - <> and <>. - -[discrete] -==== 1.0.0-Beta2 -June 10, 2015 - -.New Features -* <> are now applied at the action - level rather than the watch level. -* Added support for <> - indexing to the index action. -* Added a queued watches metric that's accessible via the <>. -* Added a currently-executing watches metric that's accessible via the - <>. - -.Enhancements -* The <> result now includes the value of - each field that was referenced in the comparison. -* The <> now supports a default trigger - event (**breaking change**). -* The `watch_record` document structure in the `.watch_history-*` indices has - changed significantly (**breaking change**). -* A new internal index was introduced - `.triggered_watches` -* Added support for headers in the <> result - and the <> result. -* Add plain text response body support for the <>. - -.Bug Fixes -* Disallow negative time value settings for <> -* Added support for separate keystore and truststore in <> - and <>. diff --git a/x-pack/docs/en/watcher/transform.asciidoc b/x-pack/docs/en/watcher/transform.asciidoc index 0948fadb40c..c5929d7cadc 100644 --- a/x-pack/docs/en/watcher/transform.asciidoc +++ b/x-pack/docs/en/watcher/transform.asciidoc @@ -1,11 +1,17 @@ [role="xpack"] [[transform]] == {watcher-transforms-cap} +++++ +Transforms +++++ A _{watcher-transform}_ processes and changes the payload in the watch execution context to prepare it for the watch actions. {watcher} supports three types of -{watcher-transforms}: <>, -<> and <>. +{watcher-transforms}: + +* <> +* <> +* <> NOTE: {watcher-transforms-cap} are optional. When none are defined, the actions diff --git a/x-pack/docs/en/watcher/transform/chain.asciidoc b/x-pack/docs/en/watcher/transform/chain.asciidoc index a99458512a9..ed43a85faee 100644 --- a/x-pack/docs/en/watcher/transform/chain.asciidoc +++ b/x-pack/docs/en/watcher/transform/chain.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[transform-chain]] -=== Chain {watcher-transform} +=== {watcher} chain {watcher-transform} +++++ +Chain {watcher-transform} +++++ A <> that executes an ordered list of configured {watcher-transforms} in a chain, where the output of one transform serves as the diff --git a/x-pack/docs/en/watcher/transform/script.asciidoc b/x-pack/docs/en/watcher/transform/script.asciidoc index 2a41cec2e07..8bcaa4af9d2 100644 --- a/x-pack/docs/en/watcher/transform/script.asciidoc +++ b/x-pack/docs/en/watcher/transform/script.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[transform-script]] -=== Script {watcher-transform} +=== {watcher} script {watcher-transform} +++++ +Script {watcher-transform} +++++ A <> that executes a script on the current payload in the watch execution context and replaces it with a newly generated diff --git a/x-pack/docs/en/watcher/transform/search.asciidoc b/x-pack/docs/en/watcher/transform/search.asciidoc index 7b4e9c72773..66ba502ea4b 100644 --- a/x-pack/docs/en/watcher/transform/search.asciidoc +++ b/x-pack/docs/en/watcher/transform/search.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[transform-search]] -=== Search {watcher-transform} +=== {watcher} search {watcher-transform} +++++ +Search {watcher-transform} +++++ A <> that executes a search on the cluster and replaces the current payload in the watch execution context with the returned diff --git a/x-pack/docs/en/watcher/trigger.asciidoc b/x-pack/docs/en/watcher/trigger.asciidoc index a0852b0470e..d8e37ae3732 100644 --- a/x-pack/docs/en/watcher/trigger.asciidoc +++ b/x-pack/docs/en/watcher/trigger.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[trigger]] -== Triggers +== {watcher} triggers +++++ +Triggers +++++ Every watch must have a `trigger` that defines when the watch execution process should start. When you create a watch, its trigger is registered with the diff --git a/x-pack/docs/en/watcher/trigger/schedule.asciidoc b/x-pack/docs/en/watcher/trigger/schedule.asciidoc index 0c9bffb9359..fa389409d15 100644 --- a/x-pack/docs/en/watcher/trigger/schedule.asciidoc +++ b/x-pack/docs/en/watcher/trigger/schedule.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[trigger-schedule]] -=== Schedule trigger +=== {watcher} schedule trigger +++++ +Schedule trigger +++++ Schedule <> define when the watch execution should start based on date and time. All times are specified in UTC time. diff --git a/x-pack/docs/en/watcher/trigger/schedule/cron.asciidoc b/x-pack/docs/en/watcher/trigger/schedule/cron.asciidoc index 6c5d801bee1..7304293abb1 100644 --- a/x-pack/docs/en/watcher/trigger/schedule/cron.asciidoc +++ b/x-pack/docs/en/watcher/trigger/schedule/cron.asciidoc @@ -1,5 +1,8 @@ [[schedule-cron]] -==== Cron schedule +==== {watcher} cron schedule +++++ +Cron schedule +++++ Defines a <> using a <> that specifiues when to execute a watch. diff --git a/x-pack/docs/en/watcher/trigger/schedule/daily.asciidoc b/x-pack/docs/en/watcher/trigger/schedule/daily.asciidoc index 2f8129f8e38..cea2b8316e0 100644 --- a/x-pack/docs/en/watcher/trigger/schedule/daily.asciidoc +++ b/x-pack/docs/en/watcher/trigger/schedule/daily.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[schedule-daily]] -==== Daily schedule +==== {watcher} Daily schedule +++++ +Daily schedule +++++ A <> that triggers at a particular time every day. To use the `daily` schedule, you specify the time of day (or times) diff --git a/x-pack/docs/en/watcher/trigger/schedule/hourly.asciidoc b/x-pack/docs/en/watcher/trigger/schedule/hourly.asciidoc index 17939096a46..9cb3bd3c060 100644 --- a/x-pack/docs/en/watcher/trigger/schedule/hourly.asciidoc +++ b/x-pack/docs/en/watcher/trigger/schedule/hourly.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[schedule-hourly]] -==== Hourly schedule +==== {watcher} hourly schedule +++++ +Hourly schedule +++++ A <> that triggers at a particular minute every hour of the day. To use the `hourly` schedule, you specify the minute (or minutes) diff --git a/x-pack/docs/en/watcher/trigger/schedule/interval.asciidoc b/x-pack/docs/en/watcher/trigger/schedule/interval.asciidoc index f4f8b4efd5a..069a4a0d361 100644 --- a/x-pack/docs/en/watcher/trigger/schedule/interval.asciidoc +++ b/x-pack/docs/en/watcher/trigger/schedule/interval.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[schedule-interval]] -==== Interval schedule +==== {watcher} interval schedule +++++ +Interval schedule +++++ A <> that triggers at a fixed time interval. The interval can be set in seconds, minutes, hours, days, or weeks: diff --git a/x-pack/docs/en/watcher/trigger/schedule/monthly.asciidoc b/x-pack/docs/en/watcher/trigger/schedule/monthly.asciidoc index b8703ccdd29..7d13262ed2f 100644 --- a/x-pack/docs/en/watcher/trigger/schedule/monthly.asciidoc +++ b/x-pack/docs/en/watcher/trigger/schedule/monthly.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[schedule-monthly]] -==== Monthly schedule +==== {watcher} monthly schedule +++++ +Monthly schedule +++++ A <> that triggers at a specific day and time every month. To use the `monthly` schedule, you specify the day of the month and diff --git a/x-pack/docs/en/watcher/trigger/schedule/weekly.asciidoc b/x-pack/docs/en/watcher/trigger/schedule/weekly.asciidoc index 1408489d8d4..5b43de019ad 100644 --- a/x-pack/docs/en/watcher/trigger/schedule/weekly.asciidoc +++ b/x-pack/docs/en/watcher/trigger/schedule/weekly.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[schedule-weekly]] -==== Weekly schedule +==== {watcher} weekly schedule +++++ +Weekly schedule +++++ A <> that triggers at a specific day and time every week. To use the `weekly` schedule, you specify the day and time (or days diff --git a/x-pack/docs/en/watcher/trigger/schedule/yearly.asciidoc b/x-pack/docs/en/watcher/trigger/schedule/yearly.asciidoc index e25d5561c86..8fce024bf9f 100644 --- a/x-pack/docs/en/watcher/trigger/schedule/yearly.asciidoc +++ b/x-pack/docs/en/watcher/trigger/schedule/yearly.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[schedule-yearly]] -==== Yearly schedule +==== {watcher} yearly schedule +++++ +Yearly schedule +++++ A <> that triggers at a specific day and time every year. To use the `yearly` schedule, you specify the month, day, and time