克隆过滤器插件
编辑克隆过滤器插件
编辑- 插件版本: v4.2.0
- 发布日期: 2021-11-10
- 更新日志
有关其他版本,请参阅版本化插件文档。
获取帮助
编辑有关插件的问题,请在Discuss论坛中打开一个主题。 对于错误或功能请求,请在Github中打开一个问题。 有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵。
描述
编辑克隆过滤器用于复制事件。将为克隆列表中的每种类型创建一个克隆。原始事件保持不变,并且 type
字段将添加到克隆中。创建的事件将作为普通事件插入到管道中,并将由其余的管道配置(从生成它们的过滤器开始,即此插件)处理。
事件元数据和 Elastic 通用模式 (ECS)
编辑此插件将标签添加到克隆的事件。默认情况下,标签存储在 type
字段中。启用 ECS 后,标签存储在 tags
数组字段中。
以下是 ECS 兼容模式如何影响输出。
ECS 已禁用 | ECS `v1`、`v8` | 可用性 | 描述 |
---|---|---|---|
类型 |
标签 |
始终 |
克隆事件的标签 |
克隆过滤器配置选项
编辑此插件支持以下配置选项,以及稍后描述的常用选项。
设置 | 输入类型 | 必需 |
---|---|---|
是 |
||
否 |
另请参阅常用选项以获取所有过滤器插件支持的选项列表。
clones
编辑- 这是一个必填设置。
- 值类型为数组
- 此设置没有默认值。
- 当 ECS 禁用时,将创建一个新的克隆,其
type
为此列表中给定的值 - 当 ECS 启用时,将创建一个新的克隆,其
tags
为此列表中给定的值
注意:设置一个空数组将不会创建任何克隆。将记录一条警告消息。
ecs_compatibility
编辑- 值类型为字符串
-
支持的值为
-
disabled
:不使用 ECS 兼容的字段名称 -
v1
、v8
:使用与 Elastic 通用模式兼容的字段
-
-
默认值取决于运行的 Logstash 版本
- 当 Logstash 提供
pipeline.ecs_compatibility
设置时,其值用作默认值 - 否则,默认值为
disabled
。
- 当 Logstash 提供
控制此插件与Elastic 通用模式 (ECS) 的兼容性。 此设置的值会影响clones
的行为
示例
filter { clone { clones => ["sun", "moon"] } }
ECS 已禁用
{ "@version" => "1", "sequence" => 0, "message" => "Hello World!", "@timestamp" => 2021-03-24T11:20:36.226Z, "host" => "example.com" } { "@version" => "1", "sequence" => 0, "message" => "Hello World!", "@timestamp" => 2021-03-24T11:20:36.226Z, "type" => "sun", "host" => "example.com" } { "@version" => "1", "sequence" => 0, "message" => "Hello World!", "@timestamp" => 2021-03-24T11:20:36.226Z, "type" => "moon", "host" => "example.com" }
ECS 已启用
{ "sequence" => 0, "@timestamp" => 2021-03-23T20:25:10.042Z, "message" => "Hello World!", "@version" => "1", "host" => "example.com" } { "tags" => [ [0] "sun" ], "sequence" => 0, "@timestamp" => 2021-03-23T20:25:10.042Z, "message" => "Hello World!", "@version" => "1", "host" => "example.com" } { "tags" => [ [0] "moon" ], "sequence" => 0, "@timestamp" => 2021-03-23T20:25:10.042Z, "message" => "Hello World!", "@version" => "1", "host" => "example.com" }
常用选项
编辑所有过滤器插件都支持以下配置选项
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field
编辑- 值类型为哈希
- 默认值为
{}
如果此过滤器成功,则将任意字段添加到此事件。字段名称可以是动态的,并且可以使用 %{field}
包括事件的一部分。
示例
filter { clone { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" } } }
# You can also add multiple fields at once: filter { clone { add_field => { "foo_%{somefield}" => "Hello world, from %{host}" "new_field" => "new_static_value" } } }
如果事件具有字段 "somefield" == "hello"
,则此过滤器在成功时,如果存在,将添加字段 foo_hello
,其值如上所述,并且 %{host}
部分将替换为事件中的该值。第二个示例还将添加硬编码字段。
add_tag
编辑- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则将任意标签添加到事件。标签可以是动态的,并且可以使用 %{field}
语法包括事件的一部分。
示例
filter { clone { add_tag => [ "foo_%{somefield}" ] } }
# You can also add multiple tags at once: filter { clone { add_tag => [ "foo_%{somefield}", "taggedy_tag"] } }
如果事件具有字段 "somefield" == "hello"
,则此过滤器在成功时将添加标签 foo_hello
(第二个示例当然会添加 taggedy_tag
标签)。
id
编辑- 值类型为字符串
- 此设置没有默认值。
向插件配置添加唯一的 ID
。如果未指定 ID,Logstash 将生成一个。强烈建议在您的配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有 2 个克隆过滤器。在这种情况下添加命名 ID 将有助于在使用监视 API 时监视 Logstash。
filter { clone { id => "ABC" } }
id
字段中的变量替换仅支持环境变量,不支持使用来自密钥存储的值。
remove_field
编辑- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则从此事件中删除任意字段。字段名称可以是动态的,并且可以使用 %{field} 包括事件的一部分 示例
filter { clone { remove_field => [ "foo_%{somefield}" ] } }
# You can also remove multiple fields at once: filter { clone { remove_field => [ "foo_%{somefield}", "my_extraneous_field" ] } }
如果事件具有字段 "somefield" == "hello"
,则此过滤器在成功时,如果存在,将删除名为 foo_hello
的字段。第二个示例将删除一个额外的非动态字段。
remove_tag
编辑- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则从此事件中删除任意标签。标签可以是动态的,并且可以使用 %{field}
语法包括事件的一部分。
示例
filter { clone { remove_tag => [ "foo_%{somefield}" ] } }
# You can also remove multiple tags at once: filter { clone { remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"] } }
如果事件具有字段 "somefield" == "hello"
,则此过滤器在成功时,如果存在,将删除标签 foo_hello
。第二个示例还将删除一个不需要的标签。