Skip to content

Add alias support to Security Analytics#6284

Merged
Naarcha-AWS merged 9 commits intomainfrom
SA-data-streams
Feb 8, 2024
Merged

Add alias support to Security Analytics#6284
Naarcha-AWS merged 9 commits intomainfrom
SA-data-streams

Conversation

@Naarcha-AWS
Copy link
Copy Markdown
Contributor

Closes #6141

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: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
@hdhalter hdhalter changed the title Add alias support to SA Add alias support to Security Analytics Feb 1, 2024
1. In the **Data source** section, select one or more sources for the log data. Use an asterisk (*) to indicate a wildcard pattern. When selecting multiple data sources, their logs must be of the same type. We recommend creating separate detectors for different log types.
1. In the **Data source** section, select one or more sources for the log data. Use an asterisk (*) to indicate a wildcard pattern. When selecting multiple data sources, their logs must be of the same type. We recommend creating separate detectors for different log types.

Data sources support the use of [aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/). However, if you're configuring an alias as data source, it must be attached to a **Write** index alias, since Security Analytics only supports [data stream]({{site.url}}{{site.baseurl}}/im-plugin/data-streams/) for time-series generated data. Furthermore, when using an alias, ensure that your documents are ingesting through the alias and **not** the index(es) the alias was created for.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This part since Security Analytics only supports [data stream] might be a little misleading? We support both aliases and data streams independently. A data stream by definition will have a write index. However, aliases in opensearch are also allowed to point to read only indices which is why we want to ensure that if a detector is configured on an alias, then it needs point to at least one write index.

@hdhalter hdhalter added the release-notes PR: Include this PR in the automated release notes label Feb 6, 2024
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Feb 6, 2024
Copy link
Copy Markdown
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

Doc review complete. Please see the edits.

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added 5 - Final Editorial Review and removed Doc review PR: Doc review in progress labels Feb 6, 2024
Copy link
Copy Markdown
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@Naarcha-AWS Please tag me when complete so I can approve the revision to line 26. Thanks!

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@Naarcha-AWS Naarcha-AWS added Done but waiting to merge PR: The work is done and ready to merge and removed 5 - Final Editorial Review labels Feb 8, 2024
@Naarcha-AWS Naarcha-AWS merged commit 95de0af into main Feb 8, 2024
@Naarcha-AWS Naarcha-AWS deleted the SA-data-streams branch February 8, 2024 20:16
@hdhalter hdhalter added 3 - Done and removed Done but waiting to merge PR: The work is done and ready to merge labels Feb 9, 2024
oeyh pushed a commit to oeyh/documentation-website that referenced this pull request Mar 14, 2024
* Add alias support to SA.

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Fix links

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Update detectors-config.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-notes PR: Include this PR in the automated release notes v2.12.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Update security analytics detector creation to include data streams and aliases

5 participants