OpenSearch/watcher/docs/release-notes.asciidoc

[[release-notes]]
== Release Notes

[float]
[[version-compatibility]]
=== Version Compatibility

Watcher {version} is compatible with:

* Elasticsearch: {version}
* License {version}
* Shield {version}

[float]
[[upgrade-instructions]]
=== Upgrading Watcher

Watcher {version} is backward compatible with Watcher 1.0.x. Follow these steps to
upgrade:

1. Back up all of the watches you've defined. You can search/scan the `.watches` index and save the
   returned watches aside.

2. Stop Elasticsearch on all nodes in your cluster.

3. Uninstall the Watcher plugin from each node:
+
[source,yaml]
--------------------------------------------------
bin/plugin remove watcher
--------------------------------------------------

4. From here on you can simply follow the <<getting-started, Getting Started>> guide.

[float]
[[change-list]]
=== Change List

[float]
==== 2.0.0-beta2

.New Features
* Added new <<actions-hipchat, HipChat Action>>
* Added new <<actions-slack, Slack Action>>
* Watches now have an <<watch-active-state, active state>>. In addition, a new API was added to
  <<api-rest-activate-watch, activate>>/<<api-rest-deactivate-watch, deactivate>> registered watches.

[float]
==== 2.0.0-beta1

This release is primarily for compatibility with Elasticsearch 2.0.0-beta1.


[float]
==== 1.0.0

.Enhancements
* Added execution time aware <<dynamic-index-names, 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 <<api-rest-get-watch, Get Watch API>> response.
* Cleaned up the <<api-rest-stats, Stats API>> response.


[float]
==== 1.0.0-rc1

.New Features
* Added <<api-rest-execute-inline-watch, inline watch>> support to the Execute API

.Enhancements
* Added execution context <<watch-execution-context, variables>> support.
* Email html body sanitization is now <<email-html-sanitization, configurable>>.
* It is now possible to configure timeouts for http requests in 
  <<http-input-attributes, HTTP input>> and <<webhook-action-attributes, webhook actions>>.

[float]
==== 1.0.0-Beta2

.New Features
* <<actions-ack-throttle, Acking and Throttling>> are now applied at the action level rather than
  the watch level.
* Added support for <<anatomy-actions-index-multi-doc-support, multi-doc>> indexing to the index
  action.
* Added a queued watches metric that's accessible via the <<api-rest-stats, Stats API>>.
* Added a currently-executing watches metric that's accessible via the <<api-rest-stats, Stats API>>.

.Enhancements
* The <<condition-compare, compare condition>> result now includes the value of each field that
  was referenced in the comparison.
* The <<api-rest-execute-watch, Execute API>> 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 <<actions-webhook, Webhook Action>> result and the
  <<input-http, HTTP Input>> result.
* Add plain text response body support for the <<input-http, HTTP Input>>.

.Bug Fixes
* Disallow negative time value settings for <<actions-ack-throttle, `throttle_period`>>
* Added support for separate keystore and truststore in <<actions-webhook, Webhook Action>>
  and <<input-http, HTTP Input>>.