[Alerting] Adding a configurable minimal rule interval for newly created rules #125396

ymao1 · 2022-02-11T15:58:22Z

Summary

Removed minimumScheduleInterval from rule type registration since it was not used by any rule type
Added minimumScheduleInterval to kibana.yml config
Updated server side validation to use configured value instead of rule type value
Updated client side validation to use configured value instead of rule type value
- Added new route for getting this config inside triggers_actions_ui plugin

To verify:

Verify that rules created before this PR with an interval less than the minimum continue running
Verify that when updating existing rules with too-short intervals, the minimum is enforced.
Verify that you cannot create a rule via the UI or API with a schedule less than the minimum.

Breaking Change

We previously did not enforce any minimum schedule interval for rules. Adding this minimum may be a breaking change for users using automated methods to create or update their rules. If users are impacted by this change in behavior, they have the option of configuring xpack.alerting.minimumScheduleInterval to be a smaller value or increasing the interval of their alerting rules.

Checklist

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

…egistry

…g/minimum_rule_interval

ymao1 · 2022-02-11T19:27:16Z

docs/settings/alert-action-settings.asciidoc

I will make a separate PR to add this to the cloud allowlist.

ymao1 · 2022-02-11T19:28:55Z

x-pack/plugins/alerting/server/plugin.ts

@@ -139,7 +138,7 @@ export interface AlertingPluginsStart {
 }

 export class AlertingPlugin {
-  private readonly config: Promise<AlertsConfig>;
+  private readonly config: AlertingConfig;


Not sure why this was a Promise, but I am able to get the config synchronously so I updated the code. If there's a reason it has to be a Promise, am happy to revert these changes.

…g/minimum_rule_interval

ymao1 · 2022-02-14T18:16:11Z

x-pack/test/alerting_api_integration/common/config.ts

@@ -161,6 +161,7 @@ export function createTestConfig(name: string, options: CreateTestConfigOptions)
          '--xpack.encryptedSavedObjects.encryptionKey="wuGNaIhoMpk5sO4UBxgr3NyW1sFcLgIf"',
          '--xpack.alerting.invalidateApiKeysTask.interval="15s"',
          '--xpack.alerting.healthCheck.interval="1s"',
+          '--xpack.alerting.minimumScheduleInterval="1s"',


Setting minimum very short on functional tests.

elasticmachine · 2022-02-14T18:16:58Z

Pinging @elastic/response-ops (Team:ResponseOps)

ymao1 · 2022-02-24T15:58:03Z

Cloud allowlist PR: https://github.com/elastic/cloud/pull/98054

ymao1 · 2022-02-24T16:37:30Z

@elasticmachine merge upstream

ymao1 · 2022-02-24T23:51:01Z

@elasticmachine merge upstream

ymao1 · 2022-02-25T00:25:18Z

Followup issue for enabling/disabling: #126409

ymao1 · 2022-02-28T12:44:06Z

@elasticmachine merge upstream

ymao1 · 2022-02-28T21:14:13Z

@elasticmachine merge upstream

kibana-ci · 2022-02-28T22:38:27Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`triggersActionsUi`	322	325	+3

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`alerting`	291	292	+1
`triggersActionsUi`	234	235	+1
total			+2

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`triggersActionsUi`	677.8KB	678.8KB	+1.0KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`alerting`	37.9KB	38.1KB	+104.0B

Unknown metric groups

API count

id	before	after	diff
`alerting`	299	300	+1
`triggersActionsUi`	246	247	+1
total			+2

History

💚 Build #26512 succeeded 04ab4cf
💚 Build #26364 succeeded 6a0996a
💚 Build #26288 succeeded 96a537b
💔 Build #26253 failed 5046b7c
💔 Build #26227 failed 62d4c03
💚 Build #25975 succeeded 9c5113d

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @ymao1

…interval for rules Fixes failing cypress tests that are a result of this recent change within alerting - #125396 Rule min interval times now must be 1 minute or greater.

ymao1 · 2022-03-14T16:22:54Z

With this PR: #127498, we are changing the default behavior to warn instead of error so removing the breaking changes label.

ymao1 added 6 commits February 11, 2022 10:57

Removing minimumScheduleInterval on rule type registration

2ece90b

Adding minimumScheduleInterval to config and enforcing in rule type r…

2954d0d

…egistry

Validating interval on create and update

ab1c9be

Fixing types and tests

376d727

Merge branch 'main' of https://github.com/elastic/kibana into alertin…

bd9235e

…g/minimum_rule_interval

Fixing types and tests

f00214a

ymao1 commented Feb 11, 2022

View reviewed changes

ymao1 added 5 commits February 11, 2022 14:50

Fixing types and tests

438eed2

Merge branch 'main' of https://github.com/elastic/kibana into alertin…

b07b6b4

…g/minimum_rule_interval

Passing config to client and using to validate on rule creation

5c7a1b2

Merge branch 'main' of https://github.com/elastic/kibana into alertin…

7bdca32

…g/minimum_rule_interval

Fixing small bug and tests

991eb1d

ymao1 changed the title ~~Removing minimumScheduleInterval on rule type registration~~ [Alerting] Adding a configurable minimal rule interval for newly created rules Feb 14, 2022

ymao1 commented Feb 14, 2022

View reviewed changes

ymao1 self-assigned this Feb 14, 2022

ymao1 marked this pull request as ready for review February 14, 2022 18:16

ymao1 requested a review from a team as a code owner February 14, 2022 18:16

ymao1 added release_note:breaking and removed release_note:skip Skip the PR/issue when compiling release notes labels Feb 14, 2022

ymao1 added 2 commits February 14, 2022 14:24

Fixing tests

2c2824f

Fixing tests

1f69d6d

ymao1 requested a review from a team as a code owner February 14, 2022 20:50

Fixing tests

9e2eee1

kibanamachine and others added 2 commits February 24, 2022 11:37

Merge branch 'main' into alerting/minimum_rule_interval

5046b7c

Fixing tests from bad merge

96a537b

spong mentioned this pull request Feb 24, 2022

[Security Solution][Detections] Update Rule Schedule UI to support new minimum interval setting #126393

Open

Merge branch 'main' into alerting/minimum_rule_interval

6a0996a

ymao1 mentioned this pull request Feb 25, 2022

[ResponseOps] UX for rules where interval is less than configured minimum #126409

Closed

Merge branch 'main' into alerting/minimum_rule_interval

04ab4cf

neptunian approved these changes Feb 28, 2022

View reviewed changes

Merge branch 'main' into alerting/minimum_rule_interval

459ac24

ymao1 merged commit f51131c into elastic:main Feb 28, 2022

ymao1 deleted the alerting/minimum_rule_interval branch February 28, 2022 22:48

yctercero mentioned this pull request Mar 1, 2022

[Security Solution][Cypress] - Update cypress tests to match new min interval for rules #126622

Merged

1 task

mikecote mentioned this pull request Mar 4, 2022

Warn by default when rules created below the minimum rule interval #126946

Closed

nickpeihl mentioned this pull request Mar 9, 2022

[Maps] Update asset tracking tutorial docs with new minimal rule interval #127289

Closed

ymao1 mentioned this pull request Mar 14, 2022

[Alerting] Warn by default when rule schedule interval is set below the minimum configured. #127498

Merged

2 tasks

ymao1 removed the release_note:breaking label Mar 14, 2022

tylersmalley added ci:cloud-deploy Create or update a Cloud deployment and removed ci:deploy-cloud labels Aug 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Alerting] Adding a configurable minimal rule interval for newly created rules #125396

[Alerting] Adding a configurable minimal rule interval for newly created rules #125396

ymao1 commented Feb 11, 2022 •

edited

Loading

ymao1 Feb 11, 2022

ymao1 Feb 11, 2022

ymao1 Feb 14, 2022

elasticmachine commented Feb 14, 2022

ymao1 commented Feb 24, 2022

ymao1 commented Feb 24, 2022

ymao1 commented Feb 24, 2022

ymao1 commented Feb 25, 2022

ymao1 commented Feb 28, 2022

ymao1 commented Feb 28, 2022

kibana-ci commented Feb 28, 2022

API count

ymao1 commented Mar 14, 2022

[Alerting] Adding a configurable minimal rule interval for newly created rules #125396

[Alerting] Adding a configurable minimal rule interval for newly created rules #125396

Conversation

ymao1 commented Feb 11, 2022 • edited Loading

Summary

To verify:

Breaking Change

Checklist

ymao1 Feb 11, 2022

Choose a reason for hiding this comment

ymao1 Feb 11, 2022

Choose a reason for hiding this comment

ymao1 Feb 14, 2022

Choose a reason for hiding this comment

elasticmachine commented Feb 14, 2022

ymao1 commented Feb 24, 2022

ymao1 commented Feb 24, 2022

ymao1 commented Feb 24, 2022

ymao1 commented Feb 25, 2022

ymao1 commented Feb 28, 2022

ymao1 commented Feb 28, 2022

kibana-ci commented Feb 28, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

ymao1 commented Mar 14, 2022

ymao1 commented Feb 11, 2022 •

edited

Loading