HTTP 过滤器插件

要发送的 HTTP 请求正文。

发送 body 作为 JSON 的示例

http {
  body => {
    "key1" => "constant_value"
    "key2" => "%{[field][reference]}"
  }
  body_format => "json"
}

如果设置为 "json" 并且 body 的类型为 数组 或 哈希表，则正文将被序列化为 JSON。否则，将按原样发送。

控制此插件与 Elastic 通用架构 (ECS) 的兼容性。此设置的值会影响 target_body 和 target_headers 的默认值。

要在请求中发送的 HTTP 报头。报头名称及其值都可以引用事件字段中的值。

定义要在 HTTP 请求中发送的查询字符串参数（键值对）。

定义用于放置 HTTP 响应正文的目标字段。

定义用于放置 HTTP 响应报头的目标字段。

要向其发送请求的 URL。该值可以从事件字段中获取。

要用于 HTTP 请求的动词。

客户端应重试失败的 URL 的次数。如果启用了 keepalive，我们强烈建议不要将此值设置为零。某些服务器会错误地过早结束 keepalive，需要重试！注意：如果设置了 retry_non_idempotent，则仅重试 GET、HEAD、PUT、DELETE、OPTIONS 和 TRACE 请求。

如果需要使用自定义 X.509 CA（.pem 证书），请在此处指定其路径

如果要使用客户端证书（注意，大多数人都不需要此功能），请在此处设置 x509 证书的路径

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

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

启用 Cookie 支持。启用此功能后，客户端将像普通的 Web 浏览器一样在请求之间保留 Cookie。默认情况下启用。

是否应跟随重定向？默认为 true

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

如果需要使用自定义密钥库（.jks），请在此处指定。这与 .pem 密钥不兼容！

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

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

与用户名一起用于 HTTP 身份验证的密码。

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

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

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

整个请求的超时时间（秒）。

如果启用了automatic_retries，这将导致非幂等 HTTP 动词（例如 POST）被重试。

等待套接字数据超时时间（秒）。默认值为 10s

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

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

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

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

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

设置密钥库密码。

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

密钥库文件的格式。它必须是 jks 或 pkcs12。

建立与 HTTP 端点连接时要使用的允许的 SSL/TLS 版本列表。

对于 Java 8，'TLSv1.3' 仅从 8u262（AdoptOpenJDK）开始支持，但需要在 Logstash 中设置 LS_JAVA_OPTS="-Djdk.tls.client.protocols=TLSv1.3" 系统属性。

设置信任库密码。

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

信任库文件的格式。它必须是 jks 或 pkcs12。

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

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

如果需要使用自定义信任库（.jks），请在此处指定。这与 .pem 证书不兼容！

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

在此处指定信任库类型。JKS 或 PKCS12 之一。默认为 JKS

用于所有请求的 HTTP 身份验证的用户名。请注意，您也可以为每个 URL 设置此项。如果设置此项，则还必须设置 password 选项。

在检查过时连接以确定是否需要 keepalive 请求之前要等待的时间。如果您经常遇到连接错误，请考虑将此值设置为低于默认值，甚至设置为 0。

此客户端基于 Apache Commons。Apache Commons 文档是这样描述此选项的：“定义以毫秒为单位的非活动时间段，在此时间段之后，必须在将持久连接租赁给使用者之前重新验证这些连接。传递给此方法的非正值将禁用连接验证。此检查有助于检测在保留在池中处于非活动状态时变得陈旧（半关闭）的连接。"

如果此过滤器成功，则向此事件添加任意字段。字段名称可以是动态的，并使用 %{field} 包含事件的部分内容。

示例

    filter {
      http {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }

    # You can also add multiple fields at once:
    filter {
      http {
        add_field => {
          "foo_%{somefield}" => "Hello world, from %{host}"
          "new_field" => "new_static_value"
        }
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功后将添加字段 foo_hello（如果存在），其值为上述值，并且 %{host} 部分将替换为事件中的该值。第二个示例还将添加一个硬编码字段。

如果此过滤器成功，则向事件添加任意标签。标签可以是动态的，并使用 %{field} 语法包含事件的部分内容。

示例

    filter {
      http {
        add_tag => [ "foo_%{somefield}" ]
      }
    }

    # You can also add multiple tags at once:
    filter {
      http {
        add_tag => [ "foo_%{somefield}", "taggedy_tag"]
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功后将添加标签 foo_hello（当然，第二个示例将添加 taggedy_tag 标签）。

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

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

    filter {
      http {
        id => "ABC"
      }
    }

定期调用过滤器刷新方法。可选。

如果此过滤器成功，则会从此事件中删除任意字段。字段名称可以是动态的，并包含使用 %{field} 的事件部分，例如：

    filter {
      http {
        remove_field => [ "foo_%{somefield}" ]
      }
    }

    # You can also remove multiple fields at once:
    filter {
      http {
        remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
      }
    }

如果事件包含字段 "somefield" == "hello"，则此过滤器成功后，如果存在名为 foo_hello 的字段，则会将其删除。第二个示例将删除另一个非动态字段。

如果此过滤器成功，则会从此事件中删除任意标签。标签可以是动态的，并包含使用 %{field} 语法的事件部分。

示例

    filter {
      http {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }

    # You can also remove multiple tags at once:
    filter {
      http {
        remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
      }
    }

如果事件包含字段 "somefield" == "hello"，则此过滤器成功后，如果存在名为 foo_hello 的标签，则会将其删除。第二个示例还会删除一个令人不快的、不需要的标签。