Sleep 过滤器插件
编辑Sleep 过滤器插件编辑
- 插件版本：v3.0.7
- 发布时间：2020-09-04
- 更新日志
有关其他版本，请参阅版本化插件文档。
获取帮助编辑
如果您对插件有任何疑问，请在论坛中打开一个主题。对于错误或功能请求，请在Github中打开一个问题。有关 Elastic 支持的插件列表，请参阅Elastic 支持矩阵。
描述编辑
休眠指定的时间。这将导致 Logstash 暂停指定的时间。这对于速率限制等很有用。
Sleep 过滤器配置选项编辑
此插件支持以下配置选项以及稍后描述的通用选项。
另请参阅通用选项，以获取所有过滤器插件支持的选项列表。
every编辑
- 值类型为字符串
- 默认值为
1
每隔 N 个事件休眠一次。此选项在重放模式下被忽略。
示例
filter {
sleep {
time => "1" # Sleep 1 second
every => 10 # on every 10th event
}
}
通用选项编辑
所有过滤器插件都支持以下配置选项
| 设置 | 输入类型 | 必填 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field编辑
- 值类型为哈希
- 默认值为
{}
如果此过滤器成功，则将任意字段添加到此事件。字段名称可以是动态的，并且可以使用%{field}包含事件的一部分。
示例
filter {
sleep {
add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
}
}
# You can also add multiple fields at once:
filter {
sleep {
add_field => {
"foo_%{somefield}" => "Hello world, from %{host}"
"new_field" => "new_static_value"
}
}
}
如果事件具有字段"somefield" == "hello"，则此过滤器在成功时将添加字段foo_hello（如果存在），其值为上述值，并将%{host}部分替换为事件中的该值。第二个示例还将添加一个硬编码字段。
add_tag编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功，则将任意标签添加到事件。标签可以是动态的，并且可以使用%{field}语法包含事件的一部分。
示例
filter {
sleep {
add_tag => [ "foo_%{somefield}" ]
}
}
# You can also add multiple tags at once:
filter {
sleep {
add_tag => [ "foo_%{somefield}", "taggedy_tag"]
}
}
如果事件具有字段"somefield" == "hello"，则此过滤器在成功时将添加标签foo_hello（当然，第二个示例将添加taggedy_tag标签）。
id编辑
- 值类型为字符串
- 此设置没有默认值。
向插件配置添加唯一的ID。如果未指定 ID，Logstash 将生成一个。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时，例如，如果您有两个 sleep 过滤器，这将特别有用。在这种情况下，添加命名 ID 将有助于在使用监控 API 时监控 Logstash。
filter {
sleep {
id => "ABC"
}
}
id字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。
remove_field编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并且可以使用%{field}包含事件的一部分。示例
filter {
sleep {
remove_field => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple fields at once:
filter {
sleep {
remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
}
}
如果事件具有字段"somefield" == "hello"，则此过滤器在成功时将删除名称为foo_hello的字段（如果存在）。第二个示例将删除另一个非动态字段。
remove_tag编辑
- 值类型为数组
- 默认值为
[]
如果此过滤器成功，则从事件中删除任意标签。标签可以是动态的，并且可以使用%{field}语法包含事件的一部分。
示例
filter {
sleep {
remove_tag => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple tags at once:
filter {
sleep {
remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
}
}
如果事件具有字段"somefield" == "hello"，则此过滤器在成功时将删除标签foo_hello（如果存在）。第二个示例还将删除一个不需要的标签。