Heartbeat 输入插件
编辑Heartbeat 输入插件
编辑- 插件版本:v3.1.1
- 发布日期:2021-08-04
- 变更日志
其他版本,请参见 版本化插件文档。
获取帮助
编辑如有关于插件的问题,请在 Discuss 论坛中发帖。如发现错误或有功能请求,请在 Github 中提交 issue。如需查看 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵。
Elastic 通用架构 (ECS)
编辑此插件可以提供一个字段,原名为 clock
,用于跟踪 epoch
或 sequence
增量数字。启用 ECS 兼容模式 后,该值现在位于事件的 [event][sequence]
子字段中。
启用 ECS 兼容模式 后,无法使用 message
作为序列类型的选择器,只会考虑 sequence
。在这种情况下,如果 message
包含序列选择器字符串,则会忽略。
启用 ECS 后,现有的 host
字段将移动到 [host][name]
。
`disabled` | `v1`,`v8` | 可用性 | 描述 |
---|---|---|---|
[host] |
[host][name] |
始终 |
运行插件的主机的名称或地址 |
[clock] |
[event][sequence] |
启用 |
基于秒或从本地基于 0 的计数器递增计数器 |
Heartbeat 输入配置选项
编辑此插件支持以下配置选项以及稍后描述的 通用选项。
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
字符串,其中一个 |
否 |
|
否 |
另请参见 通用选项,了解所有输入插件支持的选项列表。
ecs_compatibility
编辑- 值类型为 字符串
-
支持的值为
-
disabled
:在根级别添加clock
计数器字段 -
v1
,v8
:向事件添加符合 ECS 的[event][sequence]
计数器字段
-
-
默认值取决于正在运行的 Logstash 版本
- 当 Logstash 提供
pipeline.ecs_compatibility
设置时,将使用其值作为默认值 - 否则,默认值为
disabled
。
- 当 Logstash 提供
控制此插件与 Elastic 通用架构 (ECS) 的兼容性。有关详细信息,请参阅本主题中的 Elastic 通用架构 (ECS)。
message
编辑- 值类型为 字符串
- 默认值为
"ok"
要在事件中使用的消息字符串。
如果将此值设置为 epoch
,则此插件将使用 unix 时间戳中的当前时间戳(根据定义,为 UTC)。它会将此值输出到名为 clock
的字段中。
如果将此值设置为 sequence
,则此插件将发送从 0 开始并在每个间隔递增的数字序列。它会将此值输出到名为 clock
的字段中。
否则,此值将按原样用作事件消息。它会将此值输出到名为 message
的字段中。
message
设置中使用 epoch
和 sequence
已弃用。请考虑使用 sequence
设置,它优先于使用 message
设置作为选择器。
如果启用了 ECS 兼容模式 并且 message
包含 epoch
或 sequence
,则会忽略它,并且它不会作为生成的事件中的字段存在。
sequence
编辑- 值可以是:
none
、epoch
、sequence
- 默认值为
"none""
如果将此值设置为 none
,则不会添加序列字段。
如果将此值设置为 epoch
,则此插件将使用 unix 时间戳中的当前时间戳(根据定义,为 UTC)。如果禁用了 ECS 兼容模式,它会将此值输出到名为 clock
的字段中。否则,字段名为 [event][sequence]
。
如果将此值设置为 sequence
,则此插件将发送从 0 开始并在每个间隔递增的数字序列。如果禁用了 ECS 兼容模式,它会将此值输出到名为 clock
的字段中。否则,字段名为 [event][sequence]
。
如果定义了 sequence
,它优先于 message
配置。如果 message
没有 epoch
或 sequence
值,它将与 clock
字段一起出现在生成的事件中。