Skip to content

Security Analytics—additional updates following 2.5 release#2515

Merged
cwillum merged 11 commits intomainfrom
fix#2400-updates-revisit
Feb 1, 2023
Merged

Security Analytics—additional updates following 2.5 release#2515
cwillum merged 11 commits intomainfrom
fix#2400-updates-revisit

Conversation

@cwillum
Copy link
Contributor

@cwillum cwillum commented Jan 28, 2023

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

  • 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: cwillum <cwmmoore@amazon.com>
@cwillum cwillum added xx-documentation In progress Issue/PR: The issue or PR is in progress. v2.5.0 'Issues and PRs related to version v2.5.0' backport 2.5 PR: Backport label for 2.5 labels Jan 28, 2023
@cwillum cwillum requested a review from a team as a code owner January 28, 2023 00:40
@cwillum cwillum self-assigned this Jan 28, 2023
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>
@cwillum cwillum added Doc review PR: Doc review in progress and removed In progress Issue/PR: The issue or PR is in progress. labels Jan 30, 2023
Signed-off-by: cwillum <cwmmoore@amazon.com>
Copy link
Contributor

@alicejw1 alicejw1 left a comment

Choose a reason for hiding this comment

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

Nice work!

## 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Echoing what Alice said but with a different suggestion:

Suggested change
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

@cwillum cwillum left a comment

Choose a reason for hiding this comment

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

Thanks Alice.

## 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.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

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

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Echoing what Alice said but with a different suggestion:

Suggested change
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.

cwillum and others added 5 commits January 31, 2023 16:37
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>
@cwillum cwillum removed the Doc review PR: Doc review in progress label Feb 1, 2023
@cwillum cwillum merged commit 8b8d968 into main Feb 1, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Feb 1, 2023
* 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)
cwillum added a commit that referenced this pull request Feb 1, 2023
…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>
Naarcha-AWS added a commit that referenced this pull request Feb 2, 2023
* 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>
@hdhalter hdhalter deleted the fix#2400-updates-revisit branch March 28, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.5 PR: Backport label for 2.5 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.

3 participants