Sleep 过滤器插件
编辑Sleep 过滤器插件
编辑- 插件版本: v3.0.7
- 发布于: 2020-09-04
- 更新日志
对于其他版本,请参阅版本化插件文档。
获取帮助
编辑有关插件的问题,请在Discuss论坛中开启一个主题。对于错误或功能请求,请在Github中开启一个 issue。有关 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
(如果存在)。第二个示例也会删除一个令人沮丧的、不需要的标签。