HTTP 过滤器插件

要发送的 HTTP 请求的正文。

将 body 作为 json 发送的示例

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

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

控制此插件与Elastic Common Schema (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，只有从 8u262 (AdoptOpenJDK) 开始才支持 'TLSv1.3'，但需要你在 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 选项。

在检查是否有过时的连接以确定是否需要保持活动请求之前等待的时间。如果经常出现连接错误，请考虑将此值设置得低于默认值，甚至为 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。强烈建议你在配置中设置此 ID。当你具有两个或多个相同类型的插件时，此 ID 特别有用，例如，如果你有 2 个 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，则会将其删除。第二个示例也会删除一个不需要的悲伤标签。