文章目录
- 一、什么是Elasticsearch Template？
- 二、Elasticsearch Template的用法
- 2.1、创建模板
- 2.2、验证模板
- 2.3、应用模板
- 2.4、删除模板
- 2.5、组合模板
- 2.6、如何在同一个模板中定义多种匹配模式
- 2.7、模板优先级
- 2.8、提前模拟索引的最终映射
- 三、Elasticsearch Template的优点
一、什么是Elasticsearch Template？
Elasticsearch Template是一种将预定义模板应用于新索引的功能。在索引创建时，它可以自动为新索引应用已定义的模板。Template功能可用于定义索引的映射、设置和别名等。它是一种自动化管理索引创建的方式，使用户可以在大量索引上快速而一致地应用模板。
二、Elasticsearch Template的用法
2.1、创建模板
使用PUT命令创建模板，语法如下：
PUT _template/my_template
{
"index_patterns": ["logs-*"],
"settings": {
"number_of_shards": 3,
"number_of_replicas": 2
},
"mappings": {
"_source": {
"enabled": true
},
"properties": {
"timestamp": {
"type": "date",
"format": "yyyy-MM-dd HH:mm:ss"
},
"message": {
"type": "text"
},
"user": {
"type": "keyword"
}
}
},
"aliases": {
"logs_write": {},
"logs_read": {}
}
}
在上面的代码中，我们定义了一个模板名称为“my_template”，并将其应用于索引名称为“logs-*”的所有索引。在模板中，我们定义了索引的设置、映射和别名等。一旦使用创建索引的命令，只要索引的名称匹配logs-，就能够自动匹配这个模板，进行索引的设置。
2.2、验证模板
使用GET命令来检索已创建的模板，语法如下：
GET _template/my_template
使用GET命令来检索名称为“my_template”的模板。如果模板已创建，则会显示模板详细信息，否则会返回404错误。
2.3、应用模板
创建一个新的索引，索引名为"logstash-2023.03.01"的索引，它符合"logstash-*"模式，并且具有与模板中定义的相同的字段映射、分片数等设置。
PUT logstash-2021.03.01
还支持类似以下模式，使用Date Math将当前日期格式化为所需的日期格式，并将其用作索引名称的一部分，以下代码创建一个名为"logstash-2022.03.09"的索引，并将其日期设置为2023年3月9日，同样匹配"logstash-*"模式，自动应用模板。
PUT logstash-<now/d{yyyy.MM.dd}>
{
"timestamp": "2023-03-09T00:00:00"
}
如果想每天自动创建新的索引，可以使用定时任务（例如Cron）来定期执行创建索引的命令。例如，在Linux上，您可以使用以下Cron表达式来每天创建一个新索引：
0 0 * * * curl -XPUT 'http://localhost:9200/my_index-<now/d{yyyy.MM.dd}>' -H 'Content-Type: application/json' -d '{"timestamp": "'$(date +%Y-%m-%dT00:00:00)'"}'
上面的命令将在每天的0点创建一个新的索引，并将其日期设置为当天的日期。注意要将命令中的"localhost:9200"替换为Elasticsearch实例的实际地址。
通过使用索引模板和日期格式化，可以轻松自动创建具有固定日期的索引，并避免手动创建索引带来的繁琐和错误。
2.4、删除模板
使用DELETE命令来删除模板，语法如下：
DELETE _template/my_template
在上面的代码中，我们使用DELETE命令来删除名称为“my_template”的模板。如果模板已删除，则会返回200响应；否则，将返回404错误。
2.5、组合模板
可以使用模板继承的方式来组合多个模板。比如，你以定义一个基础模板，然后在其他模板中引用它，从而获得基础模板的所有属性和设置。
可以使用以下方法来实现，首先先使用以下命令定义一个名为base-template的基础模板.
PUT _template/base-template
{
"index_patterns": ["my-index-*"],
"settings": {
"number_of_shards": 1
},
"mappings": {
"_doc": {
"properties": {
"field1": {
"type": "text"
}
}
}
}
}
再定义一个名为my-template的子模板，并通过"template": {"name": "base-template"}属性引用了base-template。子模板可以覆盖基础模板中的任何设置或属性。
PUT _template/my-template
{
"index_patterns": ["my-index-*"],
"template": {
"name": "base-template"
},
"settings": {
"number_of_replicas": 2
},
"mappings": {
"_doc": {
"properties": {
"field2": {
"type": "keyword"
}
}
}
}
}
2.6、如何在同一个模板中定义多种匹配模式
可以使用通配符来指定多个索引模式。例如，你可以使用"index_patterns": ["index-A-*", "index-B-*"]来同时定义index-A-*和index-B-*这两个索引模式，所有匹配这两种模式的，都具有一样的索引设置和映射。
PUT _template/template_A_B
{
"index_patterns": ["my-index-*", "your-index-*"],
"order":1,
"settings": {
"number_of_shards": 1
},
"mappings": {
"_doc": {
"properties": {
"field1": {
"type": "text"
}
}
}
}
}
2.7、模板优先级
如果某一个索引匹配了两个不同的模板，那么到底应该引用哪一个模板呢？实际上，如果两个模板都匹配了，那么索引会继承所有的模板设置，如果相同字段设置存在冲突时，会用更高优先级的模版设置覆盖更低优先级的模版设置，如果两个模板的优先级一样，则到底引用谁是不确定的，所以必须要考虑好优先级问题。
在模板中优先级通过order字段进行设置，字段类型为数字，数字越大则优先级越高。
2.8、提前模拟索引的最终映射
Elasticsearch提供了simulation APIs用于提前模拟索引匹配模板，输出最终的设置和映射等信息，这可以用于正式创建索引之前进行确认工作，以确保创建的多个模板能够满足index创建的需求。
POST /_index_template/_simulate_index/my-index-000001
以上所示，使用simulate API模拟创建my-index-000001索引，输出结果类似如下，可以看出匹配的模板和相关的设置、映射。verlapping指出了一个匹配的模板，但是其优先级更低。
{
"template" : {
"settings" : {
"index" : {
"number_of_shards" : "3",
"number_of_replicas" : "0",
"routing" : {
"allocation" : {
"include" : {
"_tier_preference" : "data_content"
}
}
}
}
},
"mappings" : {
"properties" : {
"@timestamp" : {
"type" : "date"
}
}
},
"aliases" : { }
},
"overlapping" : [
{
"name" : "template_1",
"index_patterns" : [
"my*"
]
}
]
}
三、Elasticsearch Template的优点
Elasticsearch Template功能的应用场景很广泛，以下是一些常见的用例：
- 维护索引一致性：当用户需要创建多个相似的索引时，使用模板可以确保这些索引的设置和映射都是一致的。
- 减少错误：使用模板可以减少人为错误的可能性，因为模板可以强制执行特定的索引结构。
- 提高效率：使用模板可以节省时间和精力，因为用户不需要手动为每个索引设置相同的映射和设置。
- 管理别名：使用模板可以轻松地为索引定义别名，从而可以更方便地管理和查询索引。
总之，Elasticsearch Template是一种简单而有用的功能，它可以使用户更轻松地管理和维护Elasticsearch索引。当用户需要在多个相似的索引上执行相同的操作时，使用模板可以提高效率并减少人为错误。此外，模板还可以帮助用户维护索引的一致性，并且可以轻松地为索引定义别名，从而使索引更易于管理和查询。
