HTTP 输出插件
编辑HTTP 输出插件
编辑- 插件版本:v5.7.1
- 发布日期:2024-11-18
- 变更日志
其他版本请参见 版本化插件文档。
获取帮助
编辑如有任何关于插件的问题,请在 Discuss 论坛中发帖提问。如发现错误或有功能需求,请在 Github 中提交 issue。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵。
描述
编辑此输出插件允许您将事件发送到通用的 HTTP(S) 端点。
此输出插件将并行执行多达 *pool_max* 个请求以提高性能。在为提高性能而调整此插件时,请考虑这一点。
此外,请注意,当使用并行执行时,无法保证事件的严格顺序!
请注意,此 gem 还不支持编解码器。目前请使用 *format* 选项。
重试策略
编辑此输出插件有两个级别的重试:库级别和插件级别。
库级别重试
编辑库级别重试适用于与 IO 相关的故障。不可重试的错误包括与 SSL 相关的故障、无法解析的主机、连接问题以及请求期间发生的 OS/JVM 级中断。
库级别重试的选项为:
-
automatic_retries
。控制插件在库级别发生故障后应重试的次数。 -
retry_non_idempotent
。设置为false
时,将重试 GET、HEAD、PUT、DELETE、OPTIONS 和 TRACE 请求。
插件级别重试
编辑插件级别重试的选项为:
-
retry_failed
。设置为true
时,插件将针对retryable_codes
选项中定义的 HTTP 错误响应代码 (429、500、502、503、504) 和可重试异常(套接字超时/错误、DNS 解析失败和客户端协议异常)无限期地重试。 -
retryable_codes
。设置触发重试的 HTTP 响应代码。
retry_failed
选项不控制库级别重试。
HTTP 输出配置选项
编辑此插件支持以下配置选项以及稍后介绍的 通用选项。
设置 | 输入类型 | 是否必需 |
---|---|---|
否 |
||
有效的系统文件路径 |
已弃用 |
|
有效的系统文件路径 |
已弃用 |
|
有效的系统文件路径 |
已弃用 |
|
否 |
||
否 |
||
否 |
||
否 |
||
字符串, |
否 |
|
否 |
||
否 |
||
字符串, |
是 |
|
否 |
||
否 |
||
有效的系统文件路径 |
已弃用 |
|
已弃用 |
||
已弃用 |
||
否 |
||
否 |
||
否 |
||
否 |
||
<<,>> |
否 |
|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
路径 列表 |
否 |
|
字符串 列表 |
否 |
|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
字符串, |
否 |
|
有效的系统文件路径 |
已弃用 |
|
已弃用 |
||
已弃用 |
||
是 |
||
否 |
另请参见 通用选项,了解所有输出插件支持的选项列表。
automatic_retries
编辑- 值类型为 数字
- 默认值为
1
客户端应重试失败的 URL 的次数。如果启用了 keepalive
选项,我们建议将此选项设置为非零值。某些服务器会错误地过早结束 keepalive,需要重试。有关详细信息,请参见 重试策略。
client_cert
编辑在 5.6.0 中已弃用。
已替换为 ssl_certificate
- 值类型为 路径
- 此设置没有默认值。
如果您要使用客户端证书(请注意,大多数人都不会使用此证书),请在此处设置 x509 证书的路径。
content_type
编辑- 值类型为 字符串
- 此设置没有默认值。
内容类型
如果未指定,则默认为:
- 如果 format 为 "json",则为 "application/json"
- 如果 format 为 "json_batch",则为 "application/json"。每个 Logstash 事件批次都将连接到单个数组中,并通过一个请求发送。
- 如果 format 为 "form",则为 "application/x-www-form-urlencoded"
format
编辑- 值可以是:
json
、json_batch
、form
、message
- 默认值为
"json"
设置 HTTP 主体的格式。
如果为 json_batch,则此输出接收到的每个事件批次都将被放入单个 JSON 数组中,并通过一个请求发送。这对于高吞吐量场景(例如在 Logstash 实例之间发送数据)特别有用。
如果为 form,则主体将是转换为查询参数字符串的映射(或整个事件),例如 foo=bar&baz=fizz...
如果为 message,则主体将是根据 message 格式化事件的结果。
否则,事件将作为 json 发送。
http_method
编辑- 这是一个必需的设置。
- 值可以是:
put
、post
、patch
、delete
、get
、head
- 此设置没有默认值。
HTTP 动词。“put”、“post”、“patch”、“delete”、“get”、“head” 之一
keepalive
编辑- 值类型为 布尔值
- 默认值为
true
启用此选项以启用 HTTP keepalive 支持。我们强烈建议为此设置 automatic_retries
为至少 1,以修复与损坏的 keepalive 实现的交互。
keystore
编辑在 5.6.0 中已弃用。
已替换为 ssl_keystore_path
- 值类型为 路径
- 此设置没有默认值。
如果您需要使用自定义密钥库(.jks
),请在此处指定。这与 .pem 密钥不兼容!
keystore_type
编辑在 5.6.0 中已弃用。
已替换为 ssl_keystore_type
- 值类型为 字符串
- 默认值为
"JKS"
在此处指定密钥库类型。JKS
或 PKCS12
之一。默认为 JKS
mapping
编辑- 值类型为 哈希表
- 此设置没有默认值。
这允许您选择要发送的事件的结构和部分。
例如
mapping => {"foo" => "%{host}" "bar" => "%{type}"}
proxy
编辑- 值类型为 字符串
- 此设置没有默认值。
如果您要使用 HTTP 代理。这支持多种配置语法。
- 代理主机格式:
http://proxy.org:1234
- 代理主机格式:
{host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
- 代理主机格式:
{url => 'http://proxy.org:1234', user => 'username@host', password => 'password'}
request_timeout
编辑- 值类型为 数字
- 默认值为
60
此模块基于[Manticore](https://github.com/cheald/manticore)简化了在Logstash中添加完全配置的HTTP客户端的过程。有关其用法的示例,请参阅https://github.com/logstash-plugins/logstash-input-http_poller整个请求的超时时间(以秒为单位)
retry_failed
编辑- 值类型为 布尔值
- 默认值为
true
请注意,此选项仅控制插件级别的重试。它对库级别的重试没有影响。
如果您想禁用对retryable_codes
中定义的HTTP错误响应代码或可重试异常(超时、SocketException、ClientProtocolException、ResolutionFailure和SocketTimeout)的无限重试,请将此选项设置为false
。有关更多信息,请参阅重试策略。
retry_non_idempotent
编辑- 值类型为 布尔值
- 默认值为
false
当此选项设置为false
且automatic_retries
启用时,将重试GET、HEAD、PUT、DELETE、OPTIONS和TRACE请求。
当设置为true
且automatic_retries
启用时,这将导致非幂等HTTP动词(如POST)被重试。有关更多信息,请参阅重试策略。
ssl_supported_protocols
编辑- 值类型为 字符串
- 允许的值为:
'TLSv1.1'
,'TLSv1.2'
,'TLSv1.3'
- 默认值取决于使用的JDK。对于最新的Logstash,默认值为
['TLSv1.2', 'TLSv1.3']
。'TLSv1.1'
不被认为是安全的,仅为旧版应用程序提供。
建立与HTTP端点连接时要使用的允许的SSL/TLS版本列表。
对于Java 8,'TLSv1.3'
仅从8u262(AdoptOpenJDK)开始支持,但需要在Logstash中设置LS_JAVA_OPTS="-Djdk.tls.client.protocols=TLSv1.3"
系统属性。
如果您将插件配置为在任何最近的JVM(例如Logstash打包的JVM)上使用'TLSv1.1'
,则该协议默认情况下是被禁用的,需要通过更改$JDK_HOME/conf/security/java.security配置文件中的jdk.tls.disabledAlgorithms
来手动启用。也就是说,需要从列表中删除TLSv1.1
。
ssl_verification_mode
编辑- 值类型为 字符串
- 支持的值为:
full
,none
- 默认值为
full
控制服务器证书的验证。full
选项验证提供的证书是由受信任的授权机构(CA)签名的,并且服务器的主机名(或IP地址)与证书中标识的名称匹配。
none
设置不执行服务器证书的验证。此模式禁用了SSL/TLS的许多安全优势,只有在仔细考虑后才能使用。它主要作为尝试解决TLS错误时的临时诊断机制。强烈建议不要在生产环境中使用none
。
常用选项
编辑所有输出插件都支持这些配置选项