心跳输入插件编辑

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

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

获取帮助编辑

有关插件的问题,请在 讨论 论坛中发布主题。对于错误或功能请求,请在 Github 中打开问题。有关 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 基计数器递增计数器

心跳输入配置选项编辑

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

设置 输入类型 必需

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 通用模式 (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编辑

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

enable_metric编辑

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

idedit

  • 值类型为 string
  • 此设置没有默认值。

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

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

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

tagsedit

  • 值类型为 array
  • 此设置没有默认值。

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

这可以帮助以后处理。

typeedit

  • 值类型为 string
  • 此设置没有默认值。

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

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

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

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