Index templates

Index templates

This topic describes the composable index templates introduced in Elasticsearch 7.8. For information about how index templates worked previously, see the legacy template documentation.

An index template is a way to tell Elasticsearch how to configure an index when it is created. For data streams, the index template configures the stream’s backing indices as they are created. Templates are configured prior to index creation. When an index is created - either manually or through indexing a document - the template settings are used as a basis for creating the index.

There are two types of templates: index templates and component templates. Component templates are reusable building blocks that configure mappings, settings, and aliases. While you can use component templates to construct index templates, they aren’t directly applied to a set of indices. Index templates can contain a collection of component templates, as well as directly specify settings, mappings, and aliases.

The following conditions apply to index templates:

• Composable templates take precedence over legacy templates. If no composable template matches a given index, a legacy template may still match and be applied.
• If an index is created with explicit settings and also matches an index template, the settings from the create index request take precedence over settings specified in the index template and its component templates.
• Settings specified in the index template itself take precedence over the settings in its component templates.
• If a new data stream or index matches more than one index template, the index template with the highest priority is used.

Avoid index pattern collisions

Elasticsearch has built-in index templates, each with a priority of 100, for the following index patterns:

• logs-*-*
• metrics-*-*
• synthetics-*-*
• profiling-*

Elastic Agent uses these templates to create data streams. Index templates created by Fleet integrations use similar overlapping index patterns and have a priority up to 200.

If you use Fleet or Elastic Agent, assign your index templates a priority lower than 100 to avoid overriding these templates. Otherwise, to avoid accidentally applying the templates, do one or more of the following:

• To disable all built-in index and component templates, set stack.templates.enabled to false using the cluster update settings API.
• Use a non-overlapping index pattern.
• Assign templates with an overlapping pattern a priority higher than 500. For example, if you don’t use Fleet or Elastic Agent and want to create a template for the logs-* index pattern, assign your template a priority of 500. This ensures your template is applied instead of the built-in template for logs-*-*.
• To avoid naming collisions with built-in and Fleet-managed index templates, avoid using @ as part of the name of your own index templates.

Create index template

Use the index template and put component template APIs to create and update index templates. You can also manage index templates from Stack Management in Kibana.

The following requests create two component templates.

resp = client.cluster.put_component_template(
    name="component_template1",
    template={
        "mappings": {
            "properties": {
                "@timestamp": {
                    "type": "date"
                }
            }
        }
    },
)
print(resp)
resp1 = client.cluster.put_component_template(
    name="runtime_component_template",
    template={
        "mappings": {
            "runtime": {
                "day_of_week": {
                    "type": "keyword",
                    "script": {
                        "source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ENGLISH))"
                    }
                }
            }
        }
    },
)
print(resp1)

const response = await client.cluster.putComponentTemplate({
  name: "component_template1",
  template: {
    mappings: {
      properties: {
        "@timestamp": {
          type: "date",
        },
      },
    },
  },
});
console.log(response);
const response1 = await client.cluster.putComponentTemplate({
  name: "runtime_component_template",
  template: {
    mappings: {
      runtime: {
        day_of_week: {
          type: "keyword",
          script: {
            source:
              "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ENGLISH))",
          },
        },
      },
    },
  },
});
console.log(response1);

PUT _component_template/component_template1
{
  "template": {
    "mappings": {
      "properties": {
        "@timestamp": {
          "type": "date"
        }
      }
    }
  }
}
PUT _component_template/runtime_component_template
{
  "template": {
    "mappings": {
      "runtime": { 
        "day_of_week": {
          "type": "keyword",
          "script": {
            "source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ENGLISH))"
          }
        }
      }
    }
  }
}

The following request creates an index template that is composed of these component templates.

PUT _index_template/template_1
{
  "index_patterns": ["te*", "bar*"],
  "template": {
    "settings": {
      "number_of_shards": 1
    },
    "mappings": {
      "_source": {
        "enabled": true
      },
      "properties": {
        "host_name": {
          "type": "keyword"
        },
        "created_at": {
          "type": "date"
        }
      }
    },
    "aliases": {
      "mydata": { }
    }
  },
  "priority": 500,
  "composed_of": ["component_template1", "runtime_component_template"], 
  "version": 3,
  "_meta": {
    "description": "my custom"
  }
}