[BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior #843

goyamegh · 2024-02-08T22:08:32Z

Description

Fixes the following issues:

In case the detector search request returns empty hits, the exception should be gracefully handled and checked before.
Case when multiple detectors are present and we are fetching only one detector.

Issues Resolved

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Megha Goyal <goyamegh@amazon.com>

codecov · 2024-02-08T22:24:18Z

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (0bbdb31) 24.83% compared to head (6f852a3) 24.80%.
Report is 5 commits behind head on main.

Files	Patch %	Lines
...ics/transport/TransportCorrelateFindingAction.java	0.00%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #843      +/-   ##
============================================
- Coverage     24.83%   24.80%   -0.03%     
+ Complexity     1030     1027       -3     
============================================
  Files           277      277              
  Lines         12713    12714       +1     
  Branches       1401     1401              
============================================
- Hits           3157     3154       -3     
- Misses         9292     9295       +3     
- Partials        264      265       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

eirsep · 2024-02-09T23:07:00Z

src/main/java/org/opensearch/securityanalytics/transport/TransportCorrelateFindingAction.java

@@ -261,7 +261,8 @@ public void onResponse(SearchResponse response) {
                        }

                        SearchHits hits = response.getHits();
-                        if (hits.getTotalHits().value == 1) {
+                        // Detectors Index hits count could be more even if we fetch one


just curious why can hits be >1 ??

Keeping it >1 in case we remove filters and the number of hits are more than 1.

eirsep · 2024-02-09T23:12:27Z

src/main/java/org/opensearch/securityanalytics/transport/TransportCorrelateFindingAction.java

@@ -271,6 +272,9 @@ public void onResponse(SearchResponse response) {
                                );
                                Detector detector = Detector.docParse(xcp, hit.getId(), hit.getVersion());
                                joinEngine.onSearchDetectorResponse(detector, finding);
+                            } catch (ArrayIndexOutOfBoundsException e) {


why are we catching ArrayIndexOutOfBoundsException also if we are adding check on array size???
can we instead add an error log in the IOException catch>

Signed-off-by: Megha Goyal <goyamegh@amazon.com>

…behavior (#843) * Catch ArrayIndexOutOfBoundsException when detector is missing Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Add a check on SearchHits.getHits() length Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Remove index out of bounds exception Signed-off-by: Megha Goyal <goyamegh@amazon.com> --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 0ef8543)

…behavior (#843) (#858) * Catch ArrayIndexOutOfBoundsException when detector is missing Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Add a check on SearchHits.getHits() length Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Remove index out of bounds exception Signed-off-by: Megha Goyal <goyamegh@amazon.com> --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 0ef8543) Co-authored-by: Megha Goyal <56077967+goyamegh@users.noreply.github.com>

Signed-off-by: Joanne Wang <jowg@amazon.com> (cherry picked from commit 4d4f5e3) Co-authored-by: Joanne Wang <jowg@amazon.com> Reduce log level for informative message (opensearch-project#203) (opensearch-project#833) Signed-off-by: Enrico Tröger <enrico.troeger@uvena.de> Co-authored-by: Enrico Tröger <enrico.troeger@uvena.de> Updated alert creation following common-utils PR 584. (opensearch-project#837) (opensearch-project#839) Signed-off-by: AWSHurneyt <hurneyt@amazon.com> (cherry picked from commit 8adb9c3) Co-authored-by: AWSHurneyt <hurneyt@amazon.com> Release notes for 2.12.0 (opensearch-project#834) (opensearch-project#841) * release notes for 2.12 Signed-off-by: Joanne Wang <jowg@amazon.com> * update release notes Signed-off-by: Joanne Wang <jowg@amazon.com> * update release notes Signed-off-by: Joanne Wang <jowg@amazon.com> --------- Signed-off-by: Joanne Wang <jowg@amazon.com> (cherry picked from commit 414484a) Co-authored-by: Joanne Wang <jowg@amazon.com> Remove blocking calls and change threat intel feed flow to event driven (opensearch-project#871) (opensearch-project#876) * remove actionGet() and change threat intel feed flow to event driven Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> * fix javadocs Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> * revert try catch removals Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> * use action listener wrap() in detector threat intel code paths Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> * add try catch Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> --------- Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> (cherry picked from commit 172d58d) Co-authored-by: Surya Sashank Nistala <snistala@amazon.com> Fail the flow the when detectot type is missing in the log types index (opensearch-project#845) (opensearch-project#857) Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 8d19912) Co-authored-by: Megha Goyal <56077967+goyamegh@users.noreply.github.com> [BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior (opensearch-project#843) (opensearch-project#858) * Catch ArrayIndexOutOfBoundsException when detector is missing Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Add a check on SearchHits.getHits() length Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Remove index out of bounds exception Signed-off-by: Megha Goyal <goyamegh@amazon.com> --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 0ef8543) Co-authored-by: Megha Goyal <56077967+goyamegh@users.noreply.github.com> Backport opensearch-project#873 and opensearch-project#789 (opensearch-project#895) * support object fields in aggregation based sigma rules (opensearch-project#789) Signed-off-by: Subhobrata Dey <sbcd90@gmail.com> * Pass rule field names in doc level queries during monitor/creation. Remove blocking actionGet() calls (opensearch-project#873) * pass query field names in doc level queries during monitor creation/updation Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> * remove actionGet() and change get index mapping call to event driven flow Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> * fix chained findings monitor Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> * add finding mappings Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> * remove test messages from logs Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> * revert build.gradle change Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> --------- Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> --------- Signed-off-by: Subhobrata Dey <sbcd90@gmail.com> Signed-off-by: Surya Sashank Nistala <snistala@amazon.com> Co-authored-by: Subhobrata Dey <sbcd90@gmail.com> Fix duplicate ecs mappings which returns incorrect log index field in mapping view API (opensearch-project#786) (opensearch-project#788) (opensearch-project#898) * field mapping changes * add integ test * turn unmappedfieldaliases as set and add integ test * add comments * fix integ tests * moved logic to method for better readability --------- Signed-off-by: Joanne Wang <jowg@amazon.com> Add throw for empty strings in rules with modifier contains, startwith, and endswith (opensearch-project#860) (opensearch-project#896) * add validation for empty strings with contains, startswith and endswith modifiers * throw exception if empty string with contains, startswith, or endswith * change var name * add modifiers to log --------- Signed-off-by: Joanne Wang <jowg@amazon.com> Add an "exists" check for "not" condition in sigma rules (opensearch-project#852) (opensearch-project#897) * test design Signed-off-by: Joanne Wang <jowg@amazon.com> * working version Signed-off-by: Joanne Wang <jowg@amazon.com> * cleaning up Signed-off-by: Joanne Wang <jowg@amazon.com> * testing Signed-off-by: Joanne Wang <jowg@amazon.com> * working version Signed-off-by: Joanne Wang <jowg@amazon.com> * working version Signed-off-by: Joanne Wang <jowg@amazon.com> * refactored querybackend Signed-off-by: Joanne Wang <jowg@amazon.com> * working on tests Signed-off-by: Joanne Wang <jowg@amazon.com> * fixed alerting and finding tests Signed-off-by: Joanne Wang <jowg@amazon.com> * fix correlation tests Signed-off-by: Joanne Wang <jowg@amazon.com> * working all tests Signed-off-by: Joanne Wang <jowg@amazon.com> * moved test and changed alias for adldap Signed-off-by: Joanne Wang <jowg@amazon.com> * added more tests Signed-off-by: Joanne Wang <jowg@amazon.com> * cleanup code Signed-off-by: Joanne Wang <jowg@amazon.com> * remove exists flag Signed-off-by: Joanne Wang <jowg@amazon.com> --------- Signed-off-by: Joanne Wang <jowg@amazon.com> (cherry picked from commit 656a5fe) Co-authored-by: Joanne Wang <jowg@amazon.com> Add goyamegh as a maintainer (opensearch-project#868) (opensearch-project#899) Signed-off-by: Megha Goyal <goyamegh@amazon.com> Refactor invocation of Action listeners in correlations (opensearch-project#880) (opensearch-project#900) * Refactor invocation of Action listeners in correlations * Close hanging tasks in correlations workflow * Logging finding id and monitor id in error logs --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> Add search request timeouts for correlations workflows (opensearch-project#893) (opensearch-project#901) * Reinstating more leaks plugged-in for correlations workflows Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Add search timeouts to all correlation searches Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Fix logging and exception messages Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Change search timeout to 30 seconds Signed-off-by: Megha Goyal <goyamegh@amazon.com> --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 75c4429) Co-authored-by: Megha Goyal <56077967+goyamegh@users.noreply.github.com>

…behavior (#843) * Catch ArrayIndexOutOfBoundsException when detector is missing Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Add a check on SearchHits.getHits() length Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Remove index out of bounds exception Signed-off-by: Megha Goyal <goyamegh@amazon.com> --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 0ef8543)

…behavior (#843) (#907) * Catch ArrayIndexOutOfBoundsException when detector is missing Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Add a check on SearchHits.getHits() length Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Remove index out of bounds exception Signed-off-by: Megha Goyal <goyamegh@amazon.com> --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 0ef8543) Co-authored-by: Megha Goyal <56077967+goyamegh@users.noreply.github.com>

…behavior (#843) (#908) * Catch ArrayIndexOutOfBoundsException when detector is missing Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Add a check on SearchHits.getHits() length Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Remove index out of bounds exception Signed-off-by: Megha Goyal <goyamegh@amazon.com> --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 0ef8543) Co-authored-by: Megha Goyal <56077967+goyamegh@users.noreply.github.com>

…behavior (#843) (#906) * Catch ArrayIndexOutOfBoundsException when detector is missing Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Add a check on SearchHits.getHits() length Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Remove index out of bounds exception Signed-off-by: Megha Goyal <goyamegh@amazon.com> --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 0ef8543) Co-authored-by: Megha Goyal <56077967+goyamegh@users.noreply.github.com>

…behavior (#843) (#907) * Catch ArrayIndexOutOfBoundsException when detector is missing Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Add a check on SearchHits.getHits() length Signed-off-by: Megha Goyal <goyamegh@amazon.com> * Remove index out of bounds exception Signed-off-by: Megha Goyal <goyamegh@amazon.com> --------- Signed-off-by: Megha Goyal <goyamegh@amazon.com> (cherry picked from commit 0ef8543) Co-authored-by: Megha Goyal <56077967+goyamegh@users.noreply.github.com> (cherry picked from commit 35aa656)

goyamegh added 2 commits February 8, 2024 13:55

Catch ArrayIndexOutOfBoundsException when detector is missing

1e8a222

Signed-off-by: Megha Goyal <goyamegh@amazon.com>

Add a check on SearchHits.getHits() length

2a1b7e0

Signed-off-by: Megha Goyal <goyamegh@amazon.com>

goyamegh marked this pull request as ready for review February 9, 2024 00:42

goyamegh requested review from amsiglan, AWSHurneyt, getsaurabh02, lezzago, praveensameneni, sbcd90, eirsep and jowg-amazon as code owners February 9, 2024 00:42

eirsep reviewed Feb 9, 2024

View reviewed changes

eirsep requested changes Feb 9, 2024

View reviewed changes

Remove index out of bounds exception

6f852a3

Signed-off-by: Megha Goyal <goyamegh@amazon.com>

goyamegh requested a review from engechas as a code owner February 14, 2024 19:14

engechas approved these changes Feb 14, 2024

View reviewed changes

eirsep approved these changes Feb 14, 2024

View reviewed changes

engechas merged commit 0ef8543 into opensearch-project:main Feb 14, 2024
15 of 18 checks passed

eirsep added the backport 2.x label Feb 14, 2024

opensearch-trigger-bot bot mentioned this pull request Feb 14, 2024

[Backport 2.x] [BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior #858

Merged

goyamegh added backport 2.7 backport 2.9 backports to 2.9 backport 2.11 labels Mar 11, 2024

opensearch-trigger-bot bot mentioned this pull request Mar 11, 2024

[Backport 2.9] [BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior #906

Merged

This was referenced Mar 11, 2024

[Backport 2.11] [BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior #907

Merged

[Backport 2.7] [BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior #908

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior #843

[BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior #843

goyamegh commented Feb 8, 2024

codecov bot commented Feb 8, 2024 •

edited

Loading

eirsep Feb 9, 2024 •

edited

Loading

goyamegh Feb 14, 2024

eirsep Feb 9, 2024

goyamegh Feb 14, 2024

[BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior #843

[BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior #843

Conversation

goyamegh commented Feb 8, 2024

Description

Issues Resolved

Check List

codecov bot commented Feb 8, 2024 • edited Loading

Codecov Report

eirsep Feb 9, 2024 • edited Loading

Choose a reason for hiding this comment

goyamegh Feb 14, 2024

Choose a reason for hiding this comment

eirsep Feb 9, 2024

Choose a reason for hiding this comment

goyamegh Feb 14, 2024

Choose a reason for hiding this comment

codecov bot commented Feb 8, 2024 •

edited

Loading

eirsep Feb 9, 2024 •

edited

Loading