[Manual backport 2.x] Add default index template for query insights local index (#255) (#276)

* Add default index template for query insights local index



* Add auto_expand to index template settings



---------


(cherry picked from commit 4b24828)

Signed-off-by: Chenyang Ji <[email protected]>
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]

Diff for: src/main/java/org/opensearch/plugin/insights/QueryInsightsPlugin.java

@@ -148,6 +148,7 @@ public List<Setting<?>> getSettings() {
             QueryCategorizationSettings.SEARCH_QUERY_METRICS_ENABLED_SETTING,
             QueryInsightsSettings.TOP_N_EXPORTER_DELETE_AFTER,
             QueryInsightsSettings.TOP_N_EXPORTER_TYPE,
+            QueryInsightsSettings.TOP_N_EXPORTER_TEMPLATE_PRIORITY,
             QueryCategorizationSettings.SEARCH_QUERY_FIELD_TYPE_CACHE_SIZE_KEY
         );
     }

Diff for: src/main/java/org/opensearch/plugin/insights/core/exporter/LocalIndexExporter.java

@@ -8,6 +8,8 @@
 
 package org.opensearch.plugin.insights.core.exporter;
 
+import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.DEFAULT_TEMPLATE_PRIORITY;
+
 import java.io.IOException;
 import java.time.format.DateTimeFormatter;
 import java.util.HashMap;
@@ -74,20 +76,34 @@ public void validateExporterType(final String exporterType) throws IllegalArgume
      * @param id id of the exporter so that exporters can be retrieved and reused across services
      * @param indexPattern the index pattern if creating an index exporter
      * @param indexMapping index mapping file
+     * @param templatePriority the priority value for the template
      * @return LocalIndexExporter the created exporter sink
      */
-    public LocalIndexExporter createLocalIndexExporter(String id, String indexPattern, String indexMapping) {
+    public LocalIndexExporter createLocalIndexExporter(String id, String indexPattern, String indexMapping, long templatePriority) {
         LocalIndexExporter exporter = new LocalIndexExporter(
             client,
             clusterService,
             DateTimeFormatter.ofPattern(indexPattern, Locale.ROOT),
             indexMapping,
             id
         );
+        exporter.setTemplatePriority(templatePriority);
         this.exporters.put(id, exporter);
         return exporter;
     }
 
+    /**
+     * Create a local index exporter based on provided parameters, using default template priority
+     *
+     * @param id id of the exporter so that exporters can be retrieved and reused across services
+     * @param indexPattern the index pattern if creating an index exporter
+     * @param indexMapping index mapping file
+     * @return LocalIndexExporter the created exporter sink
+     */
+    public LocalIndexExporter createLocalIndexExporter(String id, String indexPattern, String indexMapping) {
+        return createLocalIndexExporter(id, indexPattern, indexMapping, DEFAULT_TEMPLATE_PRIORITY);
+    }
+
     /**
      * Create a debug exporter based on provided parameters
      *
@@ -105,11 +121,14 @@ public DebugExporter createDebugExporter(String id) {
      *
      * @param exporter The exporter to update
      * @param indexPattern the index pattern if creating a index exporter
+     * @param templatePriority the priority value for the template (for LocalIndexExporter)
      * @return QueryInsightsExporter the updated exporter sink
      */
-    public QueryInsightsExporter updateExporter(QueryInsightsExporter exporter, String indexPattern) {
+    public QueryInsightsExporter updateExporter(QueryInsightsExporter exporter, String indexPattern, long templatePriority) {
         if (exporter.getClass() == LocalIndexExporter.class) {
-            ((LocalIndexExporter) exporter).setIndexPattern(DateTimeFormatter.ofPattern(indexPattern, Locale.ROOT));
+            LocalIndexExporter localExporter = (LocalIndexExporter) exporter;
+            localExporter.setIndexPattern(DateTimeFormatter.ofPattern(indexPattern, Locale.ROOT));
+            localExporter.setTemplatePriority(templatePriority);
         }
         return exporter;
     }

Diff for: src/main/java/org/opensearch/plugin/insights/core/exporter/QueryInsightsExporterFactory.java

@@ -17,6 +17,7 @@
 import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.MIN_DELETE_AFTER_VALUE;
 import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.QUERY_INSIGHTS_EXECUTOR;
 import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.TOP_N_EXPORTER_DELETE_AFTER;
+import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.TOP_N_EXPORTER_TEMPLATE_PRIORITY;
 import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.TOP_N_EXPORTER_TYPE;
 import static org.opensearch.plugin.insights.settings.QueryInsightsSettings.TOP_QUERIES_INDEX_PATTERN_GLOB;
 
@@ -178,9 +179,12 @@ public QueryInsightsService(
                 (this::setExporterDeleteAfterAndDelete),
                 (this::validateExporterDeleteAfter)
             );
+        clusterService.getClusterSettings()
+            .addSettingsUpdateConsumer(TOP_N_EXPORTER_TEMPLATE_PRIORITY, this::setTemplatePriority, this::validateTemplatePriority);
 
         this.setExporterDeleteAfterAndDelete(clusterService.getClusterSettings().get(TOP_N_EXPORTER_DELETE_AFTER));
         this.setExporterAndReaderType(SinkType.parse(clusterService.getClusterSettings().get(TOP_N_EXPORTER_TYPE)));
+        this.setTemplatePriority(clusterService.getClusterSettings().get(TOP_N_EXPORTER_TEMPLATE_PRIORITY));
 
         this.searchQueryCategorizer = SearchQueryCategorizer.getInstance(metricsRegistry);
         this.enableSearchQueryMetricsFeature(false);
@@ -531,6 +535,38 @@ public void validateExporterType(final String exporterType) {
         queryInsightsExporterFactory.validateExporterType(exporterType);
     }
 
+    /**
+     * Set the template priority for all top queries exporters
+     *
+     * @param templatePriority the priority value to use for templates
+     */
+    public void setTemplatePriority(final long templatePriority) {
+        logger.info("Setting query insights index template priority to [{}]", templatePriority);
+        final QueryInsightsExporter topQueriesExporter = queryInsightsExporterFactory.getExporter(TOP_QUERIES_EXPORTER_ID);
+        if (topQueriesExporter != null && topQueriesExporter.getClass() == LocalIndexExporter.class) {
+            logger.debug("Updating query insights index template priority for top queries exporter to [{}]", templatePriority);
+            queryInsightsExporterFactory.updateExporter(
+                topQueriesExporter,
+                QueryInsightsSettings.DEFAULT_TOP_N_QUERIES_INDEX_PATTERN,
+                templatePriority
+            );
+        }
+    }
+
+    /**
+     * Validate the template priority
+     *
+     * @param templatePriority the priority value to validate
+     */
+    public void validateTemplatePriority(final long templatePriority) {
+        if (templatePriority < 0) {
+            OperationalMetricsCounter.getInstance().incrementCounter(OperationalMetric.INVALID_EXPORTER_TYPE_FAILURES);
+            throw new IllegalArgumentException(
+                String.format(Locale.ROOT, "Invalid template priority setting [%d], value should be a non-negative long.", templatePriority)
+            );
+        }
+    }
+
     @Override
     protected void doStart() {
         if (isAnyFeatureEnabled()) {

Diff for: src/main/java/org/opensearch/plugin/insights/core/service/QueryInsightsService.java

@@ -230,6 +230,10 @@ public class QueryInsightsSettings {
      * Default exporter type of top queries
      */
     public static final String DEFAULT_TOP_QUERIES_EXPORTER_TYPE = SinkType.LOCAL_INDEX.toString();
+    /**
+     * Default template priority for top queries indices
+     */
+    public static final long DEFAULT_TEMPLATE_PRIORITY = 1847L;
     /**
      * Default Top N local indices retention period in days
      */
@@ -271,6 +275,17 @@ public class QueryInsightsSettings {
      */
     public static final String TOP_QUERIES_INDEX_PATTERN_GLOB = "top_queries-*";
 
+    /**
+     * Setting for Top N local indices template priority
+     */
+    public static final Setting<Long> TOP_N_EXPORTER_TEMPLATE_PRIORITY = Setting.longSetting(
+        TOP_N_QUERIES_EXPORTER_PREFIX + ".template_priority",
+        DEFAULT_TEMPLATE_PRIORITY,
+        0L, // min value is 0
+        Setting.Property.Dynamic,
+        Setting.Property.NodeScope
+    );
+
     /**
      * Get the enabled setting based on type
      * @param type MetricType

Diff for: src/main/java/org/opensearch/plugin/insights/settings/QueryInsightsSettings.java

@@ -81,6 +81,7 @@ public void testGetSettings() {
                 QueryCategorizationSettings.SEARCH_QUERY_METRICS_ENABLED_SETTING,
                 QueryInsightsSettings.TOP_N_EXPORTER_DELETE_AFTER,
                 QueryInsightsSettings.TOP_N_EXPORTER_TYPE,
+                QueryInsightsSettings.TOP_N_EXPORTER_TEMPLATE_PRIORITY,
                 QueryCategorizationSettings.SEARCH_QUERY_FIELD_TYPE_CACHE_SIZE_KEY
             ),
             queryInsightsPlugin.getSettings()

Diff for: src/test/java/org/opensearch/plugin/insights/QueryInsightsPluginTests.java

@@ -354,6 +354,7 @@ public static void registerAllQueryInsightsSettings(ClusterSettings clusterSetti
         clusterSettings.registerSetting(QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_NAME);
         clusterSettings.registerSetting(QueryInsightsSettings.TOP_N_QUERIES_GROUPING_FIELD_TYPE);
         clusterSettings.registerSetting(QueryInsightsSettings.TOP_N_EXPORTER_DELETE_AFTER);
+        clusterSettings.registerSetting(QueryInsightsSettings.TOP_N_EXPORTER_TEMPLATE_PRIORITY);
         clusterSettings.registerSetting(QueryCategorizationSettings.SEARCH_QUERY_METRICS_ENABLED_SETTING);
     }
 }