心跳输入插件
编辑心跳输入插件编辑
- 插件版本: v3.1.1
- 发布日期: 2021-08-04
- 变更日志
有关其他版本,请参阅 版本化插件文档.
获取帮助编辑
有关插件的问题,请在 讨论 论坛中发布主题。对于错误或功能请求,请在 Github 中打开问题。有关 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 基计数器递增计数器 |
心跳输入配置选项编辑
此插件支持以下配置选项以及后面描述的 通用选项。
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
字符串 之一 |
否 |
|
否 |
另请参阅 通用选项,了解所有输入插件支持的选项列表。
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
字段一起存在于生成的事件中。
通用选项编辑
以下配置选项由所有输入插件支持
详细信息编辑
codec
编辑
- 值类型为 编解码器
- 默认值为
"plain"
用于输入数据的编解码器。输入编解码器是一种方便的方法,可以在输入数据进入输入之前对其进行解码,而无需在 Logstash 管道中使用单独的过滤器。