Add tsdb metrics builtin component template (#97602)

Fleet is currently hard coded to set index.codec to best_compression (deflate compression). This is good for most data streams, except for data streams were tsdb is enabled. Ideally Fleet doesn't need to set this setting at all and Elasticsearch's default would be good. But unfortunately this isn't the case. It default to default (lz4 - optimised for speed), which in would mean much higher disk space usage. Ideally the default would be default when synthetic source is enabled and otherwise best_compression. Changing this now, would mean a breaking change.

Instead Fleet like to depend on Elasticsearch's internal component templates. To at least abstract some of the internal details away. The metrics-settings is ok for non tsdb, but there is no component template for tsdb metrics. This PR adds this.

Relates to elastic/kibana#160288

Author: martijnvg

docs/changelog/97602.yaml

@@ -0,0 +1,5 @@
+pr: 97602
+summary: Add tsdb metrics builtin component template
+area: "TSDB"
+type: enhancement
+issues: []

docs/reference/indices/put-component-template.asciidoc

@@ -95,6 +95,7 @@ Name of the component template to create.
 - `logs-settings`
 - `metrics-mappings`
 - `metrics-settings`
+- `metrics-tsdb-settings`
 - `synthetics-mapping`
 - `synthetics-settings`
 // end::built-in-component-templates[]

test/framework/src/main/java/org/elasticsearch/test/rest/ESRestTestCase.java

@@ -1843,6 +1843,7 @@ protected static boolean isXPackTemplate(String name) {
             case "logs-mappings":
             case "metrics":
             case "metrics-settings":
+            case "metrics-tsdb-settings":
             case "metrics-mappings":
             case "synthetics":
             case "synthetics-settings":

x-pack/plugin/core/template-resources/src/main/resources/metrics-tsdb-settings.json

@@ -0,0 +1,19 @@
+{
+  "template": {
+    "settings": {
+      "index": {
+        "lifecycle": {
+          "name": "metrics"
+        },
+        "query": {
+          "default_field": ["message"]
+        }
+      }
+    }
+  },
+  "_meta": {
+    "description": "default settings for the metrics index template installed by x-pack",
+    "managed": true
+  },
+  "version": ${xpack.stack.template.version}
+}

x-pack/plugin/stack/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/stack/10_basic.yml

@@ -34,6 +34,10 @@ setup:
       cluster.get_component_template:
         name: metrics-settings
 
+  - do:
+      cluster.get_component_template:
+        name: metrics-tsdb-settings
+
   - do:
       indices.get_index_template:
         name: logs

x-pack/plugin/stack/src/main/java/org/elasticsearch/xpack/stack/StackTemplateRegistry.java

@@ -83,6 +83,7 @@ public class StackTemplateRegistry extends IndexTemplateRegistry {
     //////////////////////////////////////////////////////////
     public static final String METRICS_MAPPINGS_COMPONENT_TEMPLATE_NAME = "metrics-mappings";
     public static final String METRICS_SETTINGS_COMPONENT_TEMPLATE_NAME = "metrics-settings";
+    public static final String METRICS_TSDB_SETTINGS_COMPONENT_TEMPLATE_NAME = "metrics-tsdb-settings";
     public static final String METRICS_ILM_POLICY_NAME = "metrics";
     public static final String METRICS_INDEX_TEMPLATE_NAME = "metrics";
 
@@ -196,6 +197,12 @@ protected List<LifecyclePolicy> getLifecyclePolicies() {
                 REGISTRY_VERSION,
                 TEMPLATE_VERSION_VARIABLE
             ),
+            new IndexTemplateConfig(
+                METRICS_TSDB_SETTINGS_COMPONENT_TEMPLATE_NAME,
+                "/metrics-tsdb-settings.json",
+                REGISTRY_VERSION,
+                TEMPLATE_VERSION_VARIABLE
+            ),
             new IndexTemplateConfig(
                 SYNTHETICS_MAPPINGS_COMPONENT_TEMPLATE_NAME,
                 "/synthetics-mappings.json",

x-pack/plugin/stack/src/test/java/org/elasticsearch/xpack/stack/StackTemplateRegistryTests.java

@@ -382,6 +382,7 @@ public void testSameOrHigherVersionTemplateNotUpgraded() {
         versions.put(StackTemplateRegistry.LOGS_SETTINGS_COMPONENT_TEMPLATE_NAME, StackTemplateRegistry.REGISTRY_VERSION);
         versions.put(StackTemplateRegistry.LOGS_MAPPINGS_COMPONENT_TEMPLATE_NAME, StackTemplateRegistry.REGISTRY_VERSION);
         versions.put(StackTemplateRegistry.METRICS_SETTINGS_COMPONENT_TEMPLATE_NAME, StackTemplateRegistry.REGISTRY_VERSION);
+        versions.put(StackTemplateRegistry.METRICS_TSDB_SETTINGS_COMPONENT_TEMPLATE_NAME, StackTemplateRegistry.REGISTRY_VERSION);
         versions.put(StackTemplateRegistry.METRICS_MAPPINGS_COMPONENT_TEMPLATE_NAME, StackTemplateRegistry.REGISTRY_VERSION);
         versions.put(StackTemplateRegistry.SYNTHETICS_SETTINGS_COMPONENT_TEMPLATE_NAME, StackTemplateRegistry.REGISTRY_VERSION);
         versions.put(StackTemplateRegistry.SYNTHETICS_MAPPINGS_COMPONENT_TEMPLATE_NAME, StackTemplateRegistry.REGISTRY_VERSION);
@@ -424,6 +425,10 @@ public void testSameOrHigherVersionTemplateNotUpgraded() {
             StackTemplateRegistry.METRICS_SETTINGS_COMPONENT_TEMPLATE_NAME,
             StackTemplateRegistry.REGISTRY_VERSION + randomIntBetween(1, 1000)
         );
+        versions.put(
+            StackTemplateRegistry.METRICS_TSDB_SETTINGS_COMPONENT_TEMPLATE_NAME,
+            StackTemplateRegistry.REGISTRY_VERSION + randomIntBetween(1, 1000)
+        );
         versions.put(
             StackTemplateRegistry.METRICS_MAPPINGS_COMPONENT_TEMPLATE_NAME,
             StackTemplateRegistry.REGISTRY_VERSION + randomIntBetween(1, 1000)