Elasticsearchコネクターの設定リファレンス
ここでの設定情報は、Liferay Portal 7.2-7.4 CE および Liferay DXP 7.2-7.4、およびすべての四半期リリース用の Elasticsearch 6 および Elasticsearch 7 コネクタの最新バージョン(バンドルまたはマーケットプレイス経由)に適用されます。 必要に応じて、正確なGA/Service Pack/Fix PackおよびMarketplaceのバージョンに関する適切な情報が提供されます。
Elasticsearch 7 システム設定エントリと対応する構成ファイルは、Elasticsearch 8 への接続を構成するためにも使用されます。
Elasticsearch への接続は、主にシステム設定の Elasticsearch 6/7 構成エントリ (または 対応する構成ファイル経由) で定義されます。 Liferay 7.3、7.4、および四半期リリースでは、 ファクトリー構成 Elasticsearch 接続を通じて、Elasticsearch への複数の接続を定義できます。 両方のエントリは、 システム設定 または OSGi 構成ファイルを通じて構成できます。 本番環境では、設定ファイルを使用することをお勧めします。
設定ファイルとシステム設定項目
| サーバーの接続 | システム設定エントリー/コンフィグファイル |
|---|---|
| Liferay 7.2.x Elasticsearch 6.x | Elasticsearch 6com.liferay.portal.search.elasticsearch6.config.ElasticsearchConfiguration.config |
| Liferay 7.2.x Elasticsearch 7.x | Elasticsearch 7com.liferay.portal.search.elasticsearch7.config.ElasticsearchConfiguration.config |
| Liferay 7.3、7.4、四半期リリース Elasticsearch 7.x/8.x | Elasticsearch 7com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConfiguration.configElasticsearch Connections (factory) com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConnectionConfiguration-[connectionId].config |
Liferay 7.3以降では、Elasticsearch接続という接続設定項目が追加されています。 これを使用してElasticsearchへの任意の接続を定義することができますが、1つの接続のみを設定する場合は、メインのElasticsearch 7設定エントリを使用することができます。 複数の接続を使用する場合は、それに応じた名前を付けたファイルで接続を定義します。
com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConnectionConfiguration-[connectionId].config
Elasticsearch 6にセキュリティを設定する場合は、別途Liferayの設定(およびLESのサブスクリプション)が必要です。 詳細については、 Elasticsearch のセキュリティ保護 を参照してください。
設定ファイルを [Liferay_Home]/osgi/configs にデプロイし、リスナーが設定を自動検出してデータベースに書き込みます。
構成プロパティ
| システム設定 フィールド名 | 設定ファイルのシンタックスとデフォルト値 説明(クリックして展開) | 利用可能 |
|---|---|---|
| 一般的な接続設定 | ||
| 合計ヒット数を記録 | 有効にすると、検索の結果が 10,000 件を超える場合にヒット数が正確にカウントされます。 この機能を有効にしておくと、検索結果の件数が多い場合にパフォーマンスに影響を与えることがあります。 | Liferay 7.2+ (Connector to Elasticsearch 7) |
| 本番モードが有効 | プロダクションモードを有効にします。 Liferay 7.3では、 | Liferay 7.3、7.4、四半期リリース |
| 再インデックスが必要です インデックス名のプレフィックス | 検索インデックス名のプレフィックスとして使用する文字列値を設定します。 初期値は通常の状態では変更しないでください。 変更する場合は、ポータルの すべてのインデックスを再作成 操作も実行し、Elasticsearch 管理コンソールを使用して古いインデックスを手動で削除する必要があります。 | Liferay 7.2+ |
| 再インデックスが必要です 7.3.x→会社とシステムのインデックスレプリカの数 7.2.x→インデックスレプリカの数 | Liferay の会社とシステムインデックスごとにレプリカの数を設定します。 設定されていない場合は、レプリカを使用しません。 この値を変更するには、すべてのコンテンツの再インデックスが必要です。 デフォルト値は、コネクターに同梱されている "index-settings-defaults.json "というファイルに定義されています。 | Liferay 7.2+ |
| 再インデックスが必要です 7.3.x→会社とシステムのインデックスシャードの数 7.2.x→インデックスシャードの数 | Liferay の会社およびシステムインデックスの作成時に使用するシャードの数を設定します。 設定されていない場合は、1つのシャードが使用されます。 この値を変更するには、すべてのコンテンツの再インデックスが必要です。 デフォルト値は、コネクターに同梱されている "index-settings-defaults.json "というファイルに定義されています。 | Liferay 7.2+ |
| 結果の最大件数 | 検索クエリから返される結果の最大数を設定します。 | ライフレイ 7.4 U72/GA72+ |
| 例外のみロギングする | true の場合、Elasticsearch からの例外のみをログに記録し、例外を再スローしないブール設定。 | Liferay 7.2+ |
| コンフリクト時の再試行 | ドキュメントを取得してから更新するまでの間にドキュメントが更新されたためにバージョンの競合が発生した場合に試行する再試行回数の整数値を設定します (詳細については、 こちら を参照してください)。 | Liferay 7.1では使用されなくなりました。 |
| 最大接続数 | HTTP接続の最大数を設定します。 | ライフレイ 7.4 U67/GA67+ |
| ルートごとの最大接続数 | ルートあたりの HTTP 接続の最大数を設定します。 | ライフレイ 7.4 U67/GA67+ |
| セキュリティ設定 | ||
| 認証が有効 | ユーザー名とパスワードによる Elasticsearch への認証を有効または無効にします。 | Liferay 7.3、7.4、四半期リリース |
| ユーザー名 | 「認証の有効化」がチェックされている場合、Elasticsearch への認証に使用するユーザー名を設定します。 | Liferay 7.3、7.4、四半期リリース |
| パスワード | 「認証の有効化」がチェックされている場合は、Elasticsearch への認証に使用するパスワードを設定します。 | Liferay 7.3、7.4、四半期リリース |
| HTTP SSLが有効 | TLS/SSLを有効または無効にします。 | Liferay 7.3、7.4、四半期リリース |
| トラストストアの種類 | HTTP SSL が有効な場合は、トラストストアのタイプを設定します。 お使いの JDK バージョン でサポートされている 形式を選択します (例: | Liferay 7.3、7.4、四半期リリース |
| トラストストアのパス | HTTP SSL Enabled がチェックされている場合は、トラストストア ファイルへのパスを設定します。 | Liferay 7.3、7.4、四半期リリース |
| トラストストアのパスワード | HTTP SSL Enabled がチェックされている場合は、トラストストアのパスワードを設定します。 | Liferay 7.3、7.4、四半期リリース |
| Elasticsearch接続設定 | ||
| 有効 | 必要に応じて接続をアクティブ化または非アクティブ化します。 Elasticsearch 7の設定のRemote Cluster Connection IDの設定で選択されている場合は、接続を無効にしないでください。 | Liferay 7.3、7.4、四半期リリース |
| 接続ID | 接続に一意の ID を設定します。 アクティブな場合、この接続はElasticsearch 7構成のRemote Cluster Connection IDプロパティで選択できるようになります。 | Liferay 7.3、7.4、四半期リリース |
| レストクライアント設定 | ||
| ネットワークホストアドレス | Liferay からクライアント要求を送信するリモート HTTP ホストを設定します。 これは、REST クライアント接続を構成するため、Liferay 7.3、7.4、および四半期リリースで必須です。 リクエストは、 ラウンドロビンノード選択戦略を使用して REST クライアントによって分散されます。。 | Liferay 7.3、7.4、四半期リリース |
| Restクライアントのロガーレベル | DXP 7.3 U4+、DXP 7.4 GA1+、および Portal 7.4 GA5+ では廃止されました。 | Liferay 7.3、7.4、四半期リリース |
| トランスポートクライアント設定(埋め込み & リモート) | ||
| 動作モード | 選択できる操作モードは、EMBEDDED または REMOTE の 2 つです。 REMOTEに設定すると、リモートのスタンドアロンElasticsearchクラスタに接続します。 EMBEDDEDに設定すると、Liferayを内部のElasticsearchインスタンスで起動します。 EMBEDDEDの動作モードは、実運用環境ではサポートされておらず、「開発モード」の機能と考えられます。 | Liferay 7.2. Liferay 7.3で非推奨となり、 本番モードが有効に置き換えられました。 |
| クラスター名 | クラスター名は、Liferay 7.2 のトランスポートクライアントにのみ必要です。 統合するクラスタを宣言するためのString値を設定します。 Liferay 7.3、7.4、および四半期リリースでは、接続はRESTクライアントを通じて管理され、このプロパティは開発モードのときに埋め込みクラスターの名前を付けるためにのみ使用されます。 | Liferay 7.2- 7.3、7.4、四半期リリースでは開発モードに適用されます |
| トランスポート アドレス | 接続するリモート Elasticsearch ノードのアドレスの文字列値を設定します。 この値は、操作モードがリモートに設定されている場合に必要です (詳細については、 ここ を参照してください)。 任意の数のノードを指定することができます。 | Liferay 7.2 |
| クライアント・トランスポート・スニフ | このブール値を true に設定すると、クラスター スニッフィングが有効になり、クラスター内の使用可能なデータ ノードが動的に検出されます (詳細については、 こちら を参照してください)。 | Liferay 7.2 |
| クライアントのトランスポートは、クラスター名を無視します。 | このブール値を true に設定すると、接続されたノードのクラスター名検証が無視されます (詳細については、 こちら を参照してください)。 | Liferay 7.2 |
| クライアント・トランスポート・Ping タイムアウト | クライアントノードがノードからのping応答を待機する時間(秒単位)を設定します。 設定されていない場合は、デフォルトのElasticsearch | Liferay 7.2 |
| クライアント・トランスポート・ノード のサンプル間隔 | この文字列値を設定して、リストされ接続されているノードをサンプリング/pingする頻度をクライアントノードに指示します (詳細については、 こちら を参照してください)。 | Liferay DXP 7.2 |
| 他の設定 | ||
| リモートクラスター接続ID | リモート Elasticsearch クラスターへの接続用の接続 ID を選択します。 利用可能な接続は、「Elasticsearch Connections System Settings」エントリで定義されます。 この値が設定されていない場合は、Elasticsearch 7エントリの接続設定がリモートクラスタの接続に使用されます。 | Liferay 7.3、7.4、四半期リリースで LES クロスクラスタレプリケーションを使用する場合 |
| 開発モード設定(埋め込み & サイドカー) | ||
| 追加設定 | 埋め込み Elasticsearch のカスタム設定の文字列値を YML 形式で設定します。 参照: Liferay Elasticsearch コネクタの詳細設定。 | Liferay 7.2+ |
| Bootstrap Mlock All | ブール値設定。 | Liferay 7.2+ |
| 埋め込みHttpポート | この構成は EMBEDDED モードにのみ適用されます。 実行モードがEMBEDDEDモードに設定されている時に作成される、埋め込みのElasticsearchノードのHTTPポートを設定します。 | Liferay 7.2. Liferay 7.3.xでは非推奨となり、 Sidecar HTTP Portに置き換えられました。 |
| Httpが有効 | これにチェックを入れると、HTTP レイヤーが有効になります。 チェックされていない場合、RESTリクエストに直接対応することを意図していないノードでは、HTTPレイヤーが無効になります。 | Liferay 7.1.xで非推奨となりました。 |
| Http CORS 許可オリジン | HTTP CORS が有効な場合に許可する文字列オリジンを設定します (詳細については、 こちら を参照してください)。 | Liferay 7.2+ |
| Http CORS 設定 | HTTP CORS のカスタム設定の文字列値を YML 形式 ( | Liferay 7.2+ |
| Http CORSが有効 | クロスオリジンリソース共有を無効にするには、このブール値を false に設定します。 | Liferay 7.2+ |
| ネットワーク ホスト | この文字列値を設定して、ノードにこのホスト名または IP アドレスにバインドし、このホストをクラスター内の他のノードに公開 (アドバタイズ) するように指示します。 これは、バインド ホストと公開ホストを同時に設定するショートカットです (詳細については、 こちら を参照してください)。 | Liferay 7.2+ |
| ネットワークバインドホスト | ノードがバインドして着信要求をリッスンできるネットワーク インターフェイスの文字列値を設定します (詳細については、 こちら を参照してください)。 | Liferay 7.2+ |
| ネットワーク公開ホスト | ノードがクラスター内の他のノードにアドバタイズする単一のインターフェースの文字列値を設定します。これにより、それらのノードがそのインターフェースに接続できるようになります (詳細については、 こちら を参照してください)。 | Liferay 7.2+ |
| トランスポート Tcpポート | ノード間の通信にバインドするポートの文字列値を設定します。 単一の値または範囲を受け入れます (詳細については、 ここ を参照してください)。 | Liferay 7.2+ |
| Zenディスカバリー・ユニキャスト・ホストポート | | Liferay 7.2 |
| サイドカー設定 | ||
| ノード名 | 埋め込み Elasticsearch サーバーのノードに名前を付けます。 リモートのElasticsearchサーバーのノード名は、そのElasticsearch.ymlの | Liferay 7.3、7.4、四半期リリース |
| Sidecarデバッグ | サイドカープロセスのデバッグモードを有効にするには、これを true に設定します。 | Liferay 7.3、7.4、四半期リリース |
| Sidecarデバッグ設定 | サイドカープロセスのデバッグに使用する JVM オプションを設定します。 | Liferay 7.3、7.4、四半期リリース |
| Sidecarのハートビート監視間隔 | サイドカープロセスの健全性を検出するために使用されるハートビート間隔をミリ秒単位で設定します。 | Liferay 7.3、7.4、四半期リリース |
| Sidecarホーム | サイドカープロセスを開始するために使用するサイドカーベースフォルダーのパスを設定します。 | Liferay 7.3、7.4、四半期リリース |
| Sidecar HTTPポート | この設定は、サイドカー Elasticsearch を備えた Liferay 7.3 にのみ適用されます。 サイドカーのElasticsearchノードのHTTPポートレンジを設定します。 AUTOに設定すると、9201~9300番台のポートを自動的に検出します。 設定されていない場合は、Embedded HTTP portの値(デフォルトでは、 | Liferay 7.3、7.4、四半期リリース |
| Sidecar JVMオプション | サイドカープロセスで使用される JVM オプションを設定します。 | Liferay 7.3、7.4、四半期リリース |
| Sidecarのシャットダウンタイムアウト | サイドカープロセスが強制的にシャットダウンされるまでの待機時間をミリ秒単位で設定します。 | Liferay 7.3、7.4、四半期リリース |
| 詳細設定 | ||
| 再インデックスが必要です 追加のインデックス構成 | Liferayインデックスのカスタム設定の文字列値をJSONまたはYML形式で設定します(詳細については、Elasticsearch Create Index APIを参照してください)。 参照: Liferay Elasticsearch コネクタの詳細設定。 | Liferay 7.2+ |
| 再インデックスが必要です 追加の型マッピング | | Liferay 7.2+ |
| 再インデックスが必要です 型マッピングを上書きします | ここでの設定は、Liferay のデフォルトのタイプマッピングを上書きします。 これは高度な機能であり、厳密に必要な場合にのみ使用する必要があります。 この値を設定すると、Liferay のソースコード内のデフォルトのマッピング(たとえば、 | Liferay 7.2+ |
| プロキシホスト | クライアント接続のプロキシホストを設定します。 | Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7 |
| プロキシポート | クライアント接続のプロキシ ポートを設定します。 | Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7 |
| プロキシユーザー名 | プロキシ接続のプロキシユーザー名を設定します。 | Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7 |
| プロキシパスワード | プロキシに接続するためのパスワードを設定します。 | Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7 |