« Cipher 过滤器插件 Csv 过滤器插件 »
Elastic 文档 ›Logstash 参考 [8.14] ›过滤器插件

克隆过滤器插件

编辑

克隆过滤器插件编辑

  • 插件版本：v4.2.0
  • 发布时间：2021-11-10
  • 更新日志

有关其他版本，请参阅版本化插件文档。

获取帮助编辑

如果您对插件有任何疑问，请在论坛中开启一个主题。对于错误或功能请求，请在Github中开启一个问题。有关 Elastic 支持的插件列表，请参阅Elastic 支持矩阵。

描述编辑

克隆过滤器用于复制事件。将为克隆列表中的每种类型创建一个克隆。原始事件保持不变，并向克隆添加一个type字段。创建的事件作为普通事件插入到管道中，并将从生成它们的过滤器（即此插件）开始由剩余的管道配置进行处理。

事件元数据和 Elastic 通用模式 (ECS)编辑

此插件会向克隆的事件添加一个标签。默认情况下，标签存储在type字段中。启用 ECS 后，标签将存储在tags数组字段中。

以下是 ECS 兼容模式如何影响输出。

ECS 禁用 ECS `v1`, `v8` 可用性 描述

type

tags

始终

克隆事件的标签

克隆过滤器配置选项编辑

此插件支持以下配置选项以及稍后描述的通用选项。

设置 输入类型 必需

clones

数组

是

ecs_compatibility

字符串

否

另请参阅通用选项，以获取所有过滤器插件支持的选项列表。

 

clones编辑

  • 这是一个必需的设置。
  • 值类型为数组
  • 此设置没有默认值。
  • 当禁用 ECS 时，将使用此列表中给定值的type创建一个新的克隆
  • 当启用 ECS 时，将使用此列表中给定值的tags创建一个新的克隆

注意：设置一个空数组将不会创建任何克隆。将记录一条警告消息。

ecs_compatibility编辑

  • 值类型为字符串

  • 支持的值为

    • disabled：不使用与 ECS 兼容的字段名称
    • v1，v8：使用与 Elastic 通用模式兼容的字段

  • 默认值取决于运行的 Logstash 版本

    • 当 Logstash 提供pipeline.ecs_compatibility设置时，其值将用作默认值
    • 否则，默认值为disabled。

控制此插件与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

hash

否

add_tag

数组

否

enable_metric

布尔值

否

id

字符串

否

periodic_flush

布尔值

否

remove_field

数组

否

remove_tag

数组

否

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标签）。

enable_metric编辑

禁用或启用此特定插件实例的指标日志记录。默认情况下，我们会记录所有可以记录的指标，但您可以禁用特定插件的指标收集。

id编辑

  • 值类型为字符串
  • 此设置没有默认值。

向插件配置添加唯一的ID。如果未指定 ID，Logstash 将生成一个。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时，例如，如果您有两个克隆过滤器，这将特别有用。在这种情况下，添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

    filter {
      clone {
        id => "ABC"
      }
    }

id字段中的变量替换仅支持环境变量，不支持使用密钥库中的值。

periodic_flush编辑

定期调用过滤器刷新方法。可选。

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（如果存在）。第二个示例还将删除一个不需要的标签。

« Cipher 过滤器插件 Csv 过滤器插件 »