PutSplunkHTTP Processor
描述
通过 HTTP 或 HTTPS 将FlowFile内容发送到指定的 Splunk 服务器。 支持 HEC 索引确认。
标签
属性
| 名称 | 默认值 | 可选值 | 描述 |
|---|---|---|---|
| Scheme | https |
| 连接到 Splunk 的方案。 |
| Hostname | localhost | Splunk 服务器的 IP 地址或主机名。 支持表达式语言:是(仅使用环境/系统变量求值) | |
| HTTP Event Collector Port | 8088 | HTTP 事件收集器 HTTP 端口号。 支持表达式语言:是(仅使用环境/系统变量求值) | |
| Security Protocol | TLSv1_2 |
| 用于与 Splunk 通信的安全协议。 |
| Owner | | 所有者传递给 Splunk。 支持表达式语言:是(仅使用环境/系统变量求值) | |
| HTTP Event Collector Token | | 以字符串 Splunk 开头的 HTTP 事件收集器令牌。 例如“Splunk 1234578-abcd-1234-abcd-1234abcd” 支持表达式语言:是(仅使用环境/系统变量求值) | |
| Username | | 用于向 Splunk 进行身份验证的用户名。 支持表达式语言:是(仅使用环境/系统变量求值) | |
| Password | | 用于向 Splunk 进行身份验证的密码。 敏感属性:是 | |
| Splunk Request Channel | | 所使用的请求通道的标识符。 支持表达式语言:是(仅使用环境/系统变量求值) | |
| Source | | 用户定义的事件源。 未指定时为所有事件设置默认值。 支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值) | |
| Source Type | | 用户定义的事件源类型。 未指定时为所有事件设置默认值。 支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值) | |
| Host | | 使用主机查询字符串参数指定。 未指定时为所有事件设置默认值。 支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值) | |
| Index | | 索引名称。 使用索引查询字符串参数指定。 未指定时为所有事件设置默认值。 支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值) | |
| Content Type | | 发送到 Splunk 的事件的媒体类型。如果未设置,将使用 "mime.type" FlowFile 属性。如果两者都未指定,则不会将此信息发送到服务器。 支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值) | |
| Character Set | UTF-8 | 字符集的名称。 支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值) |
关系 (Relationships)
| 名称 | 描述 | 自动终止 |
|---|---|---|
failure | 未能发送到目标的 FlowFile 将发送到此关系。 | 否 |
success | 成功发送到目标的 FlowFile 将发送到此关系。 | 否 |
读取的 FlowFile 属性
| 名称 | 描述 |
|---|---|
mime.type | 如果设置,则用作 HTTP Content-Type 头的值。 |
写入的 FlowFile 属性
| 名称 | 描述 |
|---|---|
splunk.acknowledgement.id | Splunk 提供的索引确认 ID。 |
splunk.responded.at | Splunk put请求的响应时间。 |
状态管理
该组件不存储状态。
受限 (Restricted)
该组件不受限。
输入要求
该组件要求有传入连接。
系统资源考量
| 资源 | 描述 |
|---|---|
| MEMORY | An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance. |
详细说明
PutSplunkHTTP
PutSplunkHTTP
该 Processor 是 PutSplunk Processor 的对应组件。后者使用 TCP 和 UDP 协议进行通信,而 PutSplunkHTTP 旨在通过 HTTP 或 HTTPS 把事件发送到 Splunk。从这个角度看,该 Processor 与 GetSplunk Processor 有相似之处,与 Splunk 服务器连接相关的 属性是相同的。不过,该 Processor 也有一些独特的方面:
内容详情
PutSplunkHTTP 允许用户指定发送给 Splunk 的事件的部分元数据, 包括用对应属性设置 FlowFile 内容的 "Character Set" 和 "Content Type"。如果传入 FlowFile 有 "mime.type" Attribute,Processor 会使用它;除非设置了 "Content Type" 属性,此时属性会覆盖 FlowFile Attribute。
事件参数
"Source"、"Source Type"、"Host" 和 "Index" 属性是可选的, 未指定时会由 Splunk 设置。如果指定了,默认值会被用户指定 的值覆盖。关于 Splunk API 的更多细节参见 本文档。
确认(Acknowledgement)
Splunk 的 HTTP Event Collector(HEC)提供了索引确认功能, 可用于监控单个事件的索引状态。PutSplunkHTTP 支持该功能, 会为输出 FlowFile 添加必要的信息,使下游 Processor 可以据此轮询状态。所需信息存储在 FlowFile Attribute "splunk.acknowledgement.id" 和 "splunk.responded.at" 中。
关于在 Lynxus 侧进行后续确认处理的步骤,参见 QuerySplunkIndexingStatus Processor。关于索引确认的 更多细节参见 本文档。
错误信息
为便于更精细的处理,在可能的情况下,FlowFile 会被添加 额外的信息。信息存储在 FlowFile Attribute "splunk.status.code" 或 "splunk.response.code" 中,具体取决于处理是否成功。 只要执行了 Splunk API 调用,"splunk.status.code" 就会被填充,包含响应的 HTTP 状态码。如果 FlowFile 被转移到 "failure" Relationship,根据 Splunk 响应码,"splunk.response.code" 也可能被填充。