De_dot 过滤器插件

编辑

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

获取帮助

编辑

有关该插件的问题,请在Discuss论坛中开一个主题。对于错误或功能请求,请在Github中开一个 issue。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵

描述

编辑

此过滤器看起来是通过将 . 字符替换为不同的分隔符来重命名字段。实际上,这是一个代价有点高的过滤器,必须将源字段内容复制到新的目标字段(其名称不再包含点),然后删除相应的源字段。

只有在没有其他选项可用时才应使用它。

De_dot 过滤器配置选项

编辑

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

设置 输入类型 必需

fields

数组

nested

布尔值

recursive

布尔值

separator

字符串

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

 

fields

编辑
  • 值类型为数组
  • 此设置没有默认值。

fields 数组应包含要操作的已知字段列表。如果未定义,将检查所有顶级字段。子字段必须在数组中手动指定。例如:["field.suffix","[foo][bar.suffix]"] 将导致 "field_suffix" 和嵌套或子字段 ["foo"]["bar_suffix"]

这是一个代价昂贵的操作。

nested

编辑

如果 nestedtrue,则创建子字段,而不是将点替换为不同的分隔符。

recursive

编辑

如果 recursivetrue,则递归检查子字段。建议仅在设置特定字段时使用此选项,因为这是一个代价昂贵的操作。

separator

编辑

用此值替换点。

通用选项

编辑

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

add_field

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

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

示例

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

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

add_tag

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

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

示例

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

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

enable_metric

编辑

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

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

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

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

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

periodic_flush

编辑

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

remove_field

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

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

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

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

remove_tag

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

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

示例

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

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