Add indices to search request slowlog

Signed-off-by: David Zane <davizane@amazon.com>

Author: dzane17

CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Support expected cluster name with validation in CCS Sniff mode ([#20532](https://github.com/opensearch-project/OpenSearch/pull/20532))
 - Add security policy to allow `accessUnixDomainSocket` in `transport-grpc` module ([#20463](https://github.com/opensearch-project/OpenSearch/pull/20463))
 - [Workload Management] Enhance Scroll API support for autotagging ([#20151](https://github.com/opensearch-project/OpenSearch/pull/20151))
+- Add indices to search request slowlog ([#20588](https://github.com/opensearch-project/OpenSearch/pull/20588))
 
 ### Changed
 - Move Randomness from server to libs/common ([#20570](https://github.com/opensearch-project/OpenSearch/pull/20570))

server/src/main/java/org/opensearch/action/search/SearchRequestSlowLog.java

@@ -47,6 +47,7 @@
 
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
@@ -187,6 +188,7 @@ private static Map<String, Object> prepareMap(
             }
             messageFields.put("search_type", context.getRequest().searchType());
             messageFields.put("shards", searchRequestContext.formattedShardStats());
+            messageFields.put("indices", Arrays.toString(context.getRequest().indices()));
 
             if (context.getRequest().source() != null) {
                 String source = escapeJson(context.getRequest().source().toString(FORMAT_PARAMS));
@@ -213,6 +215,7 @@ private static String message(SearchPhaseContext context, long tookInNanos, Sear
             }
             sb.append("search_type[").append(context.getRequest().searchType()).append("], ");
             sb.append("shards[").append(searchRequestContext.formattedShardStats()).append("], ");
+            sb.append("indices").append(Arrays.toString(context.getRequest().indices())).append(", ");
             if (context.getRequest().source() != null) {
                 sb.append("source[").append(context.getRequest().source().toString(FORMAT_PARAMS)).append("], ");
             } else {

server/src/test/java/org/opensearch/action/search/SearchRequestSlowLogTests.java

@@ -50,7 +50,6 @@
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
 
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.CountDownLatch;
@@ -90,29 +89,29 @@ public static void cleanup() {
     public void testMultipleSlowLoggersUseSingleLog4jLogger() {
         LoggerContext context = (LoggerContext) LogManager.getContext(false);
 
-        SearchPhaseContext searchPhaseContext1 = new MockSearchPhaseContext(1);
+        new MockSearchPhaseContext(1);
         ClusterService clusterService1 = ClusterServiceUtils.createClusterService(
             Settings.EMPTY,
             new ClusterSettings(Settings.EMPTY, ClusterSettings.BUILT_IN_CLUSTER_SETTINGS),
             null
         );
-        SearchRequestSlowLog searchRequestSlowLog1 = new SearchRequestSlowLog(clusterService1);
+        new SearchRequestSlowLog(clusterService1);
         int numberOfLoggersBefore = context.getLoggers().size();
 
-        SearchPhaseContext searchPhaseContext2 = new MockSearchPhaseContext(1);
+        new MockSearchPhaseContext(1);
         ClusterService clusterService2 = ClusterServiceUtils.createClusterService(
             Settings.EMPTY,
             new ClusterSettings(Settings.EMPTY, ClusterSettings.BUILT_IN_CLUSTER_SETTINGS),
             null
         );
-        SearchRequestOperationsCompositeListenerFactory searchRequestListeners = new SearchRequestOperationsCompositeListenerFactory();
-        SearchRequestSlowLog searchRequestSlowLog2 = new SearchRequestSlowLog(clusterService2);
+        new SearchRequestOperationsCompositeListenerFactory();
+        new SearchRequestSlowLog(clusterService2);
 
         int numberOfLoggersAfter = context.getLoggers().size();
         assertThat(numberOfLoggersAfter, equalTo(numberOfLoggersBefore));
     }
 
-    public void testOnRequestEnd() throws InterruptedException {
+    public void testOnRequestEnd() {
         final Logger logger = mock(Logger.class);
         final SearchRequestContext searchRequestContext = mock(SearchRequestContext.class);
         final SearchPhaseContext searchPhaseContext = mock(SearchPhaseContext.class);
@@ -204,7 +203,7 @@ public void testConcurrentOnRequestEnd() throws InterruptedException {
         verify(logger, never()).trace(any(SearchRequestSlowLog.SearchRequestSlowLogMessage.class));
     }
 
-    public void testSearchRequestSlowLogHasJsonFields_EmptySearchRequestContext() throws IOException {
+    public void testSearchRequestSlowLogHasJsonFields_EmptySearchRequestContext() {
         SearchSourceBuilder source = SearchSourceBuilder.searchSource().query(QueryBuilders.matchAllQuery());
         SearchRequest searchRequest = new SearchRequest().source(source);
         SearchPhaseContext searchPhaseContext = new MockSearchPhaseContext(1, searchRequest);
@@ -225,11 +224,12 @@ public void testSearchRequestSlowLogHasJsonFields_EmptySearchRequestContext() th
         assertThat(p.getValueFor("total_hits"), equalTo("-1"));
         assertThat(p.getValueFor("search_type"), equalTo("QUERY_THEN_FETCH"));
         assertThat(p.getValueFor("shards"), equalTo(""));
+        assertThat(p.getValueFor("indices"), equalTo("[]"));
         assertThat(p.getValueFor("source"), equalTo("{\\\"query\\\":{\\\"match_all\\\":{\\\"boost\\\":1.0}}}"));
         assertThat(p.getValueFor("id"), equalTo(null));
     }
 
-    public void testSearchRequestSlowLogHasJsonFields_NotEmptySearchRequestContext() throws IOException {
+    public void testSearchRequestSlowLogHasJsonFields_NotEmptySearchRequestContext() {
         SearchSourceBuilder source = SearchSourceBuilder.searchSource().query(QueryBuilders.matchAllQuery());
         SearchRequest searchRequest = new SearchRequest().source(source);
         SearchPhaseContext searchPhaseContext = new MockSearchPhaseContext(1, searchRequest);
@@ -255,11 +255,12 @@ public void testSearchRequestSlowLogHasJsonFields_NotEmptySearchRequestContext()
         assertThat(p.getValueFor("total_hits"), equalTo("3 hits"));
         assertThat(p.getValueFor("search_type"), equalTo("QUERY_THEN_FETCH"));
         assertThat(p.getValueFor("shards"), equalTo("{total:10, successful:8, skipped:1, failed:1}"));
+        assertThat(p.getValueFor("indices"), equalTo("[]"));
         assertThat(p.getValueFor("source"), equalTo("{\\\"query\\\":{\\\"match_all\\\":{\\\"boost\\\":1.0}}}"));
         assertThat(p.getValueFor("id"), equalTo(null));
     }
 
-    public void testSearchRequestSlowLogHasJsonFields_PartialContext() throws IOException {
+    public void testSearchRequestSlowLogHasJsonFields_PartialContext() {
         SearchSourceBuilder source = SearchSourceBuilder.searchSource().query(QueryBuilders.matchAllQuery());
         SearchRequest searchRequest = new SearchRequest().source(source);
         SearchPhaseContext searchPhaseContext = new MockSearchPhaseContext(1, searchRequest);
@@ -285,13 +286,14 @@ public void testSearchRequestSlowLogHasJsonFields_PartialContext() throws IOExce
         assertThat(p.getValueFor("total_hits"), equalTo("3 hits"));
         assertThat(p.getValueFor("search_type"), equalTo("QUERY_THEN_FETCH"));
         assertThat(p.getValueFor("shards"), equalTo("{total:5, successful:3, skipped:1, failed:1}"));
+        assertThat(p.getValueFor("indices"), equalTo("[]"));
         assertThat(p.getValueFor("source"), equalTo("{\\\"query\\\":{\\\"match_all\\\":{\\\"boost\\\":1.0}}}"));
         assertThat(p.getValueFor("id"), equalTo(null));
     }
 
-    public void testSearchRequestSlowLogSearchContextPrinterToLog() throws IOException {
+    public void testSearchRequestSlowLogSearchContextPrinterToLog() {
         SearchSourceBuilder source = SearchSourceBuilder.searchSource().query(QueryBuilders.matchAllQuery());
-        SearchRequest searchRequest = new SearchRequest().source(source);
+        SearchRequest searchRequest = new SearchRequest(new String[] { "index1", "index2" }, source);
         SearchPhaseContext searchPhaseContext = new MockSearchPhaseContext(1, searchRequest);
         SearchRequestContext searchRequestContext = new SearchRequestContext(
             new SearchRequestOperationsListener.CompositeListener(List.of(), LogManager.getLogger()),
@@ -315,6 +317,7 @@ public void testSearchRequestSlowLogSearchContextPrinterToLog() throws IOExcepti
         assertThat(p.getFormattedMessage(), containsString("total_hits[3 hits]"));
         assertThat(p.getFormattedMessage(), containsString("search_type[QUERY_THEN_FETCH]"));
         assertThat(p.getFormattedMessage(), containsString("shards[{total:10, successful:8, skipped:1, failed:1}]"));
+        assertThat(p.getFormattedMessage(), containsString("indices[index1, index2]"));
         assertThat(p.getFormattedMessage(), containsString("source[{\"query\":{\"match_all\":{\"boost\":1.0}}}]"));
         // Makes sure that output doesn't contain any new lines
         assertThat(p.getFormattedMessage(), not(containsString("\n")));