› ›

Java_uuid 过滤器插件

编辑

Java_uuid 过滤器插件

编辑

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

获取帮助

编辑

如有任何关于插件的问题，请在 Discuss 论坛中发帖提问。如发现 bug 或有功能请求，请在 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`	hash	否
`add_tag`	array	否
`enable_metric`	布尔值	否
`id`	字符串	否
`periodic_flush`	布尔值	否
`remove_field`	array	否
`remove_tag`	array	否

`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，其值为上述值，并将 %{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。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 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 过滤器插件 »