HTTP 输入插件
编辑HTTP 输入插件
编辑- 插件版本:v3.9.2
- 发布日期:2024-11-18
- 变更日志
其他版本请参见 版本化插件文档。
获取帮助
编辑如有任何关于插件的问题,请在 Discuss 论坛上发帖提问。如发现错误或有功能需求,请在 Github 上提交问题。如需查看 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵。
描述
编辑使用此输入插件,您可以通过 HTTP(S) 接收单行或多行事件。应用程序可以向此输入插件启动的端点发送 HTTP 请求,Logstash 将将其转换为事件以供后续处理。用户可以传递纯文本、JSON 或任何格式化的数据,并在此输入插件中使用相应的编解码器。对于 Content-Type application/json
,使用 json
编解码器;但对于所有其他数据格式,使用 plain
编解码器。
此输入插件也可用于接收 Webhook 请求以与其他服务和应用程序集成。通过利用 Logstash 中丰富的插件生态系统,您可以直接从应用程序触发可执行事件。
事件元数据和 Elastic 通用架构 (ECS)
编辑除了解码事件之外,此输入插件还会将包含连接信息的 HTTP 头添加到每个事件中。当禁用 ECS 兼容性时,头信息将存储在 headers
字段中,这可能会在下游造成混淆和架构冲突。启用 ECS 时,我们可以确保管道在整个事件生命周期中都能访问此元数据,而不会污染顶级命名空间。
以下是 ECS 兼容模式如何影响输出。
ECS `已禁用` | ECS `v1`、`v8` | 可用性 | 描述 |
---|---|---|---|
[host] |
[host][ip] |
始终 |
主机 IP 地址 |
[headers] |
[@metadata][input][http][request][headers] |
始终 |
完整的 HTTP 头信息 |
[headers][http_version] |
[http][version] |
始终 |
HTTP 版本 |
[headers][http_user_agent] |
[user_agent][original] |
始终 |
客户端用户代理 |
[headers][http_host] |
[url][domain] 和 [url][port] |
始终 |
主机域名和端口 |
[headers][request_method] |
[http][method] |
始终 |
HTTP 方法 |
[headers][request_path] |
[url][path] |
始终 |
查询路径 |
[headers][content_length] |
[http][request][body][bytes] |
始终 |
请求内容长度 |
[headers][content_type] |
[http][request][mime_type] |
始终 |
请求 MIME 类型 |
阻塞行为
编辑HTTP 协议不擅长处理长时间运行的请求。当 Logstash 积压时,此插件将返回 429(繁忙)错误,或者请求将超时。
如果遇到 429 错误,客户端应休眠,以指数方式回退并加入一些随机抖动,然后重试其请求。
如果 Logstash 队列阻塞且有可用的 HTTP 输入线程,则此插件将阻塞。这将导致大多数 HTTP 客户端超时。在这种情况下,发送的事件仍将被处理。此行为并非最佳,将在未来的版本中更改。将来,如果队列繁忙,此插件将始终返回 429,并且在队列繁忙的情况下不会超时。
安全性
编辑此插件支持标准 HTTP 基本身份验证头来识别请求者。您可以在向此输入插件发送数据时传入用户名和密码组合。
您还可以设置 SSL 并通过 HTTPS 安全地发送数据,并提供多种选项,例如验证客户端证书。
编解码器设置
编辑此插件有两个用于编解码器的配置选项:codec
和 additional_codecs
。
additional_codecs
中的值优先于 codec
选项中指定的值。也就是说,只有当在 additional_codecs
设置中找不到请求内容类型的编解码器时,才会应用默认的 codec
。
HTTP 输入配置选项
编辑此插件支持以下配置选项以及稍后描述的 通用选项。
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
已弃用 |
||
否 |
||
否 |
||
已弃用 |
||
已弃用 |
||
否 |
||
否 |
||
否 |
||
否 |
||
数字,其中一个 |
否 |
|
已弃用 |
||
有效的系统文件路径 |
否 |
|
否 |
||
否 |
||
字符串,其中一个 |
否 |
|
否 |
||
否 |
||
有效的系统文件路径 |
否 |
|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
字符串,其中一个 |
已弃用 |
|
否 |
||
已弃用 |
||
已弃用 |
||
否 |
||
字符串,其中一个 |
已弃用 |
另请参阅 通用选项,了解所有输入插件支持的选项列表。
additional_codecs
编辑- 值类型为 哈希表
- 默认值为
{"application/json"=>"json"}
为特定内容类型应用特定的编解码器。只有在此列表检查后且未找到请求内容类型的编解码器时,才会应用默认编解码器。
ecs_compatibility
编辑- 值类型为 字符串
-
支持的值为:
-
disabled
:在根级别添加非结构化连接元数据 -
v1
、v8
:在[@metadata][http][header]
下添加头信息。某些信息会被复制到结构化的 ECS 字段http
、url
、user_agent
和host
中
-
控制此插件与 Elastic 通用架构 (ECS) 的兼容性。有关详细信息,请参阅 事件元数据和 Elastic 通用架构 (ECS)。
示例输出:ECS 已禁用
{ "@version" => "1", "headers" => { "request_path" => "/twitter/tweet/1", "http_accept" => "*/*", "http_version" => "HTTP/1.1", "request_method" => "PUT", "http_host" => "localhost:8080", "http_user_agent" => "curl/7.64.1", "content_length" => "5", "content_type" => "application/x-www-form-urlencoded" }, "@timestamp" => 2021-05-28T19:27:28.609Z, "host" => "127.0.0.1", "message" => "hello" }
示例输出:ECS 已启用
{ "@version" => "1", "user_agent" => { "original" => "curl/7.64.1" }, "http" => { "method" => "PUT", "request" => { "mime_type" => "application/x-www-form-urlencoded", "body" => { "bytes" => "5" } }, "version" => "HTTP/1.1" }, "url" => { "port" => "8080", "domain" => "snmp1", "path" => "/twitter/tweet/1" }, "@timestamp" => 2021-05-28T23:32:38.222Z, "host" => { "ip" => "127.0.0.1" }, "message" => "hello", }
max_pending_requests
编辑- 值类型为 数字
- 默认值为 200
在由工作线程处理之前,要在临时队列中存储的传入请求的最大数量。如果请求到达且队列已满,则会立即返回 429 响应。此队列用于处理事件的微突发并提高整体吞吐量,因此应非常谨慎地更改此队列,因为它可能导致内存压力并影响性能。如果您需要同时处理定期或意外的传入请求激增,请考虑为 Logstash 管道启用持久队列。
response_code
编辑- 值可以是:200、201、202、204
- 默认值为
200
如果请求成功处理,则为 HTTP 返回代码。
在错误情况下,可能会出现其他返回代码,例如无效凭据 (401)、内部错误 (503) 或反压 (429)。
如果设置为 204(无内容),则响应正文不会发送到响应中。
remote_host_target_field
编辑- 值类型为 字符串
- 当 ECS 已禁用时,默认值为
"host"
- 当 ECS 已启用时,默认值为
[host][ip]
为 HTTP 请求的客户端主机指定目标字段
request_headers_target_field
编辑- 值类型为 字符串
- 当禁用 ECS 时,默认值为
"headers"
- 当启用 ECS 时,默认值为
[@metadata][http][header]
指定 HTTP 请求客户端主机的目标字段
ssl
编辑在 3.7.0 版本中已弃用。
已被 ssl_enabled
替代
- 值类型为 布尔值
- 默认值为
false
默认情况下,事件以纯文本形式发送。可以通过将 ssl
设置为 true 并配置 ssl_certificate
和 ssl_key
选项来启用加密。
ssl_certificate_authorities
编辑- 值类型为 数组
- 默认值为
[]
针对这些证书颁发机构验证客户端证书。您可以定义多个文件或路径。所有证书都将被读取并添加到信任库。您需要将 ssl_client_authentication
配置为 optional
或 required
以启用验证。
ssl_cipher_suites
编辑- 值类型为 数组
- 默认值为
['TLS_AES_256_GCM_SHA384', 'TLS_AES_128_GCM_SHA256', 'TLS_CHACHA20_POLY1305_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384', 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384', 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', 'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256', 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384', 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384', 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256', 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256']
要使用的密码套件列表,按优先级列出。此默认列表适用于 OpenJDK 11.0.14 及更高版本。对于较旧的 JDK 版本,默认列表仅包含该版本支持的套件。例如,ChaCha20 系列密码在旧版本中不受支持。
ssl_client_authentication
编辑- 值可以是:
none
、optional
、required
- 默认值为
"none"
控制服务器在请求客户端连接证书方面的行为:required
强制客户端提供证书,而 optional
请求客户端证书,但客户端不需要提供证书。默认为 none
,这将禁用客户端身份验证。
只有在设置了 ssl_certificate_authorities
时才能使用此设置。
ssl_enabled
编辑- 值类型为 布尔值
- 默认值为
false
默认情况下,事件以纯文本形式发送。可以通过将 ssl_enabled
设置为 true 并配置 ssl_certificate
和 ssl_key
选项来启用加密。
ssl_keystore_path
编辑- 值类型为 路径
- 此设置没有默认值。
包含私钥和证书的密钥库文件的路径。它必须是 Java 密钥库 (jks) 或 PKCS#12 文件。
您不能同时使用此设置和 ssl_certificate
。
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_path
编辑- 值类型为 路径
- 此设置没有默认值。
包含要信任的证书的密钥库文件的路径。它必须是 Java 密钥库 (jks) 或 PKCS#12 文件。
您不能同时使用此设置和 ssl_certificate_authorities
。
ssl_verify_mode
编辑在 3.7.0 版本中已弃用。
- 值可以是:
none
、peer
、force_peer
- 默认值为
"none"
默认情况下,服务器不执行任何客户端验证。
peer
将使服务器要求客户端提供证书。如果客户端提供证书,则将对其进行验证。
force_peer
将使服务器要求客户端提供证书。如果客户端不提供证书,则连接将被关闭。
此选项需要与 ssl_certificate_authorities
和已定义的 CA 列表一起使用。
tls_max_version
编辑在 3.6.0 版本中已弃用。
- 值类型为 数字
允许的加密连接的最大 TLS 版本。值必须是以下值之一:1.1 表示 TLS 1.1,1.2 表示 TLS 1.2,1.3 表示 TLSv1.3
tls_min_version
编辑在 3.6.0 版本中已弃用。
- 值类型为 数字
允许的加密连接的最小 TLS 版本。值必须是以下值之一:1.1 表示 TLS 1.1,1.2 表示 TLS 1.2,1.3 表示 TLSv1.3
verify_mode
编辑在 3.6.0 版本中已弃用。
已被 ssl_verify_mode
替代
- 值可以是:
none
、peer
、force_peer
- 默认值为
"none"
设置客户端证书验证方法。有效方法:none、peer、force_peer