Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BUG] Update create detector API section in documentation to add the required create mapping call preceding detector creation #619

Open
amsiglan opened this issue Sep 28, 2023 · 2 comments
Open

[BUG] Update create detector API section in documentation to add the required create mapping call preceding detector creation #619

amsiglan opened this issue Sep 28, 2023 · 2 comments
Assignees
@VJoshi380
Labels
bug Something isn't working good first issue Good for newcomers v2.11.0
Projects
Security Analytics Roadmap

Comments

@amsiglan
Copy link
Collaborator

What is the bug?
When a detector is created using Opensearch Securtiy Analytics dashboards plugin, it makes two API calls:

  1. Create mappings call to make sure rule fields are mapped correctly with log index fields
  2. Create detector call to configure the detector.
    Detector execution then depends on the mappings created by the first call.

The create detector API section of the documentation does not highlight that the user needs to make sure the mappings exist and that they need to create the mappings if needed.

What is the expected behavior?
Update the documentation to ensure we highlight the need for mappings to exist before calling the create detector API.

What is your host/environment?
N/A

Do you have any screenshots?
N/A

Do you have any additional context?
n/a
@amsiglan amsiglan added bug Something isn't working untriaged v2.11.0 labels Sep 28, 2023
@amsiglan amsiglan changed the title [BUG] Update create detector API section to add the required create mapping call preceding detector creation [BUG] Update create detector API section in documentation to add the required create mapping call preceding detector creation Oct 2, 2023
@sbcd90 sbcd90 added the good first issue Good for newcomers label Oct 6, 2023
@VJoshi380
Copy link

I am interested on working on this issue.

@sbcd90
Copy link
Collaborator

sbcd90 commented Oct 11, 2023

hi @VJoshi380 , sure. assigned issue to you.

riysaxen-amzn pushed a commit to riysaxen-amzn/security-analytics that referenced this issue Feb 20, 2024
@amsiglan
UX updates for correlations (opensearch-project#619)
205ee18 
* minor UX updates

Signed-off-by: Amardeepsingh Siglani <amardeep7194@gmail.com>

* ux improvements for correlations

Signed-off-by: Amardeepsingh Siglani <amardeep7194@gmail.com>

* made more refactors for ux polish

Signed-off-by: Amardeepsingh Siglani <amardeep7194@gmail.com>

* updated snapshots

Signed-off-by: Amardeepsingh Siglani <amardeep7194@gmail.com>

* addressed comments in PR

Signed-off-by: Amardeepsingh Siglani <amardeep7194@gmail.com>

---------

Signed-off-by: Amardeepsingh Siglani <amardeep7194@gmail.com>
riysaxen-amzn pushed a commit to riysaxen-amzn/security-analytics that referenced this issue Mar 25, 2024
@opensearch-trigger-bot @eirsep
change transport ack alerts action to accept Action Request and recre…
7e36861 
…ate as AckAlertRequest (opensearch-project#618) (opensearch-project#619)

Signed-off-by: Surya Sashank Nistala <snistala@amazon.com>

Signed-off-by: Surya Sashank Nistala <snistala@amazon.com>
(cherry picked from commit 2005185fcbbd36e41dc8344ab5a8c717c3043a1a)

Co-authored-by: Surya Sashank Nistala <snistala@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@VJoshi380 VJoshi380

Labels
bug Something isn't working good first issue Good for newcomers v2.11.0
Projects
Security Analytics Roadmap
Bugs
Milestone
No milestone
Development

No branches or pull requests
4 participants
@sbcd90 @VJoshi380 @riysaxen-amzn @amsiglan