Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add two new settings for Anomaly Detection 2.5 #2450

Merged
merged 5 commits into from
Jan 23, 2023

Conversation

amitgalitz
Copy link
Member

Signed-off-by: Amit Galitzky amgalitz@amazon.com

Description

Add two new settings for AD plugin: plugins.anomaly_detection.hcad_cold_start_interpolation.enabled and plugins.anomaly_detection.door_keeper_in_cache.enabled

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>
@amitgalitz amitgalitz requested a review from a team as a code owner January 20, 2023 21:21
Signed-off-by: Amit Galitzky <amgalitz@amazon.com>
@Naarcha-AWS Naarcha-AWS added the v2.5.0 'Issues and PRs related to version v2.5.0' label Jan 20, 2023
@@ -45,3 +45,5 @@ plugins.anomaly_detection.delete_anomaly_result_when_delete_detector | False | W
plugins.anomaly_detection.dedicated_cache_size | 10 | If the real-time analysis of a high cardinality detector starts successfully, the anomaly detection plugin guarantees keeping 10 (dynamically adjustable via this setting) entities' models in memory per node. If the number of entities exceeds this limit, the plugin puts the extra entities' models in a memory space shared by all detectors. The actual number of entities varies based on the memory that you've available and the frequencies of the entities. If you'd like the plugin to guarantee keeping more entities' models in memory and if you're cluster has sufficient memory, you can increase this setting value.
plugins.anomaly_detection.max_concurrent_preview | 2 | The maximum number of concurrent previews. You can use this setting to limit resource usage.
plugins.anomaly_detection.model_max_size_percent | 0.1 | The upper bound of the memory percentage for a model.
plugins.anomaly_detection.door_keeper_in_cache.enabled | False | We have a bloom filter placed in front of an inactive entity cache to filter out unpopular items that are not likely to appear more than once. This setting allows you to either enable the bloom filter or not.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we say "The anomaly detection plugin has a bloom filter"? To avoid the use of "we".

Suggested change
plugins.anomaly_detection.door_keeper_in_cache.enabled | False | We have a bloom filter placed in front of an inactive entity cache to filter out unpopular items that are not likely to appear more than once. This setting allows you to either enable the bloom filter or not.
plugins.anomaly_detection.door_keeper_in_cache.enabled | False | The anomaly detection plugin has a bloom filter placed in front of an inactive entity cache to filter out unpopular items that are not likely to appear more than once. This setting allows you to either enable or disable the bloom filter.

@@ -45,3 +45,5 @@ plugins.anomaly_detection.delete_anomaly_result_when_delete_detector | False | W
plugins.anomaly_detection.dedicated_cache_size | 10 | If the real-time analysis of a high cardinality detector starts successfully, the anomaly detection plugin guarantees keeping 10 (dynamically adjustable via this setting) entities' models in memory per node. If the number of entities exceeds this limit, the plugin puts the extra entities' models in a memory space shared by all detectors. The actual number of entities varies based on the memory that you've available and the frequencies of the entities. If you'd like the plugin to guarantee keeping more entities' models in memory and if you're cluster has sufficient memory, you can increase this setting value.
plugins.anomaly_detection.max_concurrent_preview | 2 | The maximum number of concurrent previews. You can use this setting to limit resource usage.
plugins.anomaly_detection.model_max_size_percent | 0.1 | The upper bound of the memory percentage for a model.
plugins.anomaly_detection.door_keeper_in_cache.enabled | False | We have a bloom filter placed in front of an inactive entity cache to filter out unpopular items that are not likely to appear more than once. This setting allows you to either enable the bloom filter or not.
plugins.anomaly_detection.hcad_cold_start_interpolation.enabled | False | Whether interpolation in HCAD cold start is enabled or not.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
plugins.anomaly_detection.hcad_cold_start_interpolation.enabled | False | Whether interpolation in HCAD cold start is enabled or not.
plugins.anomaly_detection.hcad_cold_start_interpolation.enabled | False | Whether interpolation in HCAD cold start is enabled.

_monitoring-plugins/ad/settings.md Outdated Show resolved Hide resolved
_monitoring-plugins/ad/settings.md Outdated Show resolved Hide resolved
@Naarcha-AWS Naarcha-AWS added the release-notes PR: Include this PR in the automated release notes label Jan 20, 2023
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. One comment.

_monitoring-plugins/ad/settings.md Outdated Show resolved Hide resolved
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS merged commit 620b363 into opensearch-project:main Jan 23, 2023
vagimeli pushed a commit that referenced this pull request Jan 25, 2023
* add two new settings for Anomaly Detection

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>

* fixed setting mistake

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>

* Update _monitoring-plugins/ad/settings.md

* Update _monitoring-plugins/ad/settings.md

* Update _monitoring-plugins/ad/settings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
vagimeli added a commit that referenced this pull request Jan 26, 2023
vagimeli pushed a commit that referenced this pull request Jan 27, 2023
* add two new settings for Anomaly Detection

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>

* fixed setting mistake

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>

* Update _monitoring-plugins/ad/settings.md

* Update _monitoring-plugins/ad/settings.md

* Update _monitoring-plugins/ad/settings.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

Signed-off-by: Amit Galitzky <amgalitz@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
vagimeli added a commit that referenced this pull request Jan 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes PR: Include this PR in the automated release notes v2.5.0 'Issues and PRs related to version v2.5.0'
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants