› ›

Java_uuid 过滤器插件

编辑

Java_uuid 过滤器插件

编辑

Logstash 核心插件。 java_uuid 过滤器插件不能独立于 Logstash 安装或卸载。

获取帮助

编辑

有关此插件的问题，请在 Discuss 论坛中开启一个主题。对于错误或功能请求，请在 Github 中开启一个 issue。

描述

编辑

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

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

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

Java_uuid 过滤器配置选项

编辑

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

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

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

`overwrite`

编辑

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

确定是否应由过滤器覆盖由 target 选项指定的字段中的现有值。

示例

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

`target`

编辑

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

指定应在其中存储生成的 UUID 的字段的名称。

示例

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

通用选项

编辑

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

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

`add_field`

编辑

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

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

示例

    filter {
      java_uuid {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }

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

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

`add_tag`

编辑

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

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

示例

    filter {
      java_uuid {
        add_tag => [ "foo_%{somefield}" ]
      }
    }

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

如果事件具有字段 "somefield" == "hello"，则此过滤器成功后，将添加标记 foo_hello（第二个示例当然会添加一个 taggedy_tag 标记）。

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

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

`periodic_flush`

编辑

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

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

`remove_field`

编辑

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

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

    filter {
      java_uuid {
        remove_field => [ "foo_%{somefield}" ]
      }
    }

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

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

`remove_tag`

编辑

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

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

示例

    filter {
      java_uuid {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }

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

如果事件具有字段 "somefield" == "hello"，则此过滤器成功后，如果存在标记 foo_hello，则会删除该标记。第二个示例也将删除一个令人沮丧的、不需要的标记。

« I18n 过滤器插件 Jdbc_static 过滤器插件 »