Version 1.13.0.1

Compatible with Elasticsearch (7.10.2).

Enhancements

• Extract a new class for entity frequenty tracking (#389)

Bug Fixes

• Change AD indices to be hidden indices instead of system indices (#398)
• Bump gson dependency version (#408)

Infrastructure

• Update default branch in workflows (#387)

Version 1.13.0.0

Compatible with Elasticsearch (7.10.2).

• update release note to include #385 (#386)

Features

• add AD task and tune detector&AD result data model (#329)
• add AD task cache (#337)
• start historical detector (#355)
• stop historical detector; support return AD task in get detector API (#359)
• update/delete historical detector;search AD tasks (#362)
• add user in AD task (#370)

Enhancements

• Adding unit tests for Transport Actions (#327)
• Adding role based filtering for rest of APIs (#325)
• add ad task stats (#332)
• filter out exceptions which should not be counted in failure stats (#341)
• Moving Preview Anomaly Detectors to Transport layer (#321)
• Adding role based filtering for Preview API (#356)
• change the backend role filtering to keep consistent with alerting pl… (#383)

Bug Fixes

• Fix the profile API returns prematurely. (#340)
• Fix another case of the profile API returns prematurely (#353)
• Fix log messages and init progress for the profile API (#374)
• validate detector only when start detector; fix flaky test case (#377)

Infrastructure

• Adding support for Security Test Framework (#331)
• add IT cases for filtering out non-server exceptions for HC detector (#348)
• rename rpm/deb artifact name (#371)
• fix flaky test case (#376)
• Change release workflow to use new staging bucket for artifacts (#358)
• Update draft release notes config (#379)
• fix failed integration cases (#385)
• Update default branch in workflows (#387)

Documentation

• Updating Readme to include Secure tests (#334)
• remove spotless header file; remove copyright year in new files for h… (#372)
• Add release notes for version 1.13.0.0 (#382)

Maintenance

• upgrade to ES 7.10.2 (#378)

Version 1.12.0.0

Compatible with Elasticsearch (7.10.0).

• fix detector and feature serialization (#322)
• Moving common-utils to 1.12.0.2 (#323)
• update release notes for 1.12.0.0 (#324)
• add AD task and tune detector&AD result data model (#329)
• add ad task stats (#332)
• add AD task cache (#337)
• add IT cases for filtering out non-server exceptions for HC detector (#348)

Enhancements

• Adding user support from ThreadContext (#297)
• Stashing context for Stats API to allow users to query from RestAPI (#300)
• Improve profile API (#298)
• Add checkpoint index retention for multi entity detector (#283)
• add HC detector request/failure stats (#307)
• Adding unit tests for Transport Actions (#327)
• Adding role based filtering for rest of APIs (#325)
• Adding support for Security Test Framework (#331)
• filter out exceptions which should not be counted in failure stats (#341)
• Moving Preview Anomaly Detectors to Transport layer (#321)

Bug Fixes

• Fix edge case where entities found for preview is empty (#296)
• fix null user in detector (#301)
• fix fatal error of missing method parseString (#302)
• remove clock Guice binding (#305)
• filter out empty value for entity features (#306)
• Fix for upgrading mapping (#309)
• fix double nan error when parse to json (#310)
• Fix issue where data hole exists for Preview API (#312)
• fix delete running detector bug (#320)
• Fix the profile API returns prematurely. (#340)
• Fix another case of the profile API returns prematurely (#353)

Infrastructure

• Add multi node integration testing into CI workflow (#318)

Documentation

• Updating Readme to include Secure tests (#334)

Maintenance

• Support ES 7.10.0 (#313)

Version 1.11.0.0

Compatible with Elasticsearch (7.9.1).

Features

• CLI: Update Detector Configurations (#233)
• Add support filtering the data by one categorical variable (#270)
• Added User support for background job and API Transport Actions (#272)

Enhancements

• remove deprecated code (#228)
• CLI: Download Detector Configuration as File (#229)
• CLI: Update Display Strings (#231)
• CLI: Fix build errors (#235)
• Adding RestActions support for AD Search Rest API's (#234)
• Adding RestActions support for Detector Stats API (#237)
• add anomaly feature attribution to model output (#232)
• Adding RestActions support Delete Detector API (#238)
• Adding RestActions support for Get Detector API (#242)
• Adding RestActions support Create/Update Detector API (#243)
• Modifying RestAction for Execute API (#246)
• Adding RestActions support for Start/Stop Detector API (#244)
• Verifying multi-entity detectors (#240)
• Selectively store anomaly results when index pressure is high (#241)
• Adding User support for Detector and DetectorJob (#251)
• suppport HC detector in profile api (#274)
• Auto flush checkpoint queue if too many are waiting (#279)
• Added User support for background job and API Transport Actions (#272)
• Renaming all Actions to distinguish between internal and external facing (#284)
• Adding new Search Detector Info API (#286)
• Updating Search Detector API to reject all queries other than BoolQuery (#288)
• set user as nested type to support exists query (#291)

Bug Fixes

• Fix nested field issue (#277)
• Upgrade mapping (#278)
• Fix issue where max number of multi-entity detector doesn't work for UpdateDetector (#285)
• Fix for stats API (#287)
• Fix for get detector API (#290)
• update user role filter to use nested query (#293)
• fix no permission when preview detector with detector id (#294)
• Injecting User role for background job (#295)

Infrastructure

• Ignoring flaky test (#255)
• Adding common-utils dependency from Maven (#280)
• fix build issue of common util (#281)
• Exclude IndexAnomalyDetectorResponse from Jacoco to unblock build (#292)

Documentation

• CLI: Update Display Strings (#231)
• Add release notes for 1.11.0.0 (#276)

Maintenance

• upgrade rcf libaries (#239)
• bump ad plugin version to 1.11.0 (#275)

Version 1.10.1.0

Compatible with Elasticsearch 7.9.1 and Open Distro for Elasticsearch 1.10.1.

Features

• AD CLI (#196)
• Get detector (#207)

Enhancements

• change to exhausive search for training data (#184)
• Adds initialization progress to profile API (#164)
• Queries data from the index when insufficient data in buffer to form a full shingle (#176)
• Adding multinode integration test support (#201)
• Change Profile List Format (#206)
• Improve ux (#209)
• Allows window size to be set per detector. (#203)
• not return estimated minutes remaining until cold start is finished (#210)
• minor edits to the short and long text strings (#211)
• Change to use callbacks in cold start (#208)
• fix job index mapping (#212)

Infrastructure

• Use goimports instead of gofmt (#214)
• Install go get outside cli directory (#216)

Documentation

• Automate release notes to unified standard (#191)
• Add badges to AD (#199)
• Test code coverage (#202)
• Include release notes for 1.10.0.0 (#219)
• Update README.md (#222)

Maintenance

• Upgrade from 1.9.0 to 1.10.0 (#215)
• Upgrade from 1.10.0 to 1.10.1 (#224)

Version 1.8.0.0

Open Distro for Elasticsearch Anomaly Detection Plugin 1.8.0.0 Release Notes

Compatible with Elasticsearch 7.7.0 and Open Distro for Elasticsearch 1.8.0.

Breaking Changes

• Artifact Name of Anomaly Detection Plugin for DEB and RPM distribution is updated from opendistro-anomaly-detector to opendistro-anomaly-detection. In order to reduce the impact of this change, we recommend removing the old opendistro-anomaly-detector plugin first with your package manager, before installing the upgraded opendistro-anomaly-detection.

New Features

• Add settings to disable/enable AD dynamically (#105) PR #127

Enhancements

• Ultrawarm integration PR #125
• Add shingle size, total model size, and model's hash ring to profile API PR #128
• Prevent creating detector with duplicate name. PR #134

Bug Fixes

• Fix that AD job cannot be terminated due to missing training data PR #126
• Fix incorrect detector count in stats APIs PR #129
• fix dynamic setting of max detector/feature limit PR #130

Infra Changes

• Add CI/CD workflows PR #133
• Use spotless to manage license headers and imports PR #136

Initial Release - Version 1.7.0.0

Compatible with Elasticsearch 7.6.1 and Open Distro for Elasticsearch 1.7.0.

The Open Distro for Elasticsearch Anomaly Detection 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 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 works independently. You can also use the plugin with the same version of the Open Distro 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

• Limit of 1000 detectors per Elasticsearch cluster
• Limit of 5 features per detector
• 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

Major Changes

• Add state and error to profile API PR #84
• Preview detector on the fly PR #72
• Cancel query if given detector already have one PR #54
• Support return AD job when get detector PR #50
• Add AD job on top of JobScheduler PR #44
• Adding negative cache to throttle extra request PR #40
• Add window delay support PR #24
• Circuit breaker PR #10 PR #7
• Stats collection PR #8

Enhancements

• Stats API: moved detector count call outside transport layer and make asynchronous PR #108
• Change AD result index rollover setting PR #100
• Add async maintenance PR #94
• Add async stopModel PR #93
• Add timestamp to async putModelCheckpoint PR #92
• Add async clear PR #91
• Use callbacks and bug fix PR #83
• Add async trainModel PR #81
• Add async getColdStartData PR #80
• Change the default value of lastUpdateTime PR #77
• Add async getThresholdingResult PR #70
• Add async getRcfResult PR #69
• Fix rcf random seed in preview PR #68
• Fix empty preview result due to insufficient sample PR #65
• Add async CheckpointDao methods. PR #62
• Record error and execution start/end time in AD result; handle except… PR #59
• Improve log message when we cannot get anomaly result PR #58
• Write detection code path in callbacks PR #48
• Send back error response when failing to stop detector PR #45
• Adjust preview configuration for more data PR #39
• Refactor using ClientUtil PR #32
• Return empty preview results on failure PR #31
• Allow non-negative window delay PR #30
• Return no data error message to preview PR #29
• Change AD setting name PR #26
• Add async CheckpointDao methods. PR #17
• Add async implementation of getFeaturesForSampledPeriods. PR #16
• Add async implementation of getFeaturesForPeriod. PR #15
• Add test evaluating anomaly results PR #13

Bug Fixes

• Change setting name so that rpm/deb has the same name as zip PR #109
• Can't start AD job if detector has no feature PR #76
• Fix null pointer exception during preview PR #74
• Add threadpool prefix and change threadpool name PR #56
• Change setting name and fix stop AD request PR #41
• Revert "merge changes from alpha branch: change setting name and fix … PR #38
• Fix stop detector api to use correct request PR #25

Infra Changes

• Add release notes for ODFE 1.7.0 PR #120 PR #119
• Open Distro Release 1.7.0 PR #106
• Create opendistro-elasticsearch-anomaly-detection.release-notes.md PR #103
• Update test branch PR #101
• Bump opendistroVersion to 1.6.1 PR #99
• Change to mention we support only JDK 13 PR #98
• AD opendistro 1.6 support PR #87
• Added URL for jb_scheduler-plugin_zip instead of local file path PR #82
• Change build instruction for JDK PR #61
• ODFE 1.4.0 PR #43
• Add spotless for code format PR #22
• Update third-party PR #14
• Build artifacts for rpm, deb, zip PR #5
• Update test-workflow.yml PR #2

v1.2.1-alpha

Initial alpha release of Anomaly Detector for opendistro-for-elasticsearch.