ElasticSearchClientServiceImpl¶
説明¶
Elasticsearch (low-level) REST クライアントを使用して Elasticsearch クライアントにアクセスするためのController Serviceです。
プロパティ¶
以下のリストでは、必要なプロパティをアスタリスク (*) で表示しています。その他のプロパティはオプションと見なされます。この表は、任意のデフォルト値と、そのプロパティが NiFi 式言語に対応しているかどうかも示します。
表示名 |
API 名前 |
デフォルト値 |
許容値 |
説明 |
|---|---|---|---|---|
API キー * |
api-key |
暗号化された API キー。 |
||
API キー ID * |
api-key-id |
API キーの一意の識別子。 |
||
認証スキーム * |
authorization-scheme |
BASIC |
|
Elasticsearch に対する任意の認証スキームです。 |
文字セット * |
el-cs-charset |
UTF-8 |
Elasticsearch からのレスポンスを解釈する際に使用する文字コード。 |
|
接続タイムアウト * |
el-cs-connect-timeout |
5000 |
接続時にタイムアウトが発生するまでの時間をミリ秒単位で制御します。 |
|
圧縮の有効化 * |
el-cs-enable-compression |
false |
|
REST クライアントはリクエストを gzip コンテントエンコーディングを使って圧縮し、 圧縮されたレスポンスを受け取るために "Accept-Encoding: gzip" ヘッダーを追加すべきかどうか。 |
HTTP ホスト * |
el-cs-http-hosts |
Elasticsearch クエリノードをホストしている HTTP ホストのカンマ区切りのリストです。 HTTP Hosts は、各エントリのプロトコル、ドメイン、ポートを含む有効な URIs である必要があります。例えば、"https://elasticsearch1:9200, https://elasticsearch2:9200 "のようになります。Host はリクエストにヘッダーとして含まれることに注意してください (通常、ドメインとポートを含みます。例えば、elasticsearch:9200 など)。 |
||
ノードセレクター * |
el-cs-node-selector |
ANY |
|
リクエストを受信できる Elasticsearch ノードを選択します。リクエストを Elasticsearch のマスターノードから遠ざけるために使用します。 |
OAuth2 アクセス トークン プロバイダー * |
el-cs-oauth2-token-provider |
OAuth2 Elasticsearch でベアラー・トークンの認証に JWTs を提供するためのアクセストークンプロバイダーです。 |
||
パスワード * |
el-cs-password |
XPack セキュリティで使用するパスワード。 |
||
パス プレフィックス |
el-cs-path-prefix |
http クライアントが使用するすべてのリクエストのパスのプレフィックスを セットします。例えば、これを "/my/path" にセットすると、クライアントのリクエストはすべて "/my/path/" + エンドポイントとなります。要するに、すべてのリクエストのエンドポイントはこの pathPrefix でプレフィックスされます。このプレフィックスは、Elasticsearch がベースパスを提供するプロキシや、すべてのパスが '/' で始まることを要求するプロキシの背後にある場合に有用です。他の目的に向けるのではなく、他のシナリオで供給されるべきではありません。 |
||
ユーザーとして実行 |
el-cs-run-as-user |
Elasticsearch 内でなりすますユーザー名。 |
||
メタヘッダーの送信 * |
el-cs-send-meta-header |
true |
|
ランタイム環境を記述する「X-Elastic-Client-Meta」ヘッダーを送信するかどうか。ユーザーエージェント (User-Agent) にあるような情報がコンテナーに含まれています。別個のヘッダーを使うことで、アプリケーションはUser-Agentを、アプリケーションのバージョンやその他の環境情報を識別するためなど、アプリケーション自身の必要に応じて使うことができます。 |
クラスタノードのスニッフィング * |
el-cs-sniff-cluster-nodes |
false |
|
Elasticsearch Node Info API を介して Elasticsearch クラスター内のノードを定期的にスニッフします。Elasticsearch のセキュリティ機能が有効になっている場合（8.x+ のデフォルトは "true"）、Elasticsearch ユーザーがこの API を使用するためには、"monitor "または "manage "クラスタ権限を持っている必要があります HTTP すべてのホスト（および Sniffer を使用してクラスター内で発見される可能性のあるホスト）は、http または https など同じプロトコルを使用し、同じクライアント設定を使用して連絡先が特定できる必要があります。最後に、Elasticsearchの「network.publish_host」は「network.bind_host」リストエントリのいずれかと一致しなければなりません。詳細はhttps://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.htmlをご参照ください。 |
失敗をスニッフィングする * |
el-cs-sniff-failure |
false |
|
失敗時のスニッフィングを有効にすることで、Elasticsearchのノードリストは、次の通常のスニッフィングの回を待たずに、失敗のたびにすぐに更新されます。 |
スニファーの失敗遅延 * |
el-cs-sniffer-failure-delay |
1分 |
Elasticsearch リクエストが失敗してから Sniffer を使って可用性クラスタノードを更新するまでの遅延 |
|
スニファー間隔 * |
el-cs-sniffer-interval |
5分 |
クラスター・スニッファーの動作間隔 |
|
スニファー・リクエスト・タイムアウト * |
el-cs-sniffer-request-timeout |
1秒 |
ノード情報リクエストのクラスター スニファー タイムアウト |
|
読み取りタイムアウト * |
el-cs-socket-timeout |
60000 |
応答待ちでタイムアウトが発生するまでの時間をミリ秒単位で制御します。 |
|
SSL コンテキストサービス |
el-cs-ssl-context-service |
TLS/SSL 接続のクライアント証明書情報を提供するために使用される SSL コンテキストサービス。このサービスは、Elasticsearch のエンドポイントが TLS/SSL でセキュリティ保護されている場合にのみ適用されます。 |
||
厳格な非推奨 * |
el-cs-strict-deprecation |
false |
|
REST クライアントは、少なくとも一つの警告ヘッダーを含むいかなるレスポンスも失敗として返すべきかどうか。 |
null値/空値の抑制 * |
el-cs-suppress-nulls |
always-suppress |
|
ライタが null や空のフィールド (オブジェクトや配列を含む) をどのように扱うかを指定します。 |
ユーザー名 * |
el-cs-username |
XPack セキュリティで使用するユーザー名。 |
||
JWT 共有・シークレット * |
jwt-shared-secret |
JWT realm・共有・シークレット |
||
プロキシ構成サービス |
proxy-configuration-service |
ネットワークリクエストをプロキシするプロキシ構成Controller Serviceを指定します。 |
状態管理¶
このコンポーネントは状態を保存しません。
制限あり¶
このコンポーネントには制限はありません。
システムリソースに関する考察¶
このコンポーネントは、システムリソースを考慮したものではありません。