Resolve default for ActionExecutionPolicy at runtime by qreshi · Pull Request #165 · opensearch-project/alerting

qreshi · 2021-09-01T20:56:22Z

Signed-off-by: Mohammad Qureshi qreshi@amazon.com

Issue #, if available: #86

Description of changes:
Previously, since the ActionExecutionScope was required for Bucket-Level Monitor executions, the default configuration was being put into the Action config itself. The problem with this was that Action is Monitor agnostic so it is not aware of the Monitor type it is being defined for. This means that the Action policy default (which is meant for Bucket-Level Monitors) would have been put into every Action defined in Query-Level Monitor if none were explicitly given which could cause backwards compatibility issues if the ActionExecutionPolicy integrates with Query-Level Monitors in the future.

To clean up the ActionExecutionPolicy behavior, the following changes were made:

throttle was originally added into ActionExecutionPolicy with the intention that both throttle and throttleEnabled would be moved in there since it is considered an Action behavior config but it was moved out since throttle and throttleEnabled fields already exist outside of this config within the Action (this avoids any inconsistencies and lets us avoid backwards compatibility problems)
The ActionExecutionPolicy is now nullable within the Action definition and in the case of Bucket-Level Monitors, it will be resolved to the default if not given during runtime. This gives us the flexibility to default different configurations based on the Monitor types

CheckList:
[x] Commits are signed per the DCO using --signoff

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

Signed-off-by: Mohammad Qureshi <qreshi@amazon.com>

* Added release notes for OpenSearch 1.0.0.0. (#123) (#124) Co-authored-by: AWSHurneyt <79280347+AWSHurneyt@users.noreply.github.com> * Add Integtest.sh for OpenSearch integtest setups (#121) * Add integtest script to the repo Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Add Alerting specific security param for integTest Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Remove default assignee (#127) Signed-off-by: Ashish Agrawal <ashisagr@amazon.com> * Removing All Usages of Action Get Method Calls and adding the listeners (#130) Signed-off-by: Aditya Jindal <aditjind@amazon.com> * Fix snapshot build and increment to 1.1.0. (#142) Signed-off-by: dblock <dblock@amazon.com> * Refactor MonitorRunner (#143) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update Bucket-Level Alerting RFC (#145) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add BucketSelector pipeline aggregation extension (#144) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Add AggregationResultBucket (#148) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Add ActionExecutionPolicy (#149) * Add ActionExecutionPolicy Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Throw exception if there is an invalid field in PER_ALERT config when parsing Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Don't allow throttle to be configured for PerExecutionActionScope at the data class level since it is not supported yet Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Refactor Monitor and Trigger to split into Query-Level and Bucket-Lev… (#150) * Refactor Monitor and Trigger to split into Query-Level and Bucket-Level Monitors Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Require condition to not be null when parsing Bucket-Level Trigger Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update InputService for Bucket-Level Alerting (#152) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Update TriggerService for Bucket-Level Alerting (#153) * Update TriggerService for Bucket-Level Alerting Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Remove client from TriggerService Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update AlertService for Bucket-Level Alerting (#154) * Update AlertService for Bucket-Level Alerting Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Move Alert search size for Bucket-Level Monitors to a const Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add worksheets to help with testing (#151) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update MonitorRunner for Bucket-Level Alerting (#155) * Update MonitorRunner for Bucket-Level Alerting Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update regressed comment in MonitorRunnerIT Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add TODO to break down runBucketLevelMonitor method in MonitorRunner Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Fix ktlint formatting issues (#156) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Execute Actions on runTrigger exceptions for Bucket-Level Monitor (#157) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Skip execution of Actions on ACKNOWLEDGED Alerts for Bucket-Level Monitors (#158) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Return first page of input results in MonitorRunResult for Bucket-Level Monitor (#159) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add setting to limit per alert action executions and don't save Alerts for test Bucket-Level Monitors (#161) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Fix bug in paginating multiple bucket paths for Bucket-Level Monitor (#163) * Fix bug in paginating multiple bucket paths for Bucket-Level Monitor Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Change trigger after key conditionals to when statement Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Various bug fixes pertaining to throttling on PER_ALERT, saving COMPLETED Alerts and rewriting input query for Bucket-Level Monitors (#164) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Return only monitors for /monitors/_search. (#162) * Return only monitors for /monitors/_search. * Added missing imports * Added additional check to the unit test * Resolve default for ActionExecutionPolicy at runtime (#165) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: AWSHurneyt <79280347+AWSHurneyt@users.noreply.github.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Ashish Agrawal <ashisagr@amazon.com> Co-authored-by: Daniel Doubrovkine (dB.) <dblock@dblock.org> Co-authored-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> Co-authored-by: Sriram <59816283+skkosuri-amzn@users.noreply.github.com>

…ledging more than 10 alerts at once. (#205) * Added release notes for OpenSearch 1.0.0.0. (#123) * Merge commits from the main branch to the 1.x branch. (#133) * Added release notes for OpenSearch 1.0.0.0. (#123) (#124) Co-authored-by: AWSHurneyt <79280347+AWSHurneyt@users.noreply.github.com> * Add Integtest.sh for OpenSearch integtest setups (#121) * Add integtest script to the repo Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Add Alerting specific security param for integTest Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Remove default assignee (#127) Signed-off-by: Ashish Agrawal <ashisagr@amazon.com> * Removing All Usages of Action Get Method Calls and adding the listeners (#130) Signed-off-by: Aditya Jindal <aditjind@amazon.com> * Fix snapshot build and increment to 1.1.0. (#142) Signed-off-by: dblock <dblock@amazon.com> * Refactor MonitorRunner (#143) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update Bucket-Level Alerting RFC (#145) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add BucketSelector pipeline aggregation extension (#144) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Add AggregationResultBucket (#148) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Add ActionExecutionPolicy (#149) * Add ActionExecutionPolicy Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Throw exception if there is an invalid field in PER_ALERT config when parsing Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Don't allow throttle to be configured for PerExecutionActionScope at the data class level since it is not supported yet Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Refactor Monitor and Trigger to split into Query-Level and Bucket-Lev… (#150) * Refactor Monitor and Trigger to split into Query-Level and Bucket-Level Monitors Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Require condition to not be null when parsing Bucket-Level Trigger Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update InputService for Bucket-Level Alerting (#152) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Update TriggerService for Bucket-Level Alerting (#153) * Update TriggerService for Bucket-Level Alerting Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Remove client from TriggerService Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update AlertService for Bucket-Level Alerting (#154) * Update AlertService for Bucket-Level Alerting Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Move Alert search size for Bucket-Level Monitors to a const Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add worksheets to help with testing (#151) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update MonitorRunner for Bucket-Level Alerting (#155) * Update MonitorRunner for Bucket-Level Alerting Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update regressed comment in MonitorRunnerIT Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add TODO to break down runBucketLevelMonitor method in MonitorRunner Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Fix ktlint formatting issues (#156) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Execute Actions on runTrigger exceptions for Bucket-Level Monitor (#157) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Skip execution of Actions on ACKNOWLEDGED Alerts for Bucket-Level Monitors (#158) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Return first page of input results in MonitorRunResult for Bucket-Level Monitor (#159) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add setting to limit per alert action executions and don't save Alerts for test Bucket-Level Monitors (#161) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Fix bug in paginating multiple bucket paths for Bucket-Level Monitor (#163) * Fix bug in paginating multiple bucket paths for Bucket-Level Monitor Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Change trigger after key conditionals to when statement Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Various bug fixes pertaining to throttling on PER_ALERT, saving COMPLETED Alerts and rewriting input query for Bucket-Level Monitors (#164) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Return only monitors for /monitors/_search. (#162) * Return only monitors for /monitors/_search. * Added missing imports * Added additional check to the unit test * Resolve default for ActionExecutionPolicy at runtime (#165) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: AWSHurneyt <79280347+AWSHurneyt@users.noreply.github.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Ashish Agrawal <ashisagr@amazon.com> Co-authored-by: Daniel Doubrovkine (dB.) <dblock@dblock.org> Co-authored-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> Co-authored-by: Sriram <59816283+skkosuri-amzn@users.noreply.github.com> * Add release notes for 1.1.0.0 release (#166) (#167) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Remove default integtest.sh. (#181) Signed-off-by: dblock <dblock@dblock.org> * Add valid search filters. (#191) * Add valid search filters. * Added this fix to release notes * Publish notification JARs checksums. (#197) Signed-off-by: dblock <dblock@dblock.org> * Also publish SHA 256 and 512 checksums. (#198) * Also publish SHA 256 and 512 checksums. Signed-off-by: dblock <dblock@dblock.org> * Remove sonatype staging. Signed-off-by: dblock <dblock@dblock.org> * Fixed a bug that was preventing the AcknowledgeAlerts API from acknowledging more than 10 alerts at once. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Implemented integration tests to ensure fix for issue 203 is working as expected. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Refactored integ tests based on PR feedback, and listed the bug fix in the release notes. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> * Removing bug fixes from release notes. Currently discussing adding separate notes for this patch. Signed-off-by: Thomas Hurney <hurneyt@amazon.com> Co-authored-by: Aditya Jindal <13850971+aditjind@users.noreply.github.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Ashish Agrawal <ashisagr@amazon.com> Co-authored-by: Daniel Doubrovkine (dB.) <dblock@dblock.org> Co-authored-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> Co-authored-by: Sriram <59816283+skkosuri-amzn@users.noreply.github.com>

…ject#133) * Added release notes for OpenSearch 1.0.0.0. (opensearch-project#123) (opensearch-project#124) Co-authored-by: AWSHurneyt <79280347+AWSHurneyt@users.noreply.github.com> * Add Integtest.sh for OpenSearch integtest setups (opensearch-project#121) * Add integtest script to the repo Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Add Alerting specific security param for integTest Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> * Remove default assignee (opensearch-project#127) Signed-off-by: Ashish Agrawal <ashisagr@amazon.com> * Removing All Usages of Action Get Method Calls and adding the listeners (opensearch-project#130) Signed-off-by: Aditya Jindal <aditjind@amazon.com> * Fix snapshot build and increment to 1.1.0. (opensearch-project#142) Signed-off-by: dblock <dblock@amazon.com> * Refactor MonitorRunner (opensearch-project#143) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update Bucket-Level Alerting RFC (opensearch-project#145) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add BucketSelector pipeline aggregation extension (opensearch-project#144) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Add AggregationResultBucket (opensearch-project#148) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Add ActionExecutionPolicy (opensearch-project#149) * Add ActionExecutionPolicy Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Throw exception if there is an invalid field in PER_ALERT config when parsing Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Don't allow throttle to be configured for PerExecutionActionScope at the data class level since it is not supported yet Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Refactor Monitor and Trigger to split into Query-Level and Bucket-Lev… (opensearch-project#150) * Refactor Monitor and Trigger to split into Query-Level and Bucket-Level Monitors Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Require condition to not be null when parsing Bucket-Level Trigger Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update InputService for Bucket-Level Alerting (opensearch-project#152) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> * Update TriggerService for Bucket-Level Alerting (opensearch-project#153) * Update TriggerService for Bucket-Level Alerting Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Remove client from TriggerService Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update AlertService for Bucket-Level Alerting (opensearch-project#154) * Update AlertService for Bucket-Level Alerting Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Move Alert search size for Bucket-Level Monitors to a const Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add worksheets to help with testing (opensearch-project#151) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update MonitorRunner for Bucket-Level Alerting (opensearch-project#155) * Update MonitorRunner for Bucket-Level Alerting Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Update regressed comment in MonitorRunnerIT Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add TODO to break down runBucketLevelMonitor method in MonitorRunner Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Fix ktlint formatting issues (opensearch-project#156) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Execute Actions on runTrigger exceptions for Bucket-Level Monitor (opensearch-project#157) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Skip execution of Actions on ACKNOWLEDGED Alerts for Bucket-Level Monitors (opensearch-project#158) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Return first page of input results in MonitorRunResult for Bucket-Level Monitor (opensearch-project#159) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Add setting to limit per alert action executions and don't save Alerts for test Bucket-Level Monitors (opensearch-project#161) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Fix bug in paginating multiple bucket paths for Bucket-Level Monitor (opensearch-project#163) * Fix bug in paginating multiple bucket paths for Bucket-Level Monitor Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Change trigger after key conditionals to when statement Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Various bug fixes pertaining to throttling on PER_ALERT, saving COMPLETED Alerts and rewriting input query for Bucket-Level Monitors (opensearch-project#164) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> * Return only monitors for /monitors/_search. (opensearch-project#162) * Return only monitors for /monitors/_search. * Added missing imports * Added additional check to the unit test * Resolve default for ActionExecutionPolicy at runtime (opensearch-project#165) Signed-off-by: Mohammad Qureshi <qreshi@amazon.com> Co-authored-by: AWSHurneyt <79280347+AWSHurneyt@users.noreply.github.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com> Co-authored-by: Ashish Agrawal <ashisagr@amazon.com> Co-authored-by: Daniel Doubrovkine (dB.) <dblock@dblock.org> Co-authored-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> Co-authored-by: Rishabh Maurya <rishabhmaurya05@gmail.com> Co-authored-by: Sriram <59816283+skkosuri-amzn@users.noreply.github.com> Signed-off-by: AWSHurneyt <hurneyt@amazon.com>

Resolve default for ActionExecutionPolicy at runtime

0955c5b

Signed-off-by: Mohammad Qureshi <qreshi@amazon.com>

qreshi requested review from adityaj1107, lezzago and rishabhmaurya September 1, 2021 20:56

adityaj1107 approved these changes Sep 1, 2021

View reviewed changes

qreshi merged commit d5dbdd6 into opensearch-project:main Sep 1, 2021

qreshi deleted the default-action-config branch September 1, 2021 23:38

qreshi mentioned this pull request Sep 2, 2021

Update formik conversion for Bucket-Level Trigger to handle throttle change opensearch-project/alerting-dashboards-plugin#92

Merged

5 tasks

annie3431 mentioned this pull request Sep 2, 2021

Update formik conversion for Bucket-Level Trigger to handle throttle change opensearch-project/alerting-dashboards-plugin#97

Merged

5 tasks

qreshi added the feature A change that introduces a new unit of functionality label Sep 8, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Resolve default for ActionExecutionPolicy at runtime#165

Resolve default for ActionExecutionPolicy at runtime#165
qreshi merged 1 commit intoopensearch-project:mainfrom
qreshi:default-action-config

qreshi commented Sep 1, 2021 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

qreshi commented Sep 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

qreshi commented Sep 1, 2021 •

edited

Loading