心跳输入插件
编辑心跳输入插件
编辑- 插件版本:v3.1.1
- 发布日期:2021-08-04
- 更新日志
有关其他版本,请参阅版本化插件文档。
获取帮助
编辑有关插件的问题,请在Discuss论坛中开一个主题。有关错误或功能请求,请在Github中开一个问题。有关 Elastic 支持的插件列表,请参考Elastic 支持矩阵。
Elastic Common Schema (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 的计数器递增计数器 |
心跳输入配置选项
编辑此插件支持以下配置选项,以及稍后描述的通用选项。
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
字符串,为 |
否 |
|
否 |
另请参阅通用选项,以获取所有输入插件支持的选项列表。
ecs_compatibility
编辑- 值类型为字符串
-
支持的值为
-
disabled
: 在根级别添加clock
计数器字段 -
v1
,v8
: 将符合 ECS 的[event][sequence]
计数器字段添加到事件
-
-
默认值取决于正在运行的 Logstash 版本
- 当 Logstash 提供
pipeline.ecs_compatibility
设置时,其值将用作默认值 - 否则,默认值为
disabled
。
- 当 Logstash 提供
控制此插件与Elastic Common Schema (ECS)的兼容性。有关详细信息,请参阅本主题中的Elastic Common Schema (ECS)。
message
编辑- 值类型为字符串
- 默认值为
"ok"
事件中使用的消息字符串。
如果将此值设置为 epoch
,则此插件将使用当前时间戳(定义为 UTC)的 Unix 时间戳。它会将此值输出到名为 clock
的字段中
如果将此值设置为 sequence
,则此插件将发送一个从 0 开始并在每个间隔递增的数字序列。它会将此值输出到名为 clock
的字段中
否则,此值将按原样用作事件消息。它会将此值输出到名为 message
的字段中
不建议在 message
设置中使用 epoch
和 sequence
。请考虑使用sequence
设置,该设置优先于将 message
设置用作选择器。
如果启用了ECS 兼容模式,并且 message
包含 epoch
或 sequence
,则它将被忽略,并且不会作为生成事件中的字段出现。
sequence
编辑- 值可以是:
none
、epoch
、sequence
- 默认值为
"none""
如果将此值设置为 none
,则不会添加序列字段。
如果将此值设置为 epoch
,则此插件将使用当前时间戳(定义为 UTC)的 Unix 时间戳。如果禁用了ECS 兼容模式,它会将此值输出到名为 clock
的字段中。否则,字段名称为 [event][sequence]
。
如果将此值设置为 sequence
,则此插件将发送一个从 0 开始并在每个间隔递增的数字序列。如果禁用了ECS 兼容模式,它会将此值输出到名为 clock
的字段中。否则,字段名称为 [event][sequence]
如果定义了 sequence
,则它优先于 message
配置。如果 message
没有 epoch
或 sequence
值,它将与 clock
字段一起出现在生成的事件中。