[POC] [Response Ops] Onboard detection rules to use alerting framework summaries. #147539
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…per and adding it to persistence rule type
…76-alerts-summary
…oard-detection-rules
…ery alerts should be calculated and alerts stored in task state. Hacking 1h throttle to 5m for testing
…nction to action variable definition
💔 Build FailedFailed CI Steps
Test Failures
Metrics [docs]Page load bundle
History
To update your PR or re-run it, just comment with: |
ymao1
commented
Dec 20, 2022
| @@ -123,7 +132,7 @@ function processAlertsHelper< | |||
| updateAlertFlappingHistory(activeAlerts[id], false); | |||
| } | |||
| } | |||
| } else if (existingAlertIds.has(id)) { | |||
| } else if (existingAlertIds.has(id) && autoRecoverAlerts) { | |||
There was a problem hiding this comment.
Skips this step for persistent alert rule types (slight time optimization when running a rule)
ymao1
commented
Dec 20, 2022
| @@ -197,6 +207,13 @@ export interface RuleType< | |||
| cancelAlertsOnRuleTimeout?: boolean; | |||
| doesSetRecoveryContext?: boolean; | |||
| getSummarizedAlerts?: GetSummarizedAlertsFn; | |||
| getRuleUrl?: GetRuleUrlFn<Params>; | |||
There was a problem hiding this comment.
allows rule types to specify custom function for building rule URLs
ymao1
commented
Dec 20, 2022
| ...alerts, | ||
| all: { | ||
| count: total, | ||
| data: [...alerts.new.data, ...alerts.ongoing.data, ...alerts.recovered.data], | ||
| }, | ||
| }; | ||
|
|
||
| if (summarizedAlerts.all.count > 0) { |
There was a problem hiding this comment.
Returns the time bounds for summarized alerts that can be used for building rule URLs. This ensures that the time bounds used to load alerts in the UI matches the time bounds for the alert summary so the alert counts match.
There was a problem hiding this comment.
Calculating it from the summarized alerts instead of using existing time bounds because when we query for alerts per rule execution UUID, we don't have existing time bounds.
ymao1
commented
Dec 20, 2022
| @@ -32,6 +33,7 @@ interface CreateGetSummarizedAlertsFnOpts { | |||
| ruleDataClient: PublicContract<IRuleDataClient>; | |||
| useNamespace: boolean; | |||
| isLifecycleAlert: boolean; | |||
| formatAlert?: (alert: unknown) => unknown; | |||
There was a problem hiding this comment.
Allows rule types to pass in custom functions for formatting summarized alerts. This allows detection rules to be formatted exactly as they were before.
ymao1
commented
Dec 20, 2022
| }) | ||
| .filter((_, idx) => response.body.items[idx].create?.status === 201); | ||
|
|
||
| createdAlerts.forEach((alert) => |
There was a problem hiding this comment.
Reporting alerts 1-1 back to the framework.
ymao1
commented
Dec 20, 2022
| frequency: { | ||
| summary: true, | ||
| notifyWhen: 'onThrottleInterval', | ||
| throttle: throttle === '1h' ? '5m' : throttle, |
There was a problem hiding this comment.
Setting 'hourly' to 5 minutes for easier testing.
ymao1
changed the title
Add frequency support on legacy action migration
… into poc/onboard-detection-rules
ymao1
commented
Apr 12, 2023
| .filter((_, idx) => response.body.items[idx].create?.status === 201); | ||
|
|
||
| createdAlerts.forEach((alert) => | ||
| options.services.alertFactory.create(alert._id).scheduleActions('default', {}) |
There was a problem hiding this comment.
Suggested change
| options.services.alertFactory.create(alert._id).scheduleActions('default', {}) | |
| options.services.alertFactory.create(alert._id).scheduleActions('default', { | |
| alerts: [alert], | |
| results_link: <ruleUrl> | |
| }).replaceState({ signals_count: 1}); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Towards #147379
Summary
POC to remove custom notification scheduling from detection rules in favor of reporting alerts 1-to-1 back to the alerting platform and using the new alert summaries feature.
In this POC:
Not in this POC: