ElasticSearchClientServiceImpl¶

描述¶

一款用于访问 Elasticsearch 客户端的控制器服务，使用的是 Elasticsearch（低级）REST 客户端。

标签¶

client、elasticsearch、elasticsearch6、elasticsearch7、elasticsearch8

属性¶

下表列出了各项属性，其中带星号 (*) 的为必需属性。其他属性视为可选属性。该表还指出了所有默认值以及属性是否支持 NiFi 表达式语言。

显示名称	API 名称	默认值	允许值	描述
API 密钥 *	api-key			经过编码的 API 密钥。
API 密钥 ID *	api-key-id			API 密钥的唯一标识符。
授权架构 *	authorization-scheme	BASIC	无 PKI Basic API 密钥 JWT	用于对 Elasticsearch 进行可选身份验证的授权架构。
字符集 *	el-cs-charset	UTF-8		用于解释来自 Elasticsearch 的响应的字符集。
连接超时 *	el-cs-connect-timeout	5000		控制尝试连接时发生超时前的等待时间（以毫秒为单位）。
启用压缩 *	el-cs-enable-compression	false	true false	是否应让 REST 客户端使用 gzip 内容编码压缩请求，并添加“Accept-Encoding: gzip”标头以接收压缩响应。
HTTP 主机 *	el-cs-http-hosts			逗号分隔的 HTTP 主机列表，这些主机承载 Elasticsearch 查询节点。HTTP 主机应为有效的 URIs，包括每个条目的协议、域名和端口，例如“https://elasticsearch1:9200 (https://elasticsearch1:9200), https://elasticsearch2:9200 (https://elasticsearch2:9200)”。请注意，主机作为标头包含在请求中（通常包括域名和端口，例如 elasticsearch:9200）。
节点选择器 *	el-cs-node-selector	ANY	任意跳过专用主节点	选择可以接收请求的 Elasticsearch 节点。用于使请求远离专用 Elasticsearch 主节点
OAuth2 访问令牌提供程序 *	el-cs-oauth2-token-provider			用于为 Elasticsearch 的 Bearer 令牌授权提供 JWTs 的 OAuth2 访问令牌提供商。
密码 *	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	true false	是否发送用于描述运行时环境的“X-Elastic-Client-Meta”标头。它包含的信息与 User-Agent 中的信息类似。使用单独的标头允许应用程序使用 User-Agent 来满足自己的需求，例如识别应用程序版本或其他环境信息
嗅探集群节点 *	el-cs-sniff-cluster-nodes	false	true false	通过 Elasticsearch 节点信息 API 定期嗅探 Elasticsearch 集群中的节点。如果已启用 Elasticsearch 安全功能（8.x 及以上版本默认为“true”），则 Elasticsearch 用户必须具有“监控”或“管理”集群权限才能使用此 API。请注意，所有 HTTP 主机（以及可能使用嗅探器在集群内发现的主机）必须使用相同协议（如 http 或 https），并且可以使用相同的客户端设置进行联系。最后，Elasticsearch 的“network.publish_host”必须与“network.bind_host”列表条目之一相匹配，请参阅 https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.html (https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.html) 了解更多信息
失败时嗅探 *	el-cs-sniff-failure	false	true false	失败时启用嗅探，这意味着每次失败后，Elasticsearch 节点列表都会立即更新，而不是在下一次常规嗅探周期时更新
嗅探器失败延迟 *	el-cs-sniffer-failure-delay	1 分钟		从 Elasticsearch 请求失败到使用嗅探器更新可用集群节点之间的延迟
嗅探器间隔 *	el-cs-sniffer-interval	5 分钟		集群嗅探器操作之间的间隔
嗅探器请求超时 *	el-cs-sniffer-request-timeout	1 秒		用于节点信息请求的集群嗅探器超时。
读取超时 *	el-cs-socket-timeout	60000		控制等待响应时发生超时前的时间（以毫秒为单位）。
SSL Context Service	el-cs-ssl-context-service			用于为 TLS/SSL 连接提供客户端证书信息的 SSL Context Service。仅当使用 TLS/SSL 保护 Elasticsearch 端点时，此服务才适用。
严格弃用 *	el-cs-strict-deprecation	false	true false	REST 客户端是否应将包含至少一个警告标头的任意响应作为失败返回
抑制 Null/空值 *	el-cs-suppress-nulls	always-suppress	永不抑制始终抑制	指定写入器应如何处理 null 和空字段（包括对象和数组）
用户名 *	el-cs-username			用于 XPack 安全认证的用户名。
JWT 共享密钥 *	jwt-shared-secret			JWT 领域共享密钥。
代理配置服务	proxy-configuration-service			指定代理配置控制器服务来代理网络请求。

状态管理¶

此组件不存储状态。

受限¶

此组件不受限制。

系统资源注意事项¶

此组件未指定系统资源注意事项。