范围过滤器插件
编辑范围过滤器插件
编辑- 插件版本:v3.0.3
- 发布日期:2017-11-07
- 更新日志
有关其他版本,请参阅版本化插件文档。
获取帮助
编辑有关插件的问题,请在 Discuss 论坛中开一个主题。对于错误或功能请求,请在 Github 中开一个 issue。有关 Elastic 支持的插件列表,请查阅Elastic 支持矩阵。
描述
编辑此过滤器用于检查某些字段是否在预期的尺寸/长度范围内。支持的类型是数字和字符串。检查数字是否在数值范围内。检查字符串是否在字符串长度范围内。可以为同一字段名指定多个范围,操作将以增量方式应用。当字段值在指定范围内时,将采取操作。支持的操作是删除事件、添加标签或添加具有指定值的字段。
示例用例包括对事件进行类似于直方图的标记,或查找字段中的异常值或应删除的过大事件。
范围过滤器配置选项
编辑此插件支持以下配置选项以及稍后描述的通用选项。
另请参阅通用选项,查看所有过滤器插件支持的选项列表。
ranges
编辑- 值类型为数组
- 默认值为
[]
字段、最小值、最大值、操作元组的数组。示例
filter { range { ranges => [ "message", 0, 10, "tag:short", "message", 11, 100, "tag:medium", "message", 101, 1000, "tag:long", "message", 1001, 1e1000, "drop", "duration", 0, 100, "field:latency:fast", "duration", 101, 200, "field:latency:normal", "duration", 201, 1000, "field:latency:slow", "duration", 1001, 1e1000, "field:latency:outlier", "requests", 0, 10, "tag:too_few_%{host}_requests" ] } }
支持的操作是删除标签或具有指定值的字段。添加的标签名称、字段名称和字段值可以具有 %{dynamic}
值。
通用选项
编辑所有过滤器插件都支持这些配置选项
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field
编辑- 值类型为 哈希
- 默认值为
{}
如果此过滤器成功,则将任意字段添加到此事件。字段名称可以是动态的,并且可以使用 %{field}
包含事件的一部分。
示例
filter { range { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } } }
# You can also add multiple fields at once: filter { range { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" "new_field" => "new_static_value" } } }
如果事件具有字段 "somefield" == "hello"
,则此过滤器在成功时会添加字段 foo_hello
(如果存在),其值为上述值,并且 %{host}
部分会替换为事件中的该值。第二个示例还会添加硬编码字段。
add_tag
编辑- 值类型为 数组
- 默认值为
[]
如果此过滤器成功,则将任意标签添加到事件。标签可以是动态的,并且可以使用 %{field}
语法包含事件的一部分。
示例
filter { range { add_tag => [ "foo_%{somefield}" ] } }
# You can also add multiple tags at once: filter { range { add_tag => [ "foo_%{somefield}", "taggedy_tag"] } }
如果事件具有字段 "somefield" == "hello"
,则此过滤器在成功时会添加标签 foo_hello
(第二个示例当然会添加 taggedy_tag
标签)。
id
编辑- 值类型为 字符串
- 此设置没有默认值。
向插件配置添加唯一 ID
。如果未指定 ID,Logstash 将生成一个。强烈建议在您的配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有 2 个范围过滤器。在这种情况下添加命名 ID 将有助于在使用监控 API 时监控 Logstash。
filter { range { id => "ABC" } }
id
字段中的变量替换仅支持环境变量,并且不支持使用来自密钥存储的值。
remove_field
编辑- 值类型为 数组
- 默认值为
[]
如果此过滤器成功,则从此事件中删除任意字段。字段名称可以是动态的,并且可以使用 %{field} 包含事件的一部分。示例
filter { range { remove_field => [ "foo_%{somefield}" ] } }
# You can also remove multiple fields at once: filter { range { remove_field => [ "foo_%{somefield}", "my_extraneous_field" ] } }
如果事件具有字段 "somefield" == "hello"
,则此过滤器在成功时会删除名为 foo_hello
的字段(如果存在)。第二个示例将删除一个额外的、非动态的字段。
remove_tag
编辑- 值类型为 数组
- 默认值为
[]
如果此过滤器成功,则从此事件中删除任意标签。标签可以是动态的,并且可以使用 %{field}
语法包含事件的一部分。
示例
filter { range { remove_tag => [ "foo_%{somefield}" ] } }
# You can also remove multiple tags at once: filter { range { remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"] } }
如果事件具有字段 "somefield" == "hello"
,则此过滤器在成功时会删除标签 foo_hello
(如果存在)。第二个示例还会删除一个悲伤、不需要的标签。