Elasticsearch 索引别名与Template

在使用elasticsearch的时候，经常会遇到需要淘汰掉历史数据的场景。

为了方便数据淘汰，并使得数据管理更加灵活，我们经常会以时间为粒度建立索引，例如：

• 每个月建立一个索引：monthly-201709、monthly-201710、monthly-201711
• 每天建立一个索引：daily-20171015、daily-20171016、daily-20171017、daily-20171018

当不需要再继续使用历史数据的时候，我们就可以将索引删除，释放资源。

为了很好的支撑这个场景，需要使用到Elasticsearch里的两个东西，索引别名和Template。

• 索引别名：建立索引对外的统一视图

例如，如果建立了上述类似的索引时间序列，在查询的时候以wildcards的方式指定索引，例如index=monthly-*，或者index=daily-201710*。当然也可以使用索引别名index=monthly。

• Template：修改建立索引的默认配置

例如，你不想承担定期去维护索引的风险和工作量，可以在插入数据时自动创建索引，Template可以提供自动创建索引时候的默认配置。

下面详细解释一下。

1、索引别名

一个索引别名就好比一个快捷方式(Shortcut)或一个符号链接(Symbolic Link)，索引别名可以指向一个或者多个索引，可以在任何需要索引名的API中使用。使用别名可以给我们非常多的灵活性。它能够让我们：

• 在一个运行的集群中透明地从一个索引切换到另一个索引
• 让多个索引形成一个组，比如last_three_months
• 为一个索引中的一部分文档创建一个视图(View)

如何创建索引别名呢？

1）创建索引

我这里创建audit-201710、audit-201711两个索引

curl -XPOST "http://10.93.21.21:8049/kangaroo-201710?pretty"
curl -XPOST "http://10.93.21.21:8049/kangaroo-201711?pretty"

如果安装了head，你可以在可视化页面看到

从索引信息可以看到，我们没有配置mapping和alias，shards和replicas也使用的默认值。

2）建立索引别名

curl -XPOST 'http://10.93.21.21:8049/_aliases' -d '
{
    "actions": [
        {"add": {"index": "kangaroo-201710", "alias": "kangaroo"}},
        {"add": {"index": "kangaroo-201711", "alias": "kangaroo"}}
    ]
}'

这样就对kangaroo-201710和kangaroo-201711建立了索引别名kangaroo，再看head可视化

可以看到索引别名已经建立。

3）注意

写：不能直接对索引别名进行写入。所以在写数据的时候，要直接使用普通索引。

读：查询，对索引别名进行查询，查询会透明的下发到别名下挂的所有索引执行，设置的路由也会随之下发。

2、带filtered的索引别名

对于同一个索引，例如zoo，我们如何给不同人看到不同的数据，即，所谓的多租户。

假设索引zoo的数据有个字段是group，group字段记录了该数据是那个“租户”的。多租户之间的数据应该是不可见的。

我们模拟一下这个场景

1）创建索引zoo

curl -XPOST "http://10.93.21.21:8049/zoo?pretty" 

2）设置mappings

curl -XPOST "http://10.93.21.21:8049/zoo/animal/_mapping?pretty" -d '
{
    "animal": {
        "properties": {
            "name": {"type": "string", index: "not_analyzed"},
            "group": {"type": "string", index: "not_analyzed"}
        }
    }
}'

3）设置带filter的别名

curl -XPOST "http://10.93.21.21:8049/_aliases?pretty" -d '
{
  "actions": [
    {
      "add": {
        "index": "zoo",
        "alias": "zoo_animal_vegetarian",
        "filter":{
            "term":{
                "group":"vegetarian"
            }
        }
      }
    },
    {
      "add": {
        "index": "zoo",
        "alias": "zoo_animal_carnivorous",
        "filter":{
            "term":{
                "group":"carnivorous"
            }
        }
      }
    }
  ]
}'

通过head看一下

我们索引两条数据进去

老虎-肉食

curl -XPUT 'http://10.93.21.21:8049/zoo/animal/1' -d '{
    "name" : "tiger",
    "group" : "carnivorous"
}'

兔子-素食

curl -XPUT 'http://10.93.21.21:8049/zoo/animal/2' -d '{
    "name" : "rabbit",
    "group" : "vegetarian"
}'

使用带filter的索引查一下

素食的只有兔子

curl -XGET "http://10.93.21.21:8049/zoo_animal_vegetarian/_search?pretty"
{
  "took" : ,
  "timed_out" : false,
  "_shards" : {
    "total" : ,
    "successful" : ,
    "failed" :
  },
  "hits" : {
    "total" : ,
    "max_score" : 1.0,
    "hits" : [ {
      "_index" : "zoo",
      "_type" : "animal",
      "_id" : "",
      "_score" : 1.0,
      "_source":{
    "name" : "rabbit",
    "group" : "vegetarian"
}
    } ]
  }
}

肉食的只有老虎

curl -XGET "http://10.93.21.21:8049/zoo_animal_carnivorous/_search?pretty"
{
  "took" : ,
  "timed_out" : false,
  "_shards" : {
    "total" : ,
    "successful" : ,
    "failed" :
  },
  "hits" : {
    "total" : ,
    "max_score" : 1.0,
    "hits" : [ {
      "_index" : "zoo",
      "_type" : "animal",
      "_id" : "",
      "_score" : 1.0,
      "_source":{
    "name" : "tiger",
    "group" : "carnivorous"
}
    } ]
  }
}

当你建立索引时间序列的时候，遇到的问题是，需要不断的建立新索引，例如到了11月份，你可以需要新建kangaroo-201711这个索引。

当然，如果不创建索引，直接写入数据的话，ES会为你分析你写入的document的字段类型，并使用默认配置建立索引。

但是默认配置可能并不是你想要的。例如ES对string类型默认是分析的，即，对string类型会进行分词，但是你的数据中可能有一些string类型的字段不希望被分析。

那么怎么修改默认配置呢？可以创建一个template。

3、Template

template可以修改索引的默认配置。我们以下面这个template为例说明一下。

1）我们建立了一个template名称为kangaroo_template

2）"template": "kangaroo*"，表示对于所有以kangaroo*开头的索引，默认配置使用template中的配置。

3）"settings"，"mappings"，"aliases"，可以修改这些类型的默认配置

4）禁用了_source，对name字段设置string类型且不分析，索引别名设置为kangaroo

curl -XPUT "http://10.93.21.21:8049/_template/kangaroo_template?pretty" -d '{
  "template": "kangaroo*",
  "settings": {
    "number_of_shards":
  },
  "mappings": {
    "data": {
      "_source": {
        "enabled": false
      },
      "properties": {
        "name": {
          "type": "string",
          "index": "not_analyzed"
        },
        "id": {
          "type": "long"
        }
      }
    }
  },
  "aliases": {"kangaroo":{}}
}'

执行生效后，看一下template生效的内容，这里注意有一个"order"字段，该字段跟多template合并有关，后面我们会讲。

curl -XGET "http://10.93.21.21:8049/_template/kangaroo_template?pretty"
{
  "kangaroo_template" : {
    "order" : ,
    "template" : "kangaroo*",
    "settings" : {
      "index" : {
        "number_of_shards" : ""
      }
    },
    "mappings" : {
      "data" : {
        "_source" : {
          "enabled" : false
        },
        "properties" : {
          "name" : {
            "index" : "not_analyzed",
            "type" : "string"
          },
          "id" : {
            "type" : "long"
          }
        }
      }
    },
    "aliases" : {
      "kangaroo" : { }
    }
  }
}

我们可以向一个不存在的索引写入数据，这个操作会使用默认配置，如果索引名称命中template中的规则，就会使用template的配置创建索引。

这里我们向kangaroo-201712写入数据，会命中之前创建的kangaroo_template。

curl -XPUT 'http://10.93.21.21:8049/kangaroo-201712/data/1' -d '{
    "name" : "yang",
    "id" : "",
    "weight" : "70 kg"
}'

通过head看一下，可以看到，索引别名已经建立，分片数=10，source禁用生效，name不分析。这就是我们想要的结果。

多个template配置的合并

这个场景是这样的，一个索引命中了多个template配置，例如：有两个template配置分别为：a*, ab*，那么如果有一个索引名字是abc，就会命中了两个template，这时候会怎么样呢？

配置会merge，merge的法则可以参见官方文档，简单来说，就是跟order值有关，较小order值的配置会先生效，较大order值的配置会继而覆盖。