Heartbeat 输入插件

编辑
  • 插件版本:v3.1.1
  • 发布日期:2021-08-04
  • 变更日志

其他版本,请参见 版本化插件文档

获取帮助

编辑

如有关于插件的问题,请在 Discuss 论坛中发帖。如发现错误或有功能请求,请在 Github 中提交 issue。如需查看 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵

描述

编辑

生成心跳消息。

此插件的总体目的是测试 Logstash 的性能和可用性。

Elastic 通用架构 (ECS)

编辑

此插件可以提供一个字段,原名为 clock,用于跟踪 epochsequence 增量数字。启用 ECS 兼容模式 后,该值现在位于事件的 [event][sequence] 子字段中。

启用 ECS 兼容模式 后,无法使用 message 作为序列类型的选择器,只会考虑 sequence。在这种情况下,如果 message 包含序列选择器字符串,则会忽略。

启用 ECS 后,现有的 host 字段将移动到 [host][name]

`disabled` `v1`,`v8` 可用性 描述

[host]

[host][name]

始终

运行插件的主机的名称或地址

[clock]

[event][sequence]

启用 sequence 设置时

基于秒或从本地基于 0 的计数器递增计数器

Heartbeat 输入配置选项

编辑

此插件支持以下配置选项以及稍后描述的 通用选项

设置 输入类型 必需

count

数字

ecs_compatibility

字符串

interval

数字

message

字符串

sequence

字符串,其中一个 ["none", "epoch", "sequence"]

threads

数字

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

 

count

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

迭代次数。这通常仅用于测试目的。

ecs_compatibility

编辑
  • 值类型为 字符串
  • 支持的值为

    • disabled:在根级别添加 clock 计数器字段
    • v1v8:向事件添加符合 ECS 的 [event][sequence] 计数器字段
  • 默认值取决于正在运行的 Logstash 版本

    • 当 Logstash 提供 pipeline.ecs_compatibility 设置时,将使用其值作为默认值
    • 否则,默认值为 disabled

控制此插件与 Elastic 通用架构 (ECS) 的兼容性。有关详细信息,请参阅本主题中的 Elastic 通用架构 (ECS)

interval

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

设置发送消息的频率。

默认值 60 表示每 60 秒发送一条消息。

message

编辑

要在事件中使用的消息字符串。

如果将此值设置为 epoch,则此插件将使用 unix 时间戳中的当前时间戳(根据定义,为 UTC)。它会将此值输出到名为 clock 的字段中。

如果将此值设置为 sequence,则此插件将发送从 0 开始并在每个间隔递增的数字序列。它会将此值输出到名为 clock 的字段中。

否则,此值将按原样用作事件消息。它会将此值输出到名为 message 的字段中。

message 设置中使用 epochsequence 已弃用。请考虑使用 sequence 设置,它优先于使用 message 设置作为选择器。

如果启用了 ECS 兼容模式 并且 message 包含 epochsequence,则会忽略它,并且它不会作为生成的事件中的字段存在。

sequence

编辑
  • 值可以是:noneepochsequence
  • 默认值为 "none""

如果将此值设置为 none,则不会添加序列字段。

如果将此值设置为 epoch,则此插件将使用 unix 时间戳中的当前时间戳(根据定义,为 UTC)。如果禁用了 ECS 兼容模式,它会将此值输出到名为 clock 的字段中。否则,字段名为 [event][sequence]

如果将此值设置为 sequence,则此插件将发送从 0 开始并在每个间隔递增的数字序列。如果禁用了 ECS 兼容模式,它会将此值输出到名为 clock 的字段中。否则,字段名为 [event][sequence]

如果定义了 sequence,它优先于 message 配置。如果 message 没有 epochsequence 值,它将与 clock 字段一起出现在生成的事件中。

threads

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

通用选项

编辑

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

设置 输入类型 必需

add_field

hash

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

add_field

编辑

向事件添加字段

codec

编辑
  • 值类型为 codec
  • 默认值为 "plain"

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

enable_metric

编辑

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

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

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

input {
  heartbeat {
    id => "my_plugin_id"
  }
}

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

tags

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

向您的事件添加任意数量的任意标签。

这可以帮助以后进行处理。

type

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

向此输入处理的所有事件添加 type 字段。

类型主要用于过滤器激活。

类型存储为事件本身的一部分,因此您也可以使用类型在 Kibana 中搜索它。

如果尝试在已经拥有类型的事件上设置类型(例如,当您将事件从发件人发送到索引器时),则新的输入不会覆盖现有类型。即使发送到另一个 Logstash 服务器,在发件人处设置的类型也会在事件的整个生命周期中保留。