Uuid 过滤器插件编辑

  • 插件版本:v3.0.5
  • 发布日期:2017-11-07
  • 变更日志

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

获取帮助编辑

如果您对插件有任何疑问,请在 Discuss 论坛中发布主题。对于错误或功能请求,请在 Github 中创建问题。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵

描述编辑

uuid 过滤器允许您生成一个 UUID 并将其作为字段添加到每个处理的事件中。

如果您需要为每个事件生成一个唯一的字符串,即使同一个输入被多次处理,这也很有用。如果您想生成每次处理具有给定内容的事件时相同的字符串(即哈希),则应使用 fingerprint 过滤器

生成的 UUID 遵循 RFC 4122 中的版本 4 定义,并将以标准十六进制字符串格式表示,例如“e08806fe-02af-406c-bbde-8a5ae4475e57”。

Uuid 过滤器配置选项编辑

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

设置 输入类型 必需

overwrite

布尔值

target

字符串

另请参阅 通用选项,了解所有过滤器插件支持的选项列表。

 

overwrite编辑

如果字段中的值当前(如果有)应该被生成的 UUID 覆盖。默认为 false(即如果字段存在,并且具有任何值,则不会被覆盖)

示例

   filter {
      uuid {
        target    => "uuid"
        overwrite => true
      }
   }

target编辑

  • 这是一个必需的设置。
  • 值类型为 字符串
  • 此设置没有默认值。

选择应存储生成的 UUID 的字段的名称。

示例

    filter {
      uuid {
        target => "uuid"
      }
    }

通用选项编辑

以下配置选项由所有过滤器插件支持

add_field编辑

  • 值类型为 哈希
  • 默认值为 {}

如果此过滤器成功,则将任何任意字段添加到此事件。字段名称可以是动态的,并使用 %{field} 包含事件的一部分。

示例

    filter {
      uuid {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }
    # You can also add multiple fields at once:
    filter {
      uuid {
        add_field => {
          "foo_%{somefield}" => "Hello world, from %{host}"
          "new_field" => "new_static_value"
        }
      }
    }

如果事件具有字段 "somefield" == "hello",则此过滤器在成功时将添加字段 foo_hello(如果存在),其值为上述值,并且 %{host} 部分将被事件中的该值替换。第二个示例还将添加一个硬编码字段。

add_tag编辑

  • 值类型为 数组
  • 默认值为 []

如果此过滤器成功,则将任意标签添加到事件。标签可以是动态的,并使用 %{field} 语法包含事件的一部分。

示例

    filter {
      uuid {
        add_tag => [ "foo_%{somefield}" ]
      }
    }
    # You can also add multiple tags at once:
    filter {
      uuid {
        add_tag => [ "foo_%{somefield}", "taggedy_tag"]
      }
    }

如果事件具有字段 "somefield" == "hello",则此过滤器在成功时将添加标签 foo_hello(第二个示例当然也会添加 taggedy_tag 标签)。

enable_metric编辑

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

id编辑

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

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

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

id 字段中的变量替换仅支持环境变量,不支持使用来自秘密存储的值。

periodic_flush编辑

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

remove_field编辑

  • 值类型为 数组
  • 默认值为 []

如果此过滤器成功,则从此事件中删除任意字段。字段名称可以是动态的,并使用 %{field} 示例包含事件的一部分

    filter {
      uuid {
        remove_field => [ "foo_%{somefield}" ]
      }
    }
    # You can also remove multiple fields at once:
    filter {
      uuid {
        remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
      }
    }

如果事件具有字段 "somefield" == "hello",则此过滤器在成功时将删除名为 foo_hello 的字段(如果存在)。第二个示例将删除一个额外的非动态字段。

remove_tag编辑

  • 值类型为 数组
  • 默认值为 []

如果此过滤器成功,则从事件中删除任意标签。标签可以是动态的,并使用 %{field} 语法包含事件的一部分。

示例

    filter {
      uuid {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }
    # You can also remove multiple tags at once:
    filter {
      uuid {
        remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
      }
    }

如果事件具有字段 "somefield" == "hello",则此过滤器在成功时将删除标签 foo_hello(如果存在)。第二个示例还将删除一个令人沮丧的、不需要的标签。