Add grouping settings for query field name and type (#135) (#138)

(cherry picked from commit f89eb88)

Signed-off-by: Siddhant Deshmukh <deshsid@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: opensearch-trigger-bot[bot]

src/main/java/org/opensearch/plugin/insights/QueryInsightsPlugin.java

@@ -142,6 +142,8 @@ public List<Setting<?>> getSettings() {
             QueryInsightsSettings.TOP_N_MEMORY_EXPORTER_SETTINGS,
             QueryInsightsSettings.TOP_N_QUERIES_GROUP_BY,
             QueryInsightsSettings.TOP_N_QUERIES_MAX_GROUPS_EXCLUDING_N,
+            QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_NAME,
+            QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_TYPE,
             QueryCategorizationSettings.SEARCH_QUERY_METRICS_ENABLED_SETTING
         );
     }

src/main/java/org/opensearch/plugin/insights/core/listener/QueryInsightsListener.java

@@ -9,6 +9,8 @@
 package org.opensearch.plugin.insights.core.listener;
 
 import static org.opensearch.plugin.insights.settings.QueryCategorizationSettings.SEARCH_QUERY_METRICS_ENABLED_SETTING;
+import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_NAME;
+import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_TYPE;
 import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.TOP_N_QUERIES_GROUP_BY;
 import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.TOP_N_QUERIES_MAX_GROUPS_EXCLUDING_N;
 import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.getTopNEnabledSetting;
@@ -54,6 +56,8 @@ public final class QueryInsightsListener extends SearchRequestOperationsListener
 
     private final QueryInsightsService queryInsightsService;
     private final ClusterService clusterService;
+    private boolean groupingFieldNameEnabled;
+    private boolean groupingFieldTypeEnabled;
 
     /**
      * Constructor for QueryInsightsListener
@@ -64,6 +68,8 @@ public final class QueryInsightsListener extends SearchRequestOperationsListener
     @Inject
     public QueryInsightsListener(final ClusterService clusterService, final QueryInsightsService queryInsightsService) {
         this(clusterService, queryInsightsService, false);
+        groupingFieldNameEnabled = false;
+        groupingFieldTypeEnabled = false;
     }
 
     /**
@@ -126,9 +132,16 @@ public QueryInsightsListener(
         this.queryInsightsService.validateMaximumGroups(clusterService.getClusterSettings().get(TOP_N_QUERIES_MAX_GROUPS_EXCLUDING_N));
         this.queryInsightsService.setMaximumGroups(clusterService.getClusterSettings().get(TOP_N_QUERIES_MAX_GROUPS_EXCLUDING_N));
 
+        // Internal settings for grouping attributes
+        clusterService.getClusterSettings().addSettingsUpdateConsumer(TOP_N_QUERIES_GROUPING_FIELD_NAME, this::setGroupingFieldNameEnabled);
+        setGroupingFieldNameEnabled(clusterService.getClusterSettings().get(TOP_N_QUERIES_GROUPING_FIELD_NAME));
+
+        clusterService.getClusterSettings().addSettingsUpdateConsumer(TOP_N_QUERIES_GROUPING_FIELD_TYPE, this::setGroupingFieldTypeEnabled);
+        setGroupingFieldTypeEnabled(clusterService.getClusterSettings().get(TOP_N_QUERIES_GROUPING_FIELD_TYPE));
+
         // Settings endpoints set for search query metrics
         clusterService.getClusterSettings()
-            .addSettingsUpdateConsumer(SEARCH_QUERY_METRICS_ENABLED_SETTING, v -> setSearchQueryMetricsEnabled(v));
+            .addSettingsUpdateConsumer(SEARCH_QUERY_METRICS_ENABLED_SETTING, this::setSearchQueryMetricsEnabled);
         setSearchQueryMetricsEnabled(clusterService.getClusterSettings().get(SEARCH_QUERY_METRICS_ENABLED_SETTING));
     }
 
@@ -154,6 +167,14 @@ public void setSearchQueryMetricsEnabled(boolean searchQueryMetricsEnabled) {
         updateQueryInsightsState();
     }
 
+    public void setGroupingFieldNameEnabled(Boolean fieldNameEnabled) {
+        this.groupingFieldNameEnabled = fieldNameEnabled;
+    }
+
+    public void setGroupingFieldTypeEnabled(Boolean fieldTypeEnabled) {
+        this.groupingFieldTypeEnabled = fieldTypeEnabled;
+    }
+
     /**
      * Update the query insights service state based on the enabled features.
      * If any feature is enabled, it starts the service. If no features are enabled, it stops the service.
@@ -241,16 +262,18 @@ private void constructSearchQueryRecord(final SearchPhaseContext context, final
                 );
             }
 
-            String hashcode = QueryShapeGenerator.getShapeHashCodeAsString(request.source(), false);
-
             Map<Attribute, Object> attributes = new HashMap<>();
             attributes.put(Attribute.SEARCH_TYPE, request.searchType().toString().toLowerCase(Locale.ROOT));
             attributes.put(Attribute.SOURCE, request.source());
             attributes.put(Attribute.TOTAL_SHARDS, context.getNumShards());
             attributes.put(Attribute.INDICES, request.indices());
             attributes.put(Attribute.PHASE_LATENCY_MAP, searchRequestContext.phaseTookMap());
             attributes.put(Attribute.TASK_RESOURCE_USAGES, tasksResourceUsages);
-            attributes.put(Attribute.QUERY_HASHCODE, hashcode);
+
+            if (queryInsightsService.isGroupingEnabled()) {
+                String hashcode = QueryShapeGenerator.getShapeHashCodeAsString(request.source(), groupingFieldNameEnabled);
+                attributes.put(Attribute.QUERY_HASHCODE, hashcode);
+            }
 
             Map<String, Object> labels = new HashMap<>();
             // Retrieve user provided label if exists

src/main/java/org/opensearch/plugin/insights/settings/QueryInsightsSettings.java

@@ -83,6 +83,8 @@ public class QueryInsightsSettings {
     public static final String TOP_QUERIES_BASE_URI = PLUGINS_BASE_URI + "/top_queries";
     /** Default prefix for top N queries feature */
     public static final String TOP_N_QUERIES_SETTING_PREFIX = "search.insights.top_queries";
+    /** Default prefix for top N queries grouping feature */
+    public static final String TOP_N_QUERIES_GROUPING_SETTING_PREFIX = "search.insights.top_queries.grouping";
     /** Default prefix for top N queries by latency feature */
     public static final String TOP_N_LATENCY_QUERIES_PREFIX = TOP_N_QUERIES_SETTING_PREFIX + ".latency";
     /** Default prefix for top N queries by cpu feature */
@@ -139,6 +141,20 @@ public class QueryInsightsSettings {
         Setting.Property.Dynamic
     );
 
+    public static final Setting<Boolean> TOP_N_QUERIES_GROUPING_FIELD_NAME = Setting.boolSetting(
+        TOP_N_QUERIES_GROUPING_SETTING_PREFIX + ".attributes.field_name",
+        false,
+        Setting.Property.Dynamic,
+        Setting.Property.NodeScope
+    );
+
+    public static final Setting<Boolean> TOP_N_QUERIES_GROUPING_FIELD_TYPE = Setting.boolSetting(
+        TOP_N_QUERIES_GROUPING_SETTING_PREFIX + ".attributes.field_type",
+        false,
+        Setting.Property.Dynamic,
+        Setting.Property.NodeScope
+    );
+
     /**
      * Boolean setting for enabling top queries by cpu.
      */

src/test/java/org/opensearch/plugin/insights/QueryInsightsPluginTests.java

@@ -79,6 +79,8 @@ public void testGetSettings() {
                 QueryInsightsSettings.TOP_N_MEMORY_EXPORTER_SETTINGS,
                 QueryInsightsSettings.TOP_N_QUERIES_GROUP_BY,
                 QueryInsightsSettings.TOP_N_QUERIES_MAX_GROUPS_EXCLUDING_N,
+                QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_NAME,
+                QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_TYPE,
                 QueryCategorizationSettings.SEARCH_QUERY_METRICS_ENABLED_SETTING
             ),
             queryInsightsPlugin.getSettings()

src/test/java/org/opensearch/plugin/insights/QueryInsightsTestUtils.java

@@ -335,6 +335,8 @@ public static void registerAllQueryInsightsSettings(ClusterSettings clusterSetti
         clusterSettings.registerSetting(QueryInsightsSettings.TOP_N_MEMORY_EXPORTER_SETTINGS);
         clusterSettings.registerSetting(QueryInsightsSettings.TOP_N_QUERIES_GROUP_BY);
         clusterSettings.registerSetting(QueryInsightsSettings.TOP_N_QUERIES_MAX_GROUPS_EXCLUDING_N);
+        clusterSettings.registerSetting(QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_NAME);
+        clusterSettings.registerSetting(QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_TYPE);
         clusterSettings.registerSetting(QueryCategorizationSettings.SEARCH_QUERY_METRICS_ENABLED_SETTING);
     }
 }