インデックステンプレート

このトピックでは、Elasticsearch 7.8で導入されたコンポーザブルインデックステンプレートについて説明します。以前のインデックステンプレートの動作については、レガシーテンプレートのドキュメントを参照してください。

インデックステンプレートは、インデックスが作成されるときにElasticsearchにインデックスをどのように構成するかを指示する方法です。データストリームの場合、インデックステンプレートは、ストリームのバックインデックスが作成されるときにそれを構成します。テンプレートはインデックス作成の前に構成されます。インデックスが手動で作成されるか、ドキュメントをインデックスすることによって作成されるとき、テンプレートの設定がインデックス作成の基礎として使用されます。

テンプレートには2種類あります：インデックステンプレートとコンポーネントテンプレート。コンポーネントテンプレートは、マッピング、設定、およびエイリアスを構成する再利用可能なビルディングブロックです。コンポーネントテンプレートを使用してインデックステンプレートを構築できますが、特定のインデックスセットに直接適用されることはありません。インデックステンプレートは、コンポーネントテンプレートのコレクションを含むことができ、設定、マッピング、およびエイリアスを直接指定することもできます。

インデックステンプレートには以下の条件が適用されます：

  • コンポーザブルテンプレートはレガシーテンプレートよりも優先されます。特定のインデックスに一致するコンポーザブルテンプレートがない場合、レガシーテンプレートが一致して適用される可能性があります。
  • 明示的な設定でインデックスが作成され、インデックステンプレートにも一致する場合、インデックス作成リクエストの設定がインデックステンプレートおよびそのコンポーネントテンプレートで指定された設定よりも優先されます。
  • インデックステンプレート自体で指定された設定は、そのコンポーネントテンプレートの設定よりも優先されます。

  • 新しいデータストリームまたはインデックスが複数のインデックステンプレートに一致する場合、最も優先度の高いインデックステンプレートが使用されます。

インデックスパターンの衝突を避ける

Elasticsearchには、以下のインデックスパターンに対して優先度100の組み込みインデックステンプレートがあります：

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

Elastic Agentは、これらのテンプレートを使用してデータストリームを作成します。Fleet統合によって作成されたインデックステンプレートは、類似の重複インデックスパターンを使用し、優先度は200までです。

FleetまたはElastic Agentを使用する場合、これらのテンプレートを上書きしないように、インデックステンプレートに100よりも低い優先度を割り当ててください。そうでない場合、テンプレートを誤って適用しないように、次のいずれかを行ってください：

  • すべての組み込みインデックスおよびコンポーネントテンプレートを無効にするには、stack.templates.enabledをfalseに設定します。クラスタ更新設定APIを使用します。
  • 重複しないインデックスパターンを使用します。
  • 重複パターンを持つテンプレートにpriorityを200よりも高く割り当てます。たとえば、FleetまたはElastic Agentを使用せず、logs-*インデックスパターンのテンプレートを作成したい場合、テンプレートに500の優先度を割り当てます。これにより、logs-*-*の組み込みテンプレートの代わりにテンプレートが適用されます。
  • 組み込みおよびFleet管理インデックステンプレートとの名前の衝突を避けるために、独自のインデックステンプレートの名前の一部として@を使用しないでください。

インデックステンプレートの作成

インデックステンプレートを作成および更新するには、インデックステンプレートおよびコンポーネントテンプレートを配置するAPIを使用します。また、Kibanaのスタック管理からインデックステンプレートを管理することもできます。

以下のリクエストは、2つのコンポーネントテンプレートを作成します。

Python

  1. resp = client.cluster.put_component_template(
  2.    name="component_template1",
  3.    template={
  4.    "mappings": {
  5.    "properties": {
  6.    "@timestamp": {
  7.    "type": "date"
  8.    }
  9.    }
  10.    }
  11.    },
  12. )
  13. print(resp)
  15. resp1 = client.cluster.put_component_template(
  16.    name="runtime_component_template",
  17.    template={
  18.    "mappings": {
  19.    "runtime": {
  20.    "day_of_week": {
  21.    "type": "keyword",
  22.    "script": {
  23.    "source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ENGLISH))"
  24.    }
  25.    }
  26.    }
  27.    }
  28.    },
  29. )
  30. print(resp1)

Js

  1. const response = await client.cluster.putComponentTemplate({
  2.   name: "component_template1",
  3.   template: {
  4.    mappings: {
  5.    properties: {
  6.    "@timestamp": {
  7.    type: "date",
  8.    },
  9.    },
  10.    },
  11.   },
  12. });
  13. console.log(response);
  15. const response1 = await client.cluster.putComponentTemplate({
  16.   name: "runtime_component_template",
  17.   template: {
  18.    mappings: {
  19.    runtime: {
  20.    day_of_week: {
  21.    type: "keyword",
  22.    script: {
  23.    source:
  24.    "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ENGLISH))",
  25.    },
  26.    },
  27.    },
  28.    },
  29.   },
  30. });
  31. console.log(response1);

コンソール

  1. PUT _component_template/component_template1
  2. {
  3.   "template": {
  4.    "mappings": {
  5.    "properties": {
  6.    "@timestamp": {
  7.    "type": "date"
  8.    }
  9.    }
  10.    }
  11.   }
  12. }
  14. PUT _component_template/runtime_component_template
  15. {
  16.   "template": {
  17.    "mappings": {
  18.    "runtime": {
  19.    "day_of_week": {
  20.    "type": "keyword",
  21.    "script": {
  22.    "source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ENGLISH))"
  23.    }
  24.    }
  25.    }
  26.    }
  27.   }
  28. }
このコンポーネントテンプレートは、新しいインデックスがテンプレートに一致する際に、マッピングにランタイムフィールド
名付けられたday_of_weekを追加します。

以下のリクエストは、これらのコンポーネントテンプレートで構成されたインデックステンプレートを作成します。

コンソール

  1. PUT _index_template/template_1
  2. {
  3.   "index_patterns": ["te*", "bar*"],
  4.   "template": {
  5.    "settings": {
  6.    "number_of_shards": 1
  7.    },
  8.    "mappings": {
  9.    "_source": {
  10.    "enabled": true
  11.    },
  12.    "properties": {
  13.    "host_name": {
  14.    "type": "keyword"
  15.    },
  16.    "created_at": {
  17.    "type": "date"
  18.    }
  19.    }
  20.    },
  21.    "aliases": {
  22.    "mydata": { }
  23.    }
  24.   },
  25.   "priority": 500,
  26.   "composed_of": ["component_template1", "runtime_component_template"],
  27.   "version": 3,
  28.   "_meta": {
  29.    "description": "my custom"
  30.   }
  31. }