心跳输入插件

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

有关其他版本,请参阅版本化插件文档

获取帮助

编辑

有关插件的问题,请在Discuss论坛中开一个主题。有关错误或功能请求,请在Github中开一个问题。有关 Elastic 支持的插件列表,请参考Elastic 支持矩阵

描述

编辑

生成心跳消息。

此插件的主要目的是测试 Logstash 的性能和可用性。

Elastic Common Schema (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 的计数器递增计数器

心跳输入配置选项

编辑

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

设置 输入类型 必需

count

数字

ecs_compatibility

字符串

interval

数字

message

字符串

sequence

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

threads

数字

另请参阅通用选项,以获取所有输入插件支持的选项列表。

 

count

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

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

ecs_compatibility

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

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

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

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

interval

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

设置应发送消息的频率。

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

message

编辑

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

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

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

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

不建议在 message 设置中使用 epochsequence。请考虑使用sequence设置,该设置优先于将 message 设置用作选择器。

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

sequence

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

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

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

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

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

threads

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

通用选项

编辑

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

设置 输入类型 必需

add_field

哈希

codec

codec

enable_metric

布尔值

id

字符串

tags

数组

type

字符串

add_field

编辑
  • 值类型为哈希
  • 默认值为 {}

向事件添加字段

codec

编辑

用于输入数据的编解码器。输入编解码器是在数据进入输入之前解码数据的便捷方法,无需在 Logstash 管道中单独进行筛选。

enable_metric

编辑

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

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

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

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

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

tags

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

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

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

type

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

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

类型主要用于筛选器激活。

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

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