Java_uuid 过滤器插件编辑

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

获取帮助编辑

有关插件的问题,请在 论坛 中打开一个主题。对于错误或功能请求,请在 Github 中打开一个问题。

描述编辑

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

如果您需要为每个事件生成一个唯一的字符串,即使相同的输入被多次处理,这将非常有用。如果您希望每次处理具有相同内容的事件时生成相同的字符串(即哈希值),则应使用 指纹过滤器

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

Java_uuid 过滤器配置选项编辑

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

设置 输入类型 必需

覆盖

布尔值

目标

字符串

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

 

overwrite编辑

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

示例

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

target编辑

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

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

示例

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

通用选项编辑

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

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编辑

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

id编辑

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

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

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

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

periodic_flush编辑

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

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