Skip to content

Refactor GetAlerts API to not throw 404 error when detector is not found #1534

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refactor GetAlerts API to not throw 404 error when detector is not found #1534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/main/java/org/opensearch/securityanalytics/action/GetAlertsRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.commons.alerting.model.Table;
import org.opensearch.securityanalytics.model.Detector;


import static org.opensearch.action.ValidateActions.addValidationError;
Expand Down
5 changes: 0 additions & 5 deletions src/main/java/org/opensearch/securityanalytics/action/GetAlertsResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,13 @@
package org.opensearch.securityanalytics.action;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.opensearch.core.action.ActionResponse;
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.commons.alerting.model.Alert;
import org.opensearch.commons.alerting.model.FindingWithDocs;
import org.opensearch.core.xcontent.ToXContentObject;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.core.rest.RestStatus;
import org.opensearch.securityanalytics.model.Detector;

public class GetAlertsResponse extends ActionResponse implements ToXContentObject {

Expand Down
7 changes: 6 additions & 1 deletion src/main/java/org/opensearch/securityanalytics/alerts/AlertsService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,12 @@ public void onFailure(Exception e) {

@Override
public void onFailure(Exception e) {
listener.onFailure(e);
if(e.getMessage().matches("(.*)Detector(.*) not found(.*)")) {
listener.onResponse(new GetAlertsResponse(List.of(), 0));
}
else{
listener.onFailure(e);
}
}
});
}
Expand Down
52 changes: 23 additions & 29 deletions src/main/java/org/opensearch/securityanalytics/transport/TransportGetAlertsAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
import org.opensearch.securityanalytics.model.Detector;
import org.opensearch.securityanalytics.settings.SecurityAnalyticsSettings;
import org.opensearch.securityanalytics.util.DetectorUtils;
import org.opensearch.securityanalytics.util.SecurityAnalyticsException;
import org.opensearch.tasks.Task;
import org.opensearch.threadpool.ThreadPool;
import org.opensearch.transport.TransportService;
Expand Down Expand Up @@ -86,27 +85,27 @@ protected void doExecute(Task task, GetAlertsRequest request, ActionListener<Get

if (request.getLogType() == null) {
alertsService.getAlertsByDetectorId(
request.getDetectorId(),
request.getTable(),
request.getSeverityLevel(),
request.getAlertState(),
request.getStartTime(),
request.getEndTime(),
actionListener
request.getDetectorId(),
request.getTable(),
request.getSeverityLevel(),
request.getAlertState(),
request.getStartTime(),
request.getEndTime(),
actionListener
);
} else {
// "detector" is nested type so we have to use nested query
NestedQueryBuilder queryBuilder =
QueryBuilders.nestedQuery(
"detector",
QueryBuilders.boolQuery().must(
QueryBuilders.matchQuery(
DETECTOR_TYPE_PATH,
request.getLogType()
)
),
ScoreMode.None
);
QueryBuilders.nestedQuery(
"detector",
QueryBuilders.boolQuery().must(
QueryBuilders.matchQuery(
DETECTOR_TYPE_PATH,
request.getLogType()
)
),
ScoreMode.None
);
SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder();
searchSourceBuilder.query(queryBuilder);
searchSourceBuilder.fetchSource(true);
Expand All @@ -120,17 +119,11 @@ protected void doExecute(Task task, GetAlertsRequest request, ActionListener<Get
public void onResponse(SearchResponse searchResponse) {
try {
List<Detector> detectors = DetectorUtils.getDetectors(searchResponse, xContentRegistry);
if (detectors.size() == 0) {
actionListener.onFailure(
SecurityAnalyticsException.wrap(
new OpenSearchStatusException(
"No detectors found for provided type", RestStatus.NOT_FOUND
)
)
);
return;
if(detectors.size() == 0){
actionListener.onResponse(new GetAlertsResponse(List.of(), 0));
}
alertsService.getAlerts(
else{
alertsService.getAlerts(
detectors,
request.getLogType(),
request.getTable(),
Expand All @@ -139,7 +132,8 @@ public void onResponse(SearchResponse searchResponse) {
request.getStartTime(),
request.getEndTime(),
actionListener
);
);
}
} catch (IOException e) {
actionListener.onFailure(e);
}
Expand Down
57 changes: 50 additions & 7 deletions src/test/java/org/opensearch/securityanalytics/alerts/AlertsIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,15 +292,58 @@ public void testGetAlertsByStartTimeAndEndTimeSuccess() throws IOException, Inte
Assert.assertTrue(success.get());
}

public void testGetAlerts_noDetector_failure() throws IOException {
// Call GetAlerts API
public void testGetAlertsByDetectorIdWithEmptyResult() throws IOException {
String index = createTestIndex(randomIndex(), windowsIndexMapping());

Request createMappingRequest = new Request("POST", SecurityAnalyticsPlugin.MAPPER_BASE_URI);
createMappingRequest.setJsonEntity(
"{ \"index_name\":\"" + index + "\"," +
" \"rule_topic\":\"" + randomDetectorType() + "\", " +
" \"partial\":true" +
"}"
);

Response mappingResponse = client().performRequest(createMappingRequest);
assertEquals(HttpStatus.SC_OK, mappingResponse.getStatusLine().getStatusCode());

Detector detector = randomDetectorWithTriggers(getRandomPrePackagedRules(), List.of(new DetectorTrigger(null, "test-trigger", "1", List.of(randomDetectorType()), List.of(), List.of(), List.of(), List.of(), List.of())));

Response createResponse = makeRequest(client(), "POST", SecurityAnalyticsPlugin.DETECTOR_BASE_URI, Collections.emptyMap(), toHttpEntity(detector));
assertEquals("Create detector failed", RestStatus.CREATED, restStatus(createResponse));

Map<String, String> params = new HashMap<>();
params.put("detector_id", "nonexistent_detector_id");
try {
makeRequest(client(), "GET", SecurityAnalyticsPlugin.ALERTS_BASE_URI, params, null);
} catch (ResponseException e) {
assertEquals(HttpStatus.SC_NOT_FOUND, e.getResponse().getStatusLine().getStatusCode());
}
Response response = makeRequest(client(), "GET", SecurityAnalyticsPlugin.ALERTS_BASE_URI, params, null);
Map<String, Object> responseBody = asMap(response);
assertEquals(0, Integer.parseInt(responseBody.get("total_alerts").toString()));
assertEquals(0, ((ArrayList<HashMap<String, Object>>) responseBody.get("alerts")).size());
}

public void testGetAlertsByDetectorTypeWithEmptyResult() throws IOException {
String index = createTestIndex(randomIndex(), windowsIndexMapping());

Request createMappingRequest = new Request("POST", SecurityAnalyticsPlugin.MAPPER_BASE_URI);
createMappingRequest.setJsonEntity(
"{ \"index_name\":\"" + index + "\"," +
" \"rule_topic\":\"" + randomDetectorType() + "\", " +
" \"partial\":true" +
"}"
);

Response mappingResponse = client().performRequest(createMappingRequest);
assertEquals(HttpStatus.SC_OK, mappingResponse.getStatusLine().getStatusCode());

Detector detector = randomDetectorWithTriggers(getRandomPrePackagedRules(), List.of(new DetectorTrigger(null, "test-trigger", "1", List.of(randomDetectorType()), List.of(), List.of(), List.of(), List.of(), List.of())));

Response createResponse = makeRequest(client(), "POST", SecurityAnalyticsPlugin.DETECTOR_BASE_URI, Collections.emptyMap(), toHttpEntity(detector));
assertEquals("Create detector failed", RestStatus.CREATED, restStatus(createResponse));

Map<String, String> params = new HashMap<>();
params.put("detectorType", "nonexistent_detector_type");
Response response = makeRequest(client(), "GET", SecurityAnalyticsPlugin.ALERTS_BASE_URI, params, null);
Map<String, Object> responseBody = asMap(response);
assertEquals(0, Integer.parseInt(responseBody.get("total_alerts").toString()));
assertEquals(0, ((ArrayList<HashMap<String, Object>>) responseBody.get("alerts")).size());
}

@SuppressWarnings("unchecked")
Expand Down