Add user setting to enable default message sort

Author: jordan-powers

x-pack/plugin/logsdb/src/main/java/org/elasticsearch/xpack/logsdb/LogsDBPlugin.java

@@ -48,6 +48,12 @@ public class LogsDBPlugin extends Plugin implements ActionPlugin, MapperPlugin {
         Setting.Property.Dynamic,
         Setting.Property.NodeScope
     );
+    static final Setting<Boolean> LOGSDB_DEFAULT_SORT_ON_MESSAGE_TEMPLATE = Setting.boolSetting(
+        "index.logsdb.default_sort_on_message_template",
+        false,
+        Setting.Property.IndexScope,
+        Setting.Property.Final
+    );
 
     private final LogsdbIndexModeSettingsProvider logsdbIndexModeSettingsProvider;
 
@@ -97,7 +103,8 @@ public List<Setting<?>> getSettings() {
             FALLBACK_SETTING,
             CLUSTER_LOGSDB_ENABLED,
             LOGSDB_PRIOR_LOGS_USAGE,
-            PatternTextFieldMapper.DISABLE_TEMPLATING_SETTING
+            PatternTextFieldMapper.DISABLE_TEMPLATING_SETTING,
+            LOGSDB_DEFAULT_SORT_ON_MESSAGE_TEMPLATE
         );
     }
 

x-pack/plugin/logsdb/src/main/java/org/elasticsearch/xpack/logsdb/LogsdbIndexModeSettingsProvider.java

@@ -157,7 +157,9 @@ && matchesLogsPattern(dataStreamName)) {
                 additionalSettings.put(IndexSettings.LOGSDB_SORT_ON_HOST_NAME.getKey(), true);
             }
 
-            if (mappingHints.sortOnMessageTemplate) {
+            if (mappingHints.sortOnMessageTemplate
+                && (LogsDBPlugin.LOGSDB_DEFAULT_SORT_ON_MESSAGE_TEMPLATE.get(settings)
+                    || IndexSettings.LOGSDB_SORT_ON_MESSAGE_TEMPLATE.get(settings))) {
                 additionalSettings.put(IndexSettings.LOGSDB_SORT_ON_MESSAGE_TEMPLATE.getKey(), true);
             }
 

x-pack/plugin/logsdb/src/test/java/org/elasticsearch/xpack/logsdb/LogsdbIndexModeSettingsProviderTests.java

@@ -1072,6 +1072,61 @@ public void testSortAndHostNameKeyword() throws Exception {
         assertEquals(1, newMapperServiceCounter.get());
     }
 
+    public void testSortAndHostNameKeywordAndMessage() throws Exception {
+        var settings = Settings.builder()
+            .put(IndexSettings.MODE.getKey(), IndexMode.LOGSDB)
+            .put(LogsDBPlugin.LOGSDB_DEFAULT_SORT_ON_MESSAGE_TEMPLATE.getKey(), true)
+            .build();
+
+        var mappings = """
+            {
+                "properties": {
+                    "@timestamp": {
+                        "type": "date"
+                    },
+                    "host.name": {
+                        "type": "keyword"
+                    },
+                    "message": {
+                        "type": "pattern_text"
+                    }
+                }
+            }
+            """;
+
+        Settings result = generateLogsdbSettings(settings, getMapping(mappings));
+        assertTrue(IndexSettings.LOGSDB_SORT_ON_HOST_NAME.get(result));
+        assertTrue(IndexSettings.LOGSDB_SORT_ON_MESSAGE_TEMPLATE.get(result));
+        assertFalse(IndexSettings.LOGSDB_ADD_HOST_NAME_FIELD.get(result));
+        assertEquals(1, newMapperServiceCounter.get());
+    }
+
+    public void testSortAndHostNameKeywordAndDisabledMessage() throws Exception {
+        var settings = Settings.builder().put(IndexSettings.MODE.getKey(), IndexMode.LOGSDB).build();
+
+        var mappings = """
+            {
+                "properties": {
+                    "@timestamp": {
+                        "type": "date"
+                    },
+                    "host.name": {
+                        "type": "keyword"
+                    },
+                    "message": {
+                        "type": "pattern_text"
+                    }
+                }
+            }
+            """;
+
+        Settings result = generateLogsdbSettings(settings, getMapping(mappings));
+        assertTrue(IndexSettings.LOGSDB_SORT_ON_HOST_NAME.get(result));
+        assertFalse(IndexSettings.LOGSDB_SORT_ON_MESSAGE_TEMPLATE.get(result));
+        assertFalse(IndexSettings.LOGSDB_ADD_HOST_NAME_FIELD.get(result));
+        assertEquals(1, newMapperServiceCounter.get());
+    }
+
     public void testSortAndHostNameKeywordNoDocvalues() throws Exception {
         var settings = Settings.builder().put(IndexSettings.MODE.getKey(), IndexMode.LOGSDB).build();
         var mappings = """

x-pack/plugin/logsdb/src/yamlRestTest/resources/rest-api-spec/test/80_index_sort_defaults.yml

@@ -138,6 +138,7 @@ create logsdb data stream with message as pattern text, and timestamp as date:
           template:
             settings:
               mode: "logsdb"
+              logsdb.default_sort_on_message_template: true
             mappings:
               properties:
                 message:
@@ -194,6 +195,7 @@ create logsdb data stream with host.name as keyword, message as pattern text, an
           template:
             settings:
               mode: "logsdb"
+              logsdb.default_sort_on_message_template: true
             mappings:
               properties:
                 host.name:
@@ -239,6 +241,63 @@ create logsdb data stream with host.name as keyword, message as pattern text, an
   - match: { .$backing_index.defaults.index.sort.mode: [ "min", "min", "max" ] }
   - match: { .$backing_index.defaults.index.sort.missing: [ "_last", "_last", "_last" ] }
 
+---
+create logsdb data stream with host.name as keyword, message as pattern text, and timestamp as date, but message sort disabled:
+  - do:
+      cluster.put_component_template:
+        name: "logsdb-mappings"
+        body:
+          template:
+            settings:
+              mode: "logsdb"
+            mappings:
+              properties:
+                host.name:
+                  type: "keyword"
+                message:
+                  type: pattern_text
+                "@timestamp":
+                  type: "date"
+
+  - do:
+      indices.put_index_template:
+        name: "logsdb-index-template"
+        body:
+          index_patterns: ["logsdb"]
+          data_stream: {}
+          composed_of: ["logsdb-mappings"]
+      allowed_warnings:
+        - "index template [logsdb-index-template] has index patterns [logsdb] matching patterns from existing older templates [global] with patterns (global => [*]); this template [logsdb-index-template] will take precedence during new index creation"
+
+  - do:
+      indices.create_data_stream:
+        name: "logsdb"
+
+  - is_true: acknowledged
+  - do:
+      indices.get_data_stream:
+        name: "logsdb"
+        expand_wildcards: hidden
+  - length: { data_streams: 1 }
+  - set: { data_streams.0.indices.0.index_name: backing_index }
+
+  - do:
+      indices.get_settings:
+        index: $backing_index
+        include_defaults: true
+  - match: { .$backing_index.settings.index.mode: logsdb }
+  - match: { .$backing_index.settings.index.logsdb.add_host_name_field: null }
+  - match: { .$backing_index.defaults.index.logsdb.add_host_name_field: "false" }
+  - match: { .$backing_index.settings.index.logsdb.sort_on_host_name: "true" }
+  - match: { .$backing_index.settings.index.logsdb.sort_on_message_template: null}
+  - match: { .$backing_index.defaults.index.logsdb.sort_on_message_template: "false" }
+  - match: { .$backing_index.settings.index.logsdb.default_sort_on_message_template: null }
+  - match: { .$backing_index.defaults.index.logsdb.default_sort_on_message_template: "false" }
+  - match: { .$backing_index.defaults.index.sort.field: [ "host.name", "@timestamp" ] }
+  - match: { .$backing_index.defaults.index.sort.order: [ "asc", "desc" ] }
+  - match: { .$backing_index.defaults.index.sort.mode: [ "min", "max" ] }
+  - match: { .$backing_index.defaults.index.sort.missing: [ "_last", "_last" ] }
+
 ---
 create logsdb data stream with host.name as integer and timestamp as date:
   - do: