From 3b42e8a231b1a05ca3c4fdc768c868c37c566d1d Mon Sep 17 00:00:00 2001 From: Tyler Ohlsen Date: Tue, 12 May 2020 14:45:16 -0700 Subject: [PATCH 1/4] Add ODFE 1.7.0 release notes --- release-notes/release-notes-odfe-1.7.0.md | 29 +++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 release-notes/release-notes-odfe-1.7.0.md diff --git a/release-notes/release-notes-odfe-1.7.0.md b/release-notes/release-notes-odfe-1.7.0.md new file mode 100644 index 00000000..7f3c003a --- /dev/null +++ b/release-notes/release-notes-odfe-1.7.0.md @@ -0,0 +1,29 @@ +## Open Distro for Elasticsearch 1.7.0 Release Notes + +## Initial Release +The Anomaly Detection Elasticsearch plugin enables you to detect anomalies in streaming log data as it is ingested using the random cut forest (RCF) algorithm. +You can create anomaly detectors and add features to them to customize what parts of your data you want to detect anomalies over. + +This plugin can be used with the [Anomaly Detection Kibana plugin](https://github.com/opendistro-for-elasticsearch/anomaly-detection-kibana-plugin) +for an intuitive user interface that can be used to configure, start, and stop anomaly detectors. You can also view the anomaly history for all of your created detectors. + +You can use the plugin with the same version of the [Open Distro Alerting plugin](https://github.com/opendistro-for-elasticsearch/alerting) and +[Open Distro Alerting Kibana plugin](https://github.com/opendistro-for-elasticsearch/alerting-kibana-plugin) to get alert notifications. You can create a monitor based on an anomaly detector directly on the Alerting Kibana plugin. Monitors run checks on the anomaly detection results regularly and trigger alerts based on custom trigger conditions. + +## Features + +1. Create and configure anomaly detectors over user-specified indices and features +2. Start and stop detectors at any time +3. Query anomaly results +4. Query existing detectors +5. Query specific detector details and current state +6. Preview anomaly results for new detector features + +## Current Limitations + +- Supports Elasticsearch / Kibana 7.6.1. +- Limit of 1000 detectors per Elasticsearch cluster +- Limit of 5 features per detector +- Not all API calls have complete error handling. +- We will continuously add new unit test cases, but we don't have 100% unit test coverage for now. This is a great area for developers from the community to contribute and help improve test coverage. +- Please see documentation links and GitHub issues for other details. \ No newline at end of file From 7e7859aa10c351d231afff592aaf2c5304ecb9ca Mon Sep 17 00:00:00 2001 From: Tyler Ohlsen Date: Tue, 12 May 2020 14:50:40 -0700 Subject: [PATCH 2/4] Fix spacing --- release-notes/release-notes-odfe-1.7.0.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/release-notes/release-notes-odfe-1.7.0.md b/release-notes/release-notes-odfe-1.7.0.md index 7f3c003a..71ee8bc9 100644 --- a/release-notes/release-notes-odfe-1.7.0.md +++ b/release-notes/release-notes-odfe-1.7.0.md @@ -4,11 +4,9 @@ The Anomaly Detection Elasticsearch plugin enables you to detect anomalies in streaming log data as it is ingested using the random cut forest (RCF) algorithm. You can create anomaly detectors and add features to them to customize what parts of your data you want to detect anomalies over. -This plugin can be used with the [Anomaly Detection Kibana plugin](https://github.com/opendistro-for-elasticsearch/anomaly-detection-kibana-plugin) -for an intuitive user interface that can be used to configure, start, and stop anomaly detectors. You can also view the anomaly history for all of your created detectors. +This plugin can be used with the [Anomaly Detection Kibana plugin](https://github.com/opendistro-for-elasticsearch/anomaly-detection-kibana-plugin) for an intuitive user interface that can be used to configure, start, and stop anomaly detectors. You can also view the anomaly history for all of your created detectors. -You can use the plugin with the same version of the [Open Distro Alerting plugin](https://github.com/opendistro-for-elasticsearch/alerting) and -[Open Distro Alerting Kibana plugin](https://github.com/opendistro-for-elasticsearch/alerting-kibana-plugin) to get alert notifications. You can create a monitor based on an anomaly detector directly on the Alerting Kibana plugin. Monitors run checks on the anomaly detection results regularly and trigger alerts based on custom trigger conditions. +You can use the plugin with the same version of the [Open Distro Alerting plugin](https://github.com/opendistro-for-elasticsearch/alerting) and [Open Distro Alerting Kibana plugin](https://github.com/opendistro-for-elasticsearch/alerting-kibana-plugin) to get alert notifications. You can create a monitor based on an anomaly detector directly on the Alerting Kibana plugin. Monitors run checks on the anomaly detection results regularly and trigger alerts based on custom trigger conditions. ## Features From 3d51c435d58fcc8005c527a646939124c9f7fbb0 Mon Sep 17 00:00:00 2001 From: Tyler Ohlsen Date: Tue, 12 May 2020 15:22:58 -0700 Subject: [PATCH 3/4] Fix wording --- release-notes/release-notes-odfe-1.7.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/release-notes/release-notes-odfe-1.7.0.md b/release-notes/release-notes-odfe-1.7.0.md index 71ee8bc9..4da5e602 100644 --- a/release-notes/release-notes-odfe-1.7.0.md +++ b/release-notes/release-notes-odfe-1.7.0.md @@ -1,8 +1,8 @@ ## Open Distro for Elasticsearch 1.7.0 Release Notes ## Initial Release -The Anomaly Detection Elasticsearch plugin enables you to detect anomalies in streaming log data as it is ingested using the random cut forest (RCF) algorithm. -You can create anomaly detectors and add features to them to customize what parts of your data you want to detect anomalies over. +The Anomaly Detection Elasticsearch plugin enables you to detect anomalies in streaming time series data based on the random cut forest (RCF) algorithm. +You can create anomaly detectors and add features to them to customize what data you want to detect anomalies over. This plugin can be used with the [Anomaly Detection Kibana plugin](https://github.com/opendistro-for-elasticsearch/anomaly-detection-kibana-plugin) for an intuitive user interface that can be used to configure, start, and stop anomaly detectors. You can also view the anomaly history for all of your created detectors. From 83095741a48158c426d2843b59f7d9c367acaafd Mon Sep 17 00:00:00 2001 From: Tyler Ohlsen Date: Tue, 12 May 2020 15:56:51 -0700 Subject: [PATCH 4/4] Fix release notes and remove old notes --- ...stro-elasticsearch-anomaly-detection.release-notes.md | 9 --------- release-notes/release-notes-odfe-1.7.0.md | 9 +++++---- 2 files changed, 5 insertions(+), 13 deletions(-) delete mode 100644 opendistro-elasticsearch-anomaly-detection.release-notes.md diff --git a/opendistro-elasticsearch-anomaly-detection.release-notes.md b/opendistro-elasticsearch-anomaly-detection.release-notes.md deleted file mode 100644 index 452215e0..00000000 --- a/opendistro-elasticsearch-anomaly-detection.release-notes.md +++ /dev/null @@ -1,9 +0,0 @@ -## Version 1.7.0.0 (2020-05-13) - -### New Features - -This is the first official release of Open Distro for Elasticsearch Anomaly Detection plugin. - -The Anomaly Detection plugin enables you to leverage Machine Learning based algorithms to automatically detect anomalies as your log data is ingested. Combined with Alerting, you can monitor your data in near real time and automatically send alert notifications . With an intuitive Kibana interface and a powerful API, it is easy to set up, tune, and monitor your anomaly detectors. - -* Adds backend REST APIs used for CRUD operations, preview, search on Anomaly Detectors, and search on detector results. diff --git a/release-notes/release-notes-odfe-1.7.0.md b/release-notes/release-notes-odfe-1.7.0.md index 4da5e602..e89ef9b6 100644 --- a/release-notes/release-notes-odfe-1.7.0.md +++ b/release-notes/release-notes-odfe-1.7.0.md @@ -1,4 +1,5 @@ ## Open Distro for Elasticsearch 1.7.0 Release Notes +Compatible with Elasticsearch 7.6.1 and Open Distro for Elasticsearch 1.7.0. ## Initial Release The Anomaly Detection Elasticsearch plugin enables you to detect anomalies in streaming time series data based on the random cut forest (RCF) algorithm. @@ -19,9 +20,9 @@ You can use the plugin with the same version of the [Open Distro Alerting plugin ## Current Limitations -- Supports Elasticsearch / Kibana 7.6.1. - Limit of 1000 detectors per Elasticsearch cluster - Limit of 5 features per detector -- Not all API calls have complete error handling. -- We will continuously add new unit test cases, but we don't have 100% unit test coverage for now. This is a great area for developers from the community to contribute and help improve test coverage. -- Please see documentation links and GitHub issues for other details. \ No newline at end of file +- Total detectors memory limit of 10% of JVM heap +- Not all API calls have complete error handling +- We will continuously add new unit test cases, but we don't have 100% unit test coverage for now. This is a great area for developers from the community to contribute and help improve test coverage +- Please see documentation links and GitHub issues for other details \ No newline at end of file