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

数字

cacert

有效的系统文件路径

已弃用

client_cert

有效的系统文件路径

已弃用

client_key

有效的系统文件路径

已弃用

connect_timeout

数字

content_type

字符串

cookies

布尔值

follow_redirects

布尔值

format

字符串["json", "json_batch", "form", "message"] 之一

headers

哈希表

http_compression

布尔值

http_method

字符串["put", "post", "patch", "delete", "get", "head"] 之一

ignorable_codes

数字

keepalive

布尔值

keystore

有效的系统文件路径

已弃用

keystore_password

密码

已弃用

keystore_type

字符串

已弃用

mapping

哈希表

message

字符串

pool_max

数字

pool_max_per_route

数字

proxy

<<,>>

request_timeout

数字

retry_failed

布尔值

retry_non_idempotent

布尔值

retryable_codes

数字

socket_timeout

数字

ssl_certificate

路径

ssl_certificate_authorities

路径 列表

ssl_cipher_suites

字符串 列表

ssl_enabled

布尔值

ssl_keystore_password

密码

ssl_keystore_path

路径

ssl_keystore_type

字符串

ssl_supported_protocols

字符串

ssl_truststore_password

密码

ssl_truststore_path

路径

ssl_truststore_type

字符串

ssl_verification_mode

字符串["full", "none"] 之一

truststore

有效的系统文件路径

已弃用

truststore_password

密码

已弃用

truststore_type

字符串

已弃用

url

字符串

validate_after_inactivity

数字

另请参见 通用选项,了解所有输出插件支持的选项列表。

 

automatic_retries

编辑
  • 值类型为 数字
  • 默认值为 1

客户端应重试失败的 URL 的次数。如果启用了 keepalive 选项,我们建议将此选项设置为非零值。某些服务器会错误地过早结束 keepalive,需要重试。有关详细信息,请参见 重试策略

cacert

编辑

在 5.6.0 中已弃用。

已替换为 ssl_certificate_authorities

  • 值类型为 路径
  • 此设置没有默认值。

如果您需要使用自定义 X.509 CA(.pem 证书),请在此处指定其路径。

client_cert

编辑

在 5.6.0 中已弃用。

已替换为 ssl_certificate

  • 值类型为 路径
  • 此设置没有默认值。

如果您要使用客户端证书(请注意,大多数人都不会使用此证书),请在此处设置 x509 证书的路径。

client_key

编辑

在 5.6.0 中已弃用。

已替换为 ssl_key

  • 值类型为 路径
  • 此设置没有默认值。

如果您使用客户端证书,请在此处指定加密密钥的路径。

connect_timeout

编辑
  • 值类型为 数字
  • 默认值为 10

等待建立连接的超时时间(以秒为单位)。默认为 10s

content_type

编辑
  • 值类型为 字符串
  • 此设置没有默认值。

内容类型

如果未指定,则默认为:

  • 如果 format 为 "json",则为 "application/json"
  • 如果 format 为 "json_batch",则为 "application/json"。每个 Logstash 事件批次都将连接到单个数组中,并通过一个请求发送。
  • 如果 format 为 "form",则为 "application/x-www-form-urlencoded"

cookies

编辑

启用 Cookie 支持。启用此选项后,客户端将像普通的 Web 浏览器一样在请求之间持久保存 Cookie。默认情况下启用。

follow_redirects

编辑

是否应跟踪重定向?默认为 true

format

编辑
  • 值可以是:jsonjson_batchformmessage
  • 默认值为 "json"

设置 HTTP 主体的格式。

如果为 json_batch,则此输出接收到的每个事件批次都将被放入单个 JSON 数组中,并通过一个请求发送。这对于高吞吐量场景(例如在 Logstash 实例之间发送数据)特别有用。

如果为 form,则主体将是转换为查询参数字符串的映射(或整个事件),例如 foo=bar&baz=fizz...

如果为 message,则主体将是根据 message 格式化事件的结果。

否则,事件将作为 json 发送。

headers

编辑
  • 值类型为 哈希表
  • 此设置没有默认值。

要使用的自定义标头,格式为 headers => ["X-My-Header", "%{host}"]

http_compression

编辑

启用请求压缩支持。启用此选项后,插件将使用 gzip 压缩 HTTP 请求。

http_method

编辑
  • 这是一个必需的设置。
  • 值可以是:putpostpatchdeletegethead
  • 此设置没有默认值。

HTTP 动词。“put”、“post”、“patch”、“delete”、“get”、“head” 之一

ignorable_codes

编辑
  • 值类型为 数字
  • 此设置没有默认值。

如果您想将某些非 2xx 代码视为成功,请在此处列出它们。返回这些代码的响应将被视为成功。

keepalive

编辑

启用此选项以启用 HTTP keepalive 支持。我们强烈建议为此设置 automatic_retries 为至少 1,以修复与损坏的 keepalive 实现的交互。

keystore

编辑

在 5.6.0 中已弃用。

已替换为 ssl_keystore_path

  • 值类型为 路径
  • 此设置没有默认值。

如果您需要使用自定义密钥库(.jks),请在此处指定。这与 .pem 密钥不兼容!

keystore_password

编辑

在 5.6.0 中已弃用。

已替换为 ssl_keystore_password

  • 值类型为 密码
  • 此设置没有默认值。

在此处指定密钥库密码。请注意,大多数使用 keytool 创建的 .jks 文件都需要密码!

keystore_type

编辑

在 5.6.0 中已弃用。

已替换为 ssl_keystore_type

在此处指定密钥库类型。JKSPKCS12 之一。默认为 JKS

mapping

编辑
  • 值类型为 哈希表
  • 此设置没有默认值。

这允许您选择要发送的事件的结构和部分。

例如

   mapping => {"foo" => "%{host}"
              "bar" => "%{type}"}

message

编辑
  • 值类型为 字符串
  • 此设置没有默认值。

pool_max

编辑
  • 值类型为 数字
  • 默认值为 50

最大并发连接数。默认为 50

pool_max_per_route

编辑
  • 值类型为 数字
  • 默认值为 25

到单个主机的最大并发连接数。默认为 25

proxy

编辑
  • 值类型为 字符串
  • 此设置没有默认值。

如果您要使用 HTTP 代理。这支持多种配置语法。

  1. 代理主机格式:http://proxy.org:1234
  2. 代理主机格式:{host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
  3. 代理主机格式:{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

编辑

请注意,此选项仅控制插件级别的重试。它对库级别的重试没有影响。

如果您想禁用对retryable_codes中定义的HTTP错误响应代码或可重试异常(超时、SocketException、ClientProtocolException、ResolutionFailure和SocketTimeout)的无限重试,请将此选项设置为false。有关更多信息,请参阅重试策略

retry_non_idempotent

编辑

当此选项设置为falseautomatic_retries启用时,将重试GET、HEAD、PUT、DELETE、OPTIONS和TRACE请求。

当设置为trueautomatic_retries启用时,这将导致非幂等HTTP动词(如POST)被重试。有关更多信息,请参阅重试策略

retryable_codes

编辑
  • 值类型为 数字
  • 默认值为[429, 500, 502, 503, 504]

如果插件遇到这些响应代码,插件将无限期重试。有关更多信息,请参阅重试策略

socket_timeout

编辑
  • 值类型为 数字
  • 默认值为 10

等待套接字上数据的超时时间(以秒为单位)。默认为10s

ssl_certificate

编辑
  • 值类型为 路径
  • 此设置没有默认值。

用于验证客户端的SSL证书。此证书应为OpenSSL风格的X.509证书文件。

只有在设置了ssl_key时才能使用此设置。

ssl_certificate_authorities

编辑
  • 值类型是路径列表
  • 此设置没有默认值

用于验证服务器证书的.cer或.pem CA文件。

ssl_cipher_suites

编辑
  • 值类型是字符串列表
  • 此设置没有默认值

要使用的密码套件列表,按优先级列出。支持的密码套件因Java和协议版本而异。

ssl_enabled

编辑

启用SSL/TLS安全通信。对于其他ssl_选项生效,它必须为true

ssl_key

编辑
  • 值类型为 路径
  • 此设置没有默认值。

ssl_certificate相对应的OpenSSL风格的RSA私钥。

只有在设置了ssl_certificate时才能使用此设置。

ssl_keystore_password

编辑
  • 值类型为 密码
  • 此设置没有默认值。

设置密钥库密码

ssl_keystore_path

编辑
  • 值类型为 路径
  • 此设置没有默认值。

用于向服务器提供证书的密钥库。它可以是.jks.p12

ssl_keystore_type

编辑
  • 值可以是:jkspkcs12
  • 如果未提供,则将从密钥库文件名推断该值。

密钥库文件的格式。它必须是jkspkcs12

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_truststore_password

编辑
  • 值类型为 密码
  • 此设置没有默认值。

设置信任库密码

ssl_truststore_path

编辑
  • 值类型为 路径
  • 此设置没有默认值。

用于验证服务器证书的信任库。它可以是.jks.p12

ssl_truststore_type

编辑
  • 值可以是:jkspkcs12
  • 如果未提供,则将从信任库文件名推断该值。

信任库文件的格式。它必须是jkspkcs12

ssl_verification_mode

编辑
  • 值类型为 字符串
  • 支持的值为:fullnone
  • 默认值为full

控制服务器证书的验证。full选项验证提供的证书是由受信任的授权机构(CA)签名的,并且服务器的主机名(或IP地址)与证书中标识的名称匹配。

none设置不执行服务器证书的验证。此模式禁用了SSL/TLS的许多安全优势,只有在仔细考虑后才能使用。它主要作为尝试解决TLS错误时的临时诊断机制。强烈建议不要在生产环境中使用none

truststore

编辑

在 5.6.0 中已弃用。

已由ssl_truststore_path替换

  • 值类型为 路径
  • 此设置没有默认值。

如果您需要使用自定义信任库(.jks),请在此处指定。这与.pem证书不兼容!

truststore_password

编辑

在 5.6.0 中已弃用。

已由ssl_truststore_password替换

  • 值类型为 密码
  • 此设置没有默认值。

在此处指定信任库密码。请注意,大多数使用keytool创建的.jks文件都需要密码!

truststore_type

编辑

在 5.6.0 中已弃用。

已由ssl_truststore_type替换

在此处指定信任库类型。JKSPKCS12。默认为JKS

  • 这是一个必需的设置。
  • 值类型为 字符串
  • 此设置没有默认值。

要使用的URL

validate_after_inactivity

编辑
  • 值类型为 数字
  • 默认值为200

在使用keepalive对连接执行请求之前,等待多长时间才能检查连接是否陈旧。如果您经常遇到连接错误,您可能需要将其设置为更低的值,甚至设置为0。引用Apache commons文档(此客户端基于Apache Commmons):_定义了在持久连接必须在被租借给消费者之前重新验证之前的非活动毫秒数。传递给此方法的非正值会禁用连接验证。此检查有助于检测在保持非活动状态的池中变得陈旧(半关闭)的连接。_有关更多信息,请参阅这些文档

常用选项

编辑

所有输出插件都支持这些配置选项

设置 输入类型 是否必需

编解码器

编解码器

启用指标

布尔值

ID

字符串

codec

编辑

用于输出数据的编解码器。输出编解码器是在数据离开输出之前对其进行编码的便捷方法,无需在Logstash管道中使用单独的过滤器。

enable_metric

编辑

禁用或启用此特定插件实例的指标日志记录。默认情况下,我们会记录所有可以记录的指标,但是您可以禁用特定插件的指标收集。

  • 值类型为字符串
  • 此设置没有默认值。

向插件配置添加唯一的ID。如果未指定ID,Logstash将生成一个。强烈建议您在配置中设置此ID。当您有两个或多个相同类型的插件时,这尤其有用。例如,如果您有两个http输出。在这种情况下,添加命名的ID将有助于在使用监控API监控Logstash时提供帮助。

output {
  http {
    id => "my_plugin_id"
  }
}

id字段中的变量替换仅支持环境变量,不支持使用密钥存储中的值。