经过时间过滤器插件
编辑经过时间过滤器插件编辑
- 插件版本：v4.1.0
- 发布时间：2018-07-31
- 更新日志
有关其他版本，请参阅版本化插件文档。
获取帮助编辑
有关插件的问题，请在论坛中打开一个主题。对于错误或功能请求，请在Github中打开一个问题。有关 Elastic 支持的插件列表，请参阅Elastic 支持矩阵。
描述编辑
经过时间过滤器跟踪一对开始/结束事件，并使用它们的时间戳来计算它们之间经过的时间。
该过滤器已开发用于跟踪进程和其他长时间运行任务的执行时间。
配置如下所示
filter {
elapsed {
start_tag => "start event tag"
end_tag => "end event tag"
unique_id_field => "id field name"
timeout => seconds
new_event_on_match => true/false
}
}
此过滤器管理的事件必须具有一些特定属性。描述任务开始的事件（“开始事件”）必须包含一个等于 start_tag 的标签。另一方面，描述任务结束的事件（“结束事件”）必须包含一个等于 end_tag 的标签。这两种事件都需要拥有一个 ID 字段，该字段唯一标识该特定任务。此字段的名称存储在 unique_id_field 中。
您可以使用 Grok 过滤器来准备用于经过时间过滤器的事件。配置示例可以是
filter {
grok {
match => { "message" => "%{TIMESTAMP_ISO8601} START id: (?<task_id>.*)" }
add_tag => [ "taskStarted" ]
}
grok {
match => { "message" => "%{TIMESTAMP_ISO8601} END id: (?<task_id>.*)" }
add_tag => [ "taskTerminated" ]
}
elapsed {
start_tag => "taskStarted"
end_tag => "taskTerminated"
unique_id_field => "task_id"
}
}
经过时间过滤器收集所有“开始事件”。如果两个或多个“开始事件”具有相同的 ID，则只记录第一个事件，其他事件将被丢弃。
当接收到与先前收集的“开始事件”匹配的“结束事件”时，则表示匹配。配置属性 new_event_on_match 指示在何处插入经过时间信息：它们可以添加到“结束事件”中，也可以创建一个新的“匹配事件”。这两个事件都存储以下信息
- 标签
elapsed和elapsed_match - 字段
elapsed_time，其中包含两个事件时间戳之间的差异（以秒为单位） - 一个包含任务 ID 的 ID 字段
- 字段
elapsed_timestamp_start，其中包含开始事件的时间戳
如果“结束事件”在“超时”秒之前未到达，则“开始事件”将被丢弃，并生成“过期事件”。此事件包含
- 标签
elapsed和elapsed_expired_error - 一个名为
elapsed_time的字段，其中包含“开始事件”的年龄（以秒为单位） - 一个包含任务 ID 的 ID 字段
- 字段
elapsed_timestamp_start，其中包含“开始事件”的时间戳
经过时间过滤器配置选项编辑
除了稍后描述的通用选项之外，此插件还支持以下配置选项。
| 设置 | 输入类型 | 必需 |
|---|---|---|
是 |
||
否 |
||
是 |
||
否 |
||
是 |
||
否 |
另请参阅通用选项，以获取所有过滤器插件支持的选项列表。
通用选项编辑
以下配置选项受所有过滤器插件支持
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field编辑
- 值类型为哈希
- 默认值为
{}
如果此过滤器成功，请将任意字段添加到此事件。字段名称可以是动态的，并且可以使用 %{field} 包含事件的一部分。
示例
filter {
elapsed {
add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
}
}
# You can also add multiple fields at once:
filter {
elapsed {
add_field => {
"foo_%{somefield}" => "Hello world, from %{host}"
"new_field" => "new_static_value"
}
}
}
如果事件的字段 "somefield" == "hello"，则此过滤器在成功时将添加字段 foo_hello（如果存在），其值为上述值，并将 %{host} 部分替换为事件中的该值。第二个示例还将添加一个硬编码字段。
add_tag编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功，请将任意标签添加到事件。标签可以是动态的，并且可以使用 %{field} 语法包含事件的一部分。
示例
filter {
elapsed {
add_tag => [ "foo_%{somefield}" ]
}
}
# You can also add multiple tags at once:
filter {
elapsed {
add_tag => [ "foo_%{somefield}", "taggedy_tag"]
}
}
如果事件的字段 "somefield" == "hello"，则此过滤器在成功时将添加标签 foo_hello（第二个示例当然会添加 taggedy_tag 标签）。
id编辑
- 值类型为字符串
- 此设置没有默认值。
向插件配置添加唯一的 ID。如果未指定 ID，Logstash 将生成一个 ID。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时，例如，如果您有 2 个经过时间过滤器，这将特别有用。在这种情况下，添加命名 ID 将有助于在使用监控 API 时监控 Logstash。
filter {
elapsed {
id => "ABC"
}
}
id 字段中的变量替换仅支持环境变量，不支持使用密钥库中的值。
remove_field编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并且可以使用 %{field} 示例包含事件的一部分。
filter {
elapsed {
remove_field => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple fields at once:
filter {
elapsed {
remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除名称为 foo_hello 的字段（如果存在）。第二个示例将删除另一个非动态字段。
remove_tag编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功，则从事件中删除任意标签。标签可以是动态的，并且可以使用 %{field} 语法包含事件的一部分。
示例
filter {
elapsed {
remove_tag => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple tags at once:
filter {
elapsed {
remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除标签 foo_hello（如果存在）。第二个示例还将删除一个不需要的悲伤标签。