From fd76936955b58400e8d156c0f7ace086e67bb193 Mon Sep 17 00:00:00 2001 From: Kaituo Li Date: Fri, 1 May 2020 14:16:40 -0700 Subject: [PATCH] bump opendistroVersion to 1.6.1 (#99) * bump opendistroVersion to 1.6.1 --- README.md | 20 ++++++++------------ build.gradle | 2 +- 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 949f7f5f..1cb2b3a3 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,19 @@ The Open Distro for Elasticsearch Anomaly Detection plugin enables you to levera ## Highlights -Anomaly detection is using Random Cut Forest (RCF) algorithm for detecting anomalous data points. +Anomaly detection is using [Random Cut Forest (RCF) algorithm](https://github.com/aws/random-cut-forest-by-aws) for detecting anomalous data points. -You should use anomaly detection plugin with Open Distro Alerting plugin [1.2-alpha](https://github.com/opendistro-for-elasticsearch/alerting). You can also create a monitor based on anomaly detector. A scheduled monitor run will trigger the anomaly detection plugin and collecting anomalies to trigger alerts based on custom trigger conditions. +Anomaly detections run a scheduled job based on [job-scheduler](https://github.com/opendistro-for-elasticsearch/job-scheduler). + +You should use anomaly detection plugin with the same version of [Open Distro Alerting plugin](https://github.com/opendistro-for-elasticsearch/alerting). You can also create a monitor based on the anomaly detector. A scheduled monitor run checks the anomaly detection results regularly and collects anomalies to trigger alerts based on custom trigger conditions. ## Current Limitations -* This is alpha code. -* We inherit security features from Open Distro for Elasticsearch Alerting. -* We use Alerting alpha code branch. * 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. ## Documentation -Please see our [documentation](https://opendistro.github.io/for-elasticsearch-docs/). +Please see our [documentation](https://opendistro.github.io/for-elasticsearch-docs/docs/ad/). ## Setup @@ -43,8 +42,8 @@ Currently we just put RCF jar in lib as dependency. Plan to publish to Maven and ### Building from the command line 1. `./gradlew build` builds and tests -1. `./gradlew :run` launches a single node cluster with the AD plugin installed -1. `./gradlew :integTest` launches a single node cluster with the AD plugin installed and runs all integration tests +1. `./gradlew :run` launches a single node cluster with the AD (and job-scheduler) plugin installed +1. `./gradlew :integTest` launches a single node cluster with the AD (and job-scheduler) plugin installed and runs all integration tests 1. ` ./gradlew :integTest --tests="**.test execute foo"` runs a single integration test class or method 1. `./gradlew spotlessApply` formats code. And/or import formatting rules in `.eclipseformat.xml` with IDE. @@ -83,9 +82,6 @@ You can do this by running `./gradlew run -PnumNodes=` You can also debug a multi-node cluster, by using a combination of above multi-node and debug steps. But, you must set up debugger configurations to listen on each port starting from `5005` and increasing by 1 for each node. -## Known Issues -* We have a cold start period whenever we initialize a model, which could happen when we create a new detector or when the cluster restarts and models get restored from snapshots. Currently the detector always return errors during the cold start period. Please ignore these initial errors for now. We are actively working on the fix and will push in the next release. - ## Interested in contributing to the Anomaly Detection plugin We welcome you to get involved in development, documentation, testing the anomaly detection plugin. See our [contribution guidelines](https://opendistro.github.io/for-elasticsearch/blob/development/CONTRIBUTING.md) and join in. @@ -107,4 +103,4 @@ See the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask y ## Copyright -Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. +Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/build.gradle b/build.gradle index 90a0fb14..b3ba34a7 100644 --- a/build.gradle +++ b/build.gradle @@ -43,7 +43,7 @@ repositories { } ext { - opendistroVersion = '1.6.0' + opendistroVersion = '1.6.1' isSnapshot = "true" == System.getProperty("build.snapshot", "true") }