« Useragent 过滤器插件 Wurfl_device_detection 过滤器插件 »

› ›

Uuid 过滤器插件

编辑

Uuid 过滤器插件

编辑

插件版本：v3.0.5
发布日期：2017-11-07
更新日志

对于其他版本，请参阅版本化插件文档。

获取帮助

编辑

如有关于插件的问题，请在Discuss论坛中开一个主题。如需报告错误或提出功能请求，请在Github中开一个 issue。有关 Elastic 支持的插件列表，请参阅Elastic 支持矩阵。

描述

编辑

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

如果您需要为每个事件生成唯一的字符串，即使多次处理相同的输入，这也会非常有用。如果您想生成每次处理具有给定内容的事件时都相同的字符串（即哈希），则应改用指纹过滤器。

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

Uuid 过滤器配置选项

编辑

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

设置	输入类型	必填
`overwrite`	布尔值	否
`target`	字符串	是

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

`overwrite`

编辑

值类型为布尔值
默认值为false

是否应将字段中当前的值（如果有）替换为生成的 UUID。默认为 false（即，如果该字段存在，并且具有任何值，则不会被替换）

示例

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

`target`

编辑

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

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

示例

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

通用选项

编辑

所有过滤器插件都支持这些配置选项

设置	输入类型	必填
`add_field`	哈希	否
`add_tag`	数组	否
`enable_metric`	布尔值	否
`id`	字符串	否
`periodic_flush`	布尔值	否
`remove_field`	数组	否
`remove_tag`	数组	否

`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`

编辑

值类型为布尔值
默认值为true

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

`id`

编辑

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

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

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

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

`periodic_flush`

编辑

值类型为布尔值
默认值为false

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

`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。第二个示例还将删除一个不必要的标签。

« Useragent 过滤器插件 Wurfl_device_detection 过滤器插件 »