Security Analytics—additional updates following 2.5 release#2515
Security Analytics—additional updates following 2.5 release#2515
Conversation
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
| ## Step 3. Set up alerts | ||
|
|
||
| At this stage, setting up alerts is optional for creating a new detector. Alerts can be configured at any time, including from the Findings window. This section describes the process for defining the alert conditions during creation of a detector. To see how to initiate creation of alerts from the Findings window, see [The findings list]({{site.url}}{{site.baseurl}}/security-analytics/usage/findings/#the-findings-list). | ||
| The third step in creating a detector involves setting up alerts. Alerts are configured to create triggers that, when matched with a set of detection rule criteria, send a notification of a possible security event. You can select the criteria (rules, rule severity, and tags) in any combination to define a trigger. Once a trigger is defined, the alert setup lets you choose the channel on which to be notified and provides options for customizing a message for the notification. |
There was a problem hiding this comment.
| The third step in creating a detector involves setting up alerts. Alerts are configured to create triggers that, when matched with a set of detection rule criteria, send a notification of a possible security event. You can select the criteria (rules, rule severity, and tags) in any combination to define a trigger. Once a trigger is defined, the alert setup lets you choose the channel on which to be notified and provides options for customizing a message for the notification. | |
| The third step in creating a detector involves setting up alerts. Alerts are configured to create triggers that, when matched with a set of detection rule criteria, send a notification of a possible security event. You can select the criteria such as rules, rule severity, and tags in any combination to define a trigger. Once a trigger is defined, the alert setup lets you choose the channel on which to be notified and provides options for customizing a message for the notification. |
There was a problem hiding this comment.
I agree, it's a little clunky like that. These three criteria, however, are the only three criteria. So "such as" doesn't work. But I've run them into the sentence to address the problem you point out.
"You can select rule names, rule severity, and tags in any combination to define a trigger."
Thanks.
There was a problem hiding this comment.
Echoing what Alice said but with a different suggestion:
| The third step in creating a detector involves setting up alerts. Alerts are configured to create triggers that, when matched with a set of detection rule criteria, send a notification of a possible security event. You can select the criteria (rules, rule severity, and tags) in any combination to define a trigger. Once a trigger is defined, the alert setup lets you choose the channel on which to be notified and provides options for customizing a message for the notification. | |
| The third step in creating a detector involves setting up alerts. Alerts are configured to create triggers that, when matched with a set of detection rule criteria, send a notification of a possible security event. Detection rule criteria includes the following: | |
| - Rules | |
| - Rule severity | |
| - Tags | |
| After defining the trigger, the alert setup lets you choose the channel on which to be notified and provides options for customizing a message for the notification. |
There was a problem hiding this comment.
This is just a basic description of what is to follow. Each of the three configuration settings are addressed separately in step two of Alert setup (immediately below this). I don't really want to make a big deal about these three settings at this point - I just want to make the process familiar and then mention each in detail in the steps.
Generally for alert setup you make selections for the rule criteria and configure a notification if you want a notification. The specific steps are covered in material that follows. It doesn't really make sense to emphasize these here, not emphasize the steps for notifications, and then re-emphasize the rule criteria in steps a few lines later.
| ## Step 3. Set up alerts | ||
|
|
||
| At this stage, setting up alerts is optional for creating a new detector. Alerts can be configured at any time, including from the Findings window. This section describes the process for defining the alert conditions during creation of a detector. To see how to initiate creation of alerts from the Findings window, see [The findings list]({{site.url}}{{site.baseurl}}/security-analytics/usage/findings/#the-findings-list). | ||
| The third step in creating a detector involves setting up alerts. Alerts are configured to create triggers that, when matched with a set of detection rule criteria, send a notification of a possible security event. You can select the criteria (rules, rule severity, and tags) in any combination to define a trigger. Once a trigger is defined, the alert setup lets you choose the channel on which to be notified and provides options for customizing a message for the notification. |
There was a problem hiding this comment.
I agree, it's a little clunky like that. These three criteria, however, are the only three criteria. So "such as" doesn't work. But I've run them into the sentence to address the problem you point out.
"You can select rule names, rule severity, and tags in any combination to define a trigger."
Thanks.
Naarcha-AWS
left a comment
There was a problem hiding this comment.
A couple comments, but looks good.
| ## Step 3. Set up alerts | ||
|
|
||
| At this stage, setting up alerts is optional for creating a new detector. Alerts can be configured at any time, including from the Findings window. This section describes the process for defining the alert conditions during creation of a detector. To see how to initiate creation of alerts from the Findings window, see [The findings list]({{site.url}}{{site.baseurl}}/security-analytics/usage/findings/#the-findings-list). | ||
| The third step in creating a detector involves setting up alerts. Alerts are configured to create triggers that, when matched with a set of detection rule criteria, send a notification of a possible security event. You can select the criteria (rules, rule severity, and tags) in any combination to define a trigger. Once a trigger is defined, the alert setup lets you choose the channel on which to be notified and provides options for customizing a message for the notification. |
There was a problem hiding this comment.
Echoing what Alice said but with a different suggestion:
| The third step in creating a detector involves setting up alerts. Alerts are configured to create triggers that, when matched with a set of detection rule criteria, send a notification of a possible security event. You can select the criteria (rules, rule severity, and tags) in any combination to define a trigger. Once a trigger is defined, the alert setup lets you choose the channel on which to be notified and provides options for customizing a message for the notification. | |
| The third step in creating a detector involves setting up alerts. Alerts are configured to create triggers that, when matched with a set of detection rule criteria, send a notification of a possible security event. Detection rule criteria includes the following: | |
| - Rules | |
| - Rule severity | |
| - Tags | |
| After defining the trigger, the alert setup lets you choose the channel on which to be notified and provides options for customizing a message for the notification. |
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: cwillum <cwmmoore@amazon.com>
…rch-project/documentation-website into fix#2400-updates-revisit
* fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * Update _security-analytics/sec-analytics-config/detectors-config.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _security-analytics/sec-analytics-config/detectors-config.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> --------- Signed-off-by: cwillum <cwmmoore@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> (cherry picked from commit 8b8d968)
…2546) * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * Update _security-analytics/sec-analytics-config/detectors-config.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _security-analytics/sec-analytics-config/detectors-config.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> --------- Signed-off-by: cwillum <cwmmoore@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> (cherry picked from commit 8b8d968) Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
* fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * Update _security-analytics/sec-analytics-config/detectors-config.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _security-analytics/sec-analytics-config/detectors-config.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#2400-updates-revisit Signed-off-by: cwillum <cwmmoore@amazon.com> --------- Signed-off-by: cwillum <cwmmoore@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: cwillum cwmmoore@amazon.com
Description
Some updates didn't make it into 2.5. These are follow up changes and some refinements.
Issues Resolved
Reordered some field mapping documentation to treat automatic mapping first and pending mapping second, changed language in the Alert setup section of detection creation, and other small refinements.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.