Documentation

Elasticsearchコネクターの設定リファレンス

ここに記載されている設定情報は、Liferay Portal 7.2-7.4 CEおよびLiferay DXP 7.2-7.4用のElasticsearch 6およびElasticsearch 7コネクタの最新の入手可能なバージョン(バンドル版またはMarketplace経由)に適用されます。 必要に応じて、正確なGA/Service Pack/Fix PackおよびMarketplaceのバージョンに関する適切な情報が提供されます。

Elasticsearchへの接続は、システム設定(または 対応する構成ファイル 介して)の Elasticsearch 6/7 の設定エントリーで主に定義されます。 Liferay 7.3+では、 ファクトリー設定Elasticsearch接続 により、Elasticsearchへの複数の接続を定義することができます 。 両方のエントリーは システム設定 または のOSGi構成ファイルで設定可能です。 本番環境では、設定ファイルを使用することをお勧めします。

設定ファイルとシステム設定項目

サーバーの接続

システム設定エントリー/コンフィグファイル

Liferay 7.2.x
Elasticsearch 6.x

Elasticsearch 6
com.liferay.portal.search.elasticsearch6.config.ElasticsearchConfiguration.config

Liferay 7.2.x
Elasticsearch 7.x

Elasticsearch 7
com.liferay.portal.search.elasticsearch7.config.ElasticsearchConfiguration.config

Liferay 7.3+
Elasticsearch 7.x

Elasticsearch 7
com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConfiguration.config

Elasticsearch Connections (factory)
com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConnectionConfiguration-[connectionId].config

Liferay 7.3以降では、Elasticsearch接続という接続設定項目が追加されています。 これを使用してElasticsearchへの任意の接続を定義することができますが、1つの接続のみを設定する場合は、メインのElasticsearch 7設定エントリを使用することができます。 7.3で複数の接続を使用する場合は、それに応じたファイル名で接続を定義します。

com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConnectionConfiguration-[connectionId].config

Elasticsearch 6にセキュリティを設定する場合は、別途Liferayの設定(およびLESのサブスクリプション)が必要です。 詳しくは、Elasticsearchの保護を参照してください。

設定ファイルを [Liferay_Home]/osgi/configs にデプロイし、リスナーが設定を自動検出してデータベースに書き込みます。

構成プロパティ

システム設定 フィールド名

設定ファイルのシンタックスとデフォルト値
説明(クリックして展開)

利用可能

一般的な接続設定

合計ヒット数を記録

trackTotalHits=B "true"有効にすると、検索結果が10,000件以上になったときにヒット数が正確にカウントされます。 この機能を有効にしておくと、検索結果の件数が多い場合にパフォーマンスに影響を与えることがあります。

Liferay 7.2+
(Connector to Elasticsearch 7)

本番モードが有効

productionModeEnabled=B "false"プロダクションモードを有効にします。 Liferay 7.3では、 productionModeEnabled が、非推奨の設定である operationModeを置き換えています。 これをチェックすると、プロダクションモードが有効になり、Operation Modeの設定は無視されます。 本番モードを有効にするには、リモートのスタンドアロンElasticsearchクラスタに接続する必要があります。 無効のままだと動作モードの設定が使用されます。

Liferay 7.3+

インデックス名接頭辞

indexNamePrefix="liferay-"検索インデックス名のプレフィックスとして使用するString値を設定します。 初期値は通常の状態では変更しないでください。 変更した場合は、ポータルに対して re-index all の操作も行い、その後Elasticsearch管理コンソールを使って古いインデックスを手動で削除する必要があります。

Liferay 7.2+

7.3.x→Number of Company and System Index Replicas
7.2.x→Index Number of Replicas

indexNumberOfReplicas="0-all"Liferayの会社やシステムのインデックスごとにレプリカの数を設定します。 設定されていない場合は、レプリカを使用しません。 この値を変更するには、完全な再インデックスが必要です。 デフォルト値は、コネクターに同梱されている "index-settings-defaults.json "というファイルに定義されています。

Liferay 7.2+

7.3.x→Number of Company and System Index Shards
7.2.x→Index Number of Shards

indexNumberOfShards="1"Liferayの会社やシステムのインデックスが作成されるときに使用するシャードの数を設定します。 設定されていない場合は、1つのシャードが使用されます。 この値を変更するには、完全な再インデックスが必要です。 デフォルト値は、コネクターに同梱されている "index-settings-defaults.json "というファイルに定義されています。

Liferay 7.2+

例外のみロギングする

logExceptionsOnly=B "true"trueの場合、Elasticsearchからの例外をログにのみ記録し、再スローしないようにするブール値の設定です。

Liferay 7.2+

コンフリクト時の再試行

retryOnConflict="5"ドキュメントを取得してから更新するまでの間に更新されたためにバージョンの競合が発生した場合に、再試行する回数を整数値で設定します(詳細は here を参照)。

Liferay 7.1では使用されなくなりました。

セキュリティ設定

認証が有効

authenticationEnabled=B "false"ユーザー名とパスワードによるElasticsearchへの認証を有効または無効にします。

Liferay 7.3+

ユーザー名

username="elastic"認証が有効がチェックされている場合に、Elasticsearchを認証するためのユーザー名を設定します。

Liferay 7.3+

パスワード

password=""認証が有効がチェックされている場合、Elasticsearchを認証するためのパスワードを設定します。

Liferay 7.3+

HTTP SSLが有効

httpSSLEnabled="false"TLS/SSLを有効にするかどうかを設定します。

Liferay 7.3+

トラストストアの種類

truststoreType="pkcs12"「HTTP SSL Enabled」がチェックされている場合に、トラストストアの種類を設定します。

Liferay 7.3+

トラストストアのパス

truststorePath="/path/to/localhost.p12"HTTP SSL が有効がチェックされている場合、トラストストアファイルのパスを設定します。

Liferay 7.3+

トラストストアのパスワード

truststorePassword=""HTTP SSLが有効がチェックされている場合、トラストストアのパスワードを設定します。

Liferay 7.3+

Elasticsearch接続設定

有効

active=B "false"必要に応じて、接続を有効化または無効化します。 Elasticsearch 7の設定のRemote Cluster Connection IDの設定で選択されている場合は、接続を無効にしないでください。

Liferay 7.3+

接続ID

connectionId=""接続のためのユニークなIDを設定します。 アクティブな場合、この接続はElasticsearch 7構成のRemote Cluster Connection IDプロパティで選択できるようになります。

Liferay 7.3+

レストクライアント設定

ネットワークホストアドレス

networkHostAddresses="[http://localhost:9200]"接続先のリモートHTTPホストを設定します。 これは、Liferay 7.3ではRESTクライアントの接続を構成するために必要です。

Liferay 7.3+

Restクライアントのロガーレベル

RESTClientLoggerLevel="ERROR"Elasticsearch RESTクライアントのロギングレベルを設定します。

Liferay 7.3+

トランスポートクライアントの設定(組み込み

動作モード

operationMode="EMBEDDED"操作モードは「EMBEDDED」と「REMOTE」の2種類から選択できます。 REMOTEに設定すると、リモートのスタンドアロンElasticsearchクラスタに接続します。 EMBEDDEDに設定すると、Liferayを内部のElasticsearchインスタンスで起動します。 EMBEDDEDの動作モードは、実運用環境ではサポートされておらず、「開発モード」の機能と考えられます。

Liferay 7.2. Liferay 7.3で非推奨となり、 本番モードが有効 に置き換えられました。

クラスター名

clusterName="LiferayElasticsearchCluster"クラスタ名はLiferay 7.2のTransport Clientでのみ必要です。 統合するクラスタを宣言するためのString値を設定します。 接続がRESTクライアントを通じて管理されるLiferay 7.3では、このプロパティは開発モードのときに埋め込みクラスタの名前を付けるためにのみ使用されます。

Liferay 7.2-
7.3では、開発モードに適用されます。

トランスポート アドレス

transportAddresses=["localhost:9300"]接続するリモートのElasticsearchノードのアドレスをString値で設定します。 この値は動作モードがリモートに設定されている場合に必要です(詳しくは here を参照)。 任意の数のノードを指定することができます。

Liferay 7.2

クライアント・トランスポート・スニフ

clientTransportSniff=B "true"このブール値を true に設定すると、クラスタのスニッフィングが有効になり、クラスタで利用できるデータ ノードを動的に検出できます(詳細については here を参照)。

Liferay 7.2

クラスタトランスポートはクラスタ名を無視する

clientTransportIgnoreClusterName=B "false"このブール値を true に設定すると、接続ノードのクラスタ名検証を無視します(詳細は here を参照してください)。

Liferay 7.2

クライアント・トランスポート・Ping タイムアウト

clientTransportPingTimeout=""クライアントノードがノードからのPing応答を待つ時間(秒単位)を設定します。 未設定の場合、デフォルトのElasticsearchの client.transport.ping_timeout が使用されます。

Liferay 7.2

クライアント・トランスポート・ノード のサンプル間隔

clientTransportNodesSamplerInterval=""このString値を設定すると、クライアントノードに対して、リストされて接続されているノードのサンプル/pingの頻度を指示します(詳細は here を参照してください)。

Liferay 7.2

他の設定

リモートクラスター接続ID

remoteClusterConnectionId=リモートのElasticsearchクラスタへの接続のための接続IDを選択します。 利用可能な接続は、「Elasticsearch Connections System Settings」エントリで定義されます。 この値が設定されていない場合は、Elasticsearch 7エントリの接続設定がリモートクラスタの接続に使用されます。

Liferay 7.3で LES Cross-Cluster Replicationを使用する場合。

開発モード設定(組み込みおよびサイドカー)

追加設定

additionalConfigurations=""Embedded モードのElasticsearchのカスタム設定用のString値をYML形式で設定します。 Liferay Elasticsearchコネクターの詳細設定 をご覧ください。

Liferay 7.2+

Bootstrap Mlock All

bootstrapMlockAll="false"trueに設定すると、プロセスのアドレス空間をRAMにロックしようとし、Elasticsearchメモリがスワップアウトされないようにするブール値の設定(詳細は here ) を参照)。

Liferay 7.2+

埋め込みHttpポート

embeddedHttpPort="9201"この設定は、EMBEDDEDモードにのみ適用されます。 実行モードがEMBEDDEDモードに設定されている時に作成される、埋め込みのElasticsearchノードのHTTPポートを設定します。

Liferay 7.2. Liferay 7.3.xでは非推奨となり、 Sidecar HTTP Port に置き換えられました。

Httpが有効

httpEnabled=B "true"これをチェックすると、HTTPレイヤーが有効になります。 チェックされていない場合、RESTリクエストに直接対応することを意図していないノードでは、HTTPレイヤーが無効になります。

Liferay 7.1.xで非推奨となりました。

Http CORS 許可オリジン

httpCORSAllowOrigin="/https?:\/webapps/localhost(:[0-9])?/"HTTP CORSが有効な場合に許可するString originsを設定します(詳細については、 here を参照してください)。

Liferay 7.2+

Http CORS 設定

httpCORSConfigurations=HTTP CORSのカスタム設定のString値をYML形式(elasticsearch.yml)で設定します(詳細は here 参照)。

Liferay 7.2+

Http CORSが有効

httpCORSEnabled=B "true"クロスオリジンのリソース共有を無効にするには、このブール値を false に設定します。 falseに設定すると、他のオリジンのブラウザはElasticsearchへのリクエストを行うことができません。 Elasticsearch HeadなどのWebフロントエンドツールが接続できない場合があります(詳しくは here をご覧ください)。

Liferay 7.2+

ネットワーク ホスト

networkHost=""ノードがこのホスト名またはIPアドレスにバインドし、クラスタ内の他のノードにこのホストを公開(アドバタイズ)するよう指示するには、このString値を設定します。 これは、バインドホストと公開ホストを同時に設定するショートカットです(詳しくは here をご覧ください)。

Liferay 7.2+

ネットワークバインドホスト

networkBindHost=""受信要求をリッスンするためにノードがバインドすべきネットワークインターフェースのString値を設定します (詳細は here を参照してください)。

Liferay 7.2+

ネットワーク公開ホスト

networkPublishHost=""ノードがクラスタの他のノードに広告する、単一のインターフェイスの String 値を設定し、それらのノードがノードに接続できるようにします(詳細は here を参照して下さい)。

Liferay 7.2+

トランスポート Tcpポート

transportTcpPort=""ノード間の通信にバインドするポートのString値を設定します。 単一の値または範囲を指定します(詳細は here を参照)。

Liferay 7.2+

Zenディスカバリー・ユニキャスト・ホストポート

discoveryZenPingUnicastHostsPort="9300-9400" discovery.zen.ping.unicast.hosts`の値を構築する際に使用するポートの範囲をString値で設定. ポートの範囲にある複数のElasticsearchノードは、同じコンピュータでゴシップルータとして動作することができます(詳しくは here をご覧ください)。 7.3で廃止、直接の置き換えなし.

Liferay 7.2

サイドカー設定

ノード名

nodeName=埋め込まれたElasticsearchサーバーのノードの名前を指定します。 リモートのElasticsearchサーバーのノード名は、そのelasticsearch.ymlで設定されます。

Liferay 7.3+

Sidecarデバッグ

sidecarDebug=B "false"sidecarプロセスのデバッグモードを有効にするには、これをtrueに設定します。

Liferay 7.3+

Sidecarデバッグ設定

sidecarDebugSettings="-agentlib:jdwp=transport=dt_socket,address=8001,server=y,suspend=y,quiet=y"sidecarプロセスのデバッグに使用するJVMオプションを設定します。

Liferay 7.3+

Sidecarのハートビート監視間隔

sidecarHeartbeatInterval="10000"sidecarプロセスの健全性を検知するためのハートビート間隔をミリ秒単位で設定します。

Liferay 7.3+

Sidecarホーム

sidecarHome="elasticsearch7"sidecarプロセスの開始に使用するsidecarベースフォルダのパスを設定します。

Liferay DXP 7.3+

Sidecar HTTPポート

sidecarHttpPort="9200"この設定はLiferay 7.3でサイドカーにElasticsearchを使用している場合のみ適用されます。 サイドカーのElasticsearchノードのHTTPポートレンジを設定します。 AUTOに設定すると、9201~9300番台のポートを自動的に検出します。 設定されていない場合は、埋め込みHttpポートの値(デフォルトでは、9201 )が使用されます。

Liferay DXP 7.3+

Sidecar JVMオプション

sidecarJVMOptions="-Xms1g|-Xmx1g|-XX: AlwaysPreTouch"sidecarプロセスが使用するJVMオプションを設定します。

Liferay DXP 7.3+

Sidecarのシャットダウンタイムアウト

sidecarShutdownTimeout="10000"sidecarプロセスが強制的にシャットダウンされるまでの時間をミリ秒単位で設定します。

Liferay DXP 7.3+

詳細設定

追加インデックス設定

additionalIndexConfigurations=""Liferayインデックスのカスタム設定のためのString値を、JSONまたはYML形式で設定します(詳細はElasticsearch Create Index APIを参照してください)。 Liferay Elasticsearchコネクターの詳細設定 をご覧ください。

Liferay 7.2+

追加タイプマッピング

additionalTypeMappings=""LiferayDocumentType のカスタムマッピング用の String 値を JSON 形式で設定します(詳細は Elasticsearch Put Mapping API を参照してください) 参照してください。)Liferay Elasticsearch Connector の詳細設定 を参照してください。

Liferay 7.2+

タイプマッピングを上書き

overrideTypeMappings=""ここでの設定は、Liferayのデフォルトのタイプマッピングをオーバーライドします。 これは高度な機能であり、厳密に必要な場合にのみ使用する必要があります。 この値を設定すると、LiferayソースコードでLiferayドキュメントタイプを定義するために使用されるデフォルトマッピング(例えば、liferay-type-mappings.json)は完全に無視されますので、修正するセグメントだけでなく、マッピング定義全体をこのプロパティに含めてください。

Liferay 7.2+

プロキシホスト

proxyHost=""クライアント接続用のプロキシホストを設定します。

Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7

プロキシポート

proxyPort="0"クライアント接続用のプロキシポートを設定します。

Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7

プロキシユーザー名

proxyUserName=""プロキシ接続時のプロキシユーザー名を設定します。

Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7

プロキシパスワード

proxyPassword=""プロキシに接続するためのパスワードを設定します。

Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7