Remove blocking calls and change threat intel feed flow to event driven by eirsep · Pull Request #871 · opensearch-project/security-analytics

eirsep · 2024-02-27T21:06:25Z

Description

Remove blocking calls and change threat intel feed flow to event driven

Issues Resolved

#870

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

codecov · 2024-02-27T21:33:21Z

Codecov Report

Attention: Patch coverage is 1.19760% with 165 lines in your changes are missing coverage. Please review.

Project coverage is 24.81%. Comparing base (8ef0a3f) to head (3bfb29d).

Files	Patch %	Lines
...alytics/threatIntel/jobscheduler/TIFJobRunner.java	0.00%	45 Missing ⚠️
...lytics/threatIntel/ThreatIntelFeedDataService.java	0.00%	41 Missing ⚠️
...s/threatIntel/action/TransportPutTIFJobAction.java	0.00%	41 Missing ⚠️
...reatIntel/jobscheduler/TIFJobParameterService.java	0.00%	26 Missing ⚠️
...lytics/threatIntel/DetectorThreatIntelService.java	0.00%	10 Missing ⚠️
...tyanalytics/threatIntel/common/TIFLockService.java	66.66%	1 Missing ⚠️
...lytics/transport/TransportIndexDetectorAction.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #871      +/-   ##
============================================
- Coverage     24.82%   24.81%   -0.02%     
+ Complexity     1030     1029       -1     
============================================
  Files           277      277              
  Lines         12717    12702      -15     
  Branches       1401     1394       -7     
============================================
- Hits           3157     3152       -5     
+ Misses         9296     9286      -10     
  Partials        264      264

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

engechas

General comment on removal of the try/catches. Rest LGTM

engechas · 2024-02-28T21:58:12Z

src/main/java/org/opensearch/securityanalytics/threatIntel/ThreatIntelFeedDataService.java

    public void getThreatIntelFeedData(
            ActionListener<List<ThreatIntelFeedData>> listener
    ) {
-        try {


Do we no longer need this top-level try/catch? My observation has been that calls will hang it exceptions are not handled via the ActionListener

listener framework is event driven and no catch is required as ActionListener.onFailure() would need to implement whatever logic was written in catch block as callback mechanism will not throw an exception

If this code throws an exception, we never make a call to ActionListener.onFailure(). I believe the original call just hangs in this case, at least that is what I have experienced while developing in this package.

Let me know if I am missing something

true.
reverting try-catch removal

engechas · 2024-02-28T21:59:00Z

src/main/java/org/opensearch/securityanalytics/threatIntel/DetectorThreatIntelService.java

                return;
            }
-
-            CountDownLatch latch = new CountDownLatch(1);


Do we know why the latches were initially implemented? Seems fine to remove them based on the testing performed but I'm puzzled as to why they would have been added in the first place if they are not required

bad practice. The right construct to use is a Countdown

Countdown is a simple thread safe count-down class that in contrast to a CountDownLatch never blocks. This class is useful if a certain action has to wait for N concurrent tasks to return or a timeout to occur in order to proceed.

but safer to do it the event-driven way

engechas · 2024-02-28T21:59:13Z

src/main/java/org/opensearch/securityanalytics/threatIntel/DetectorThreatIntelService.java

     * Fetches threat intel data and creates doc level queries from threat intel data
     */
    public void createDocLevelQueryFromThreatIntel(List<LogType.IocFields> iocFieldList, Detector detector, ActionListener<List<DocLevelQuery>> listener) {
-        try {


Similar try/catch comment as below

listener framework is event driven and no catch is required as ActionListener.onFailure() would need to implement whatever logic was written in catch block as callback mechanism will not throw an exception

jowg-amazon · 2024-02-29T23:36:10Z

...n/java/org/opensearch/securityanalytics/threatIntel/jobscheduler/TIFJobParameterService.java

        jobSchedulerParameter.setLastUpdateTime(Instant.now());
        StashedThreadContext.run(client, () -> {
            try {
-                if (listener != null) {


Will this listener never be null?

changed it to non-null in all invocations

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

engechas · 2024-03-01T19:35:46Z

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

    }

    private void addThreatIntelBasedDocLevelQueries(Detector detector, ActionListener<List<DocLevelQuery>> listener) {
-        try {


Try/catch still removed here

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

…en (#871) * 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)

…en (#871) (#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>

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>

remove actionGet() and change threat intel feed flow to event driven

58f9727

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

eirsep requested review from AWSHurneyt, amsiglan, engechas, getsaurabh02, goyamegh, jowg-amazon, lezzago, praveensameneni, riysaxen-amzn and sbcd90 as code owners February 27, 2024 21:06

fix javadocs

5dce731

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

engechas reviewed Feb 28, 2024

View reviewed changes

jowg-amazon reviewed Mar 1, 2024

View reviewed changes

revert try catch removals

b20270c

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

engechas reviewed Mar 1, 2024

View reviewed changes

eirsep added 2 commits March 1, 2024 16:47

use action listener wrap() in detector threat intel code paths

f222f41

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

add try catch

3bfb29d

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

engechas approved these changes Mar 2, 2024

View reviewed changes

jowg-amazon approved these changes Mar 2, 2024

View reviewed changes

eirsep merged commit 172d58d into opensearch-project:main Mar 2, 2024

eirsep added the backport 2.x label Mar 2, 2024

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

[Backport 2.x] Remove blocking calls and change threat intel feed flow to event driven #876

Merged

This was referenced Mar 19, 2024

[BUG]Fork index detector action from transport thread to avoid blocking it #856

Closed

[BUG] Creating a detector hangs. The detector is then silently created many hours later #825

Closed

Conversation

eirsep commented Feb 27, 2024

Description

Issues Resolved

Uh oh!

codecov bot commented Feb 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

engechas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eirsep Feb 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Feb 27, 2024 •

edited

Loading

eirsep Feb 29, 2024 •

edited

Loading