LiferayのElasticsearchアダプタモジュールのデフォルト設定は、ElasticsearchConfigurationというJavaクラスに設定されています。
Elasticsearchアダプターにはデフォルトで様々なオプションが含まれていますが、それでも必要な設定オプションが見つからない場合もあります。このような場合、設定オプションを追加することもできます。Elasticsearchにコンフィグレーションオプションを追加したい場合は、Liferay DXPのElasticsearchアダプターを使って必要に応じた設定をすることが可能です。
Liferay Elasticsearchアダプターに設定とマッピングを追加する
利用可能な設定オプションは
2つのグループに分けられます：デフォルトで最も頻繁に使われるものと他のすべてのものを管理するものです。必要な設定がデフォルトで利用できない場合でも、Liferay Elasticsearchアダプターを使用して設定できます。
additionalConfigurations、additionalIndexConfigurationsもしくadditionalTypeMappings、およびoverrideTypeMappings設定の中から一つ以上を使用することにより、必要な設定を指定します。
additionalConfigurationsは、EmbeddedモードのElasticsearchのための追加設定を（YAMLで）定義します。これはEmbeddedモードのElasticsearchサーバーを使用したテスト環境でのみ役に立ちます。通常elasticsearch.ymlで設定されているノード設定はすべてここで宣言できます。 全ての可能なノード設定の説明については、Elasticsearchの資料を参照してください 。
additionalIndexConfigurationsは、作成時にLiferay DXPインデックスに適用される追加設定を（JSONまたはYAMLで）定義します。たとえば、この設定を使用してカスタムアナライザとフィルタを作成できます。使用可能な設定の完全なリストについては、Elasticsearchのリファレンスを参照してください。
動的テンプレートに適用できる分析を設定する方法の例を次に示します （下記参照）。
{
"analysis": {
"analyzer": {
"kuromoji_liferay_custom": {
"filter": [
"cjk_width",
"kuromoji_baseform",
"pos_filter"
],
"tokenizer": "kuromoji_tokenizer"
}
},
"filter": {
"pos_filter": {
"type": "kuromoji_part_of_speech"
}
}
}
}
additionalTypeMappingsは、LiferayDocumentType型定義のための追加のフィールドマッピングを定義します。これらはインデックスが作成されたときに適用されます。JSONシンタックスを使用して、これらのフィールドマッピングを追加します。詳しくはこちら と こちらをご覧ください 。
新しいフィールドマッピングにadditionalTypeMappingsを使用しますが、既存のpropertiesマッピングを上書きしないでください。ここで設定したpropertiesマッピングのいずれかが既存のマッピングと重複すると、インデックスの作成は失敗します。overrideTypeMappingsをデフォルトのpropertiesマッピングを置き換えるために使用してください。
以下は、上記の分析設定を使用して、_jaで終わるすべての文字列フィールドを分析する動的テンプレートの例です。
{
"LiferayDocumentType": {
"dynamic_templates": [
{
"template_ja": {
"mapping": {
"analyzer": "kuromoji_liferay_custom",
"index": "analyzed",
"store": "true",
"term_vector": "with_positions_offsets",
"type": "string"
},
"match": "\\w+_ja\\b|\\w+_ja_[A-Z]{2}\\b",
"match_mapping_type": "string",
"match_pattern": "regex"
}
}
]
}
}
上記のコードは新しいtemplate_jaの動的テンプレートを追加します。これは、同じ名前の既存の動的テンプレートを上書きします。動的テンプレートと同様に、Liferay DXPの型マッピングにサブフィールドマッピングを追加できます。Elasticsearchではこれらはプロパティと呼ばれています。
{
"LiferayDocumentType": {
"properties": {
"fooName": {
"index": "true",
"store": "true",
"type": "keyword"
}
}
}
}
Elasticsearchのフィールドのデータ型の詳細については、こちらを参照してください 。
上記の例は、Liferay DXPの型マッピングにfooNameフィールドを追加する方法を示しています。fooNameはマッピング内の既存のプロパティではないため、正常に機能します。既存のプロパティマッピングを上書きしようとすると、インデックスの作成は失敗します。代わりに、マッピングでpropertiesを上書きするためにoverrideTypeMappings設定を使用してください。
**注：**追加のマッピングがLiferayDocumentTypeに追加されたことを確認するには、追加を保存し、インデックスを再作成した後に、curlを使用して、このURLにアクセスします。
curl http://[HOST]:[ES_PORT]/liferay-[COMPANY_ID]/_mapping/LiferayDocumentType?pretty
これはElasticsearchインスタンスがlocalhost:9200で実行され、Liferay DXP Company IDが20116に設定されている例です。
curl http://localhost:9200/liferay-20116/_mapping/LiferayDocumentType?pretty
上記のURLではliferay-20116がインデックス名です。これを含めると、その名前のインデックスを作成するために使用されたマッピングを表示したいことを示します。
overrideTypeMappingsは、Liferay DXPのデフォルトの型マッピングを上書きするために使用します。これは高度な機能であり、どうしても必要な場合にのみ使用します。この値を設定すると、Liferay DXPのソースコードでLiferayドキュメントタイプを定義するために使用されるデフォルトのマッピング（例：liferay-type-mappings.json）は完全に無視されるため、変更するセグメントだけではなく、マッピングの定義全体をこのプロパティに含めます。変更するには、URLに移動してインデックスの作成に使用されている現在のマッピングのリスト全体を探します。
http://[HOST]:[ES_PORT]/liferay-[COMPANY_ID]/_mapping/LiferayDocumentType?pretty
このプロパティの値としての内容を（システム設定またはOSGi設定ファイルに）コピーします。左側の中括弧{はそのままにしますが、2〜4行目を完全に削除します。
"liferay-[COMPANY_ID]": {
"mappings" : {
"LiferayDocumentType" : {
次に、マッピングの最後から、最後の3つの中括弧を削除します。
}
}
}
この時点で、適切なマッピングを変更します。変更を保存してServer Administrationからのインデックスの再作成を実行すると、変更が有効になります。デフォルトを上書きせずに新しいカスタムマッピングを追加する必要がある場合は、代わりにadditionalTypeMappingsを使用してください。
マルチラインYAML設定
OSGiの設定ファイルを使って先程の設定を行った場合は、数行にわたるYAMLスニペットを書く必要がある場合もあります。シンタックスは各行にの最後に\n\を追加するのみです。
additionalConfigurations=\
cluster.routing.allocation.disk.threshold_enabled: false\n\
cluster.service.slow_task_logging_threshold: 600s\n\
index.indexing.slowlog.threshold.index.warn: 600s\n\
index.search.slowlog.threshold.fetch.warn: 600s\n\
index.search.slowlog.threshold.query.warn: 600s\n\
monitor.jvm.gc.old.warn: 600s\n\
monitor.jvm.gc.young.warn: 600s
単純な設定から既存の型マッピングの上書きまで、ElasticsearchとLiferayのElasticsearchへのコネクタで設定可能です。