« Mutate 过滤器插件 Range 过滤器插件 »
Elastic 文档 ›Logstash 参考 [8.16] ›过滤器插件

Prune 过滤器插件

编辑

Prune 过滤器插件

编辑
  • 插件版本: v3.0.4
  • 发布日期: 2019-09-12
  • 变更日志

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

获取帮助

编辑

如有任何关于插件的问题，请在 Discuss 论坛中发起主题讨论。对于错误或功能请求，请在 Github 中提交问题。有关 Elastic 支持的插件列表，请查阅 Elastic 支持矩阵。

描述

编辑

Prune 过滤器用于根据字段名称或值的黑白名单从事件中删除字段（名称和值也可以是正则表达式）。

例如，如果您使用 json 或 kv 过滤器创建了许多字段，并且事先不知道这些字段的名称，而您只想保留其中的一部分，那么这将非常有用。

用法帮助：要指定精确的字段名称或值，请使用正则表达式语法 ^some_name_or_value$。例如：输入数据 { "msg":"hello world", "msg_short":"hw" }

    filter {
      prune {
        whitelist_names => [ "msg" ]
      }
    }
Allows both `"msg"` and `"msg_short"` through.

同时

    filter {
      prune {
        whitelist_names => ["^msg$"]
      }
    }
Allows only `"msg"` through.

Logstash 将事件的 tags 存储为一个字段，该字段受修剪影响。请记住使用 whitelist_names => [ "^tags$" ] 在修剪后保留 tags，或使用 blacklist_values => [ "^tag_name$" ] 删除特定的 tag。

此过滤器目前仅支持对顶级字段的操作，即基于名称或值的子字段的白名单和黑名单不起作用。

Prune 过滤器配置选项

编辑

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

设置 输入类型 必填

blacklist_names

数组

否

blacklist_values

哈希表

否

interpolate

布尔值

否

whitelist_names

数组

否

whitelist_values

哈希表

否

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

 

blacklist_names

编辑
  • 值类型为 数组
  • 默认值为 ["%{[^}]+}"]

排除字段名称与指定正则表达式匹配的字段，默认情况下排除未解析的 %{field} 字符串。

    filter {
      prune {
        blacklist_names => [ "method", "(referrer|status)", "${some}_field" ]
      }
    }

blacklist_values

编辑

如果字段值与提供的正则表达式之一匹配，则排除指定的字段。如果字段值为数组，则每个数组项都与正则表达式匹配，并且匹配的数组项将被排除。

    filter {
      prune {
        blacklist_values => [ "uripath", "/index.php",
                              "method", "(HEAD|OPTIONS)",
                              "status", "^[^2]" ]
      }
    }

interpolate

编辑

触发是否应为动态值（解析 %{some_field} 时）插值配置字段和值。可能会增加一些性能开销。默认为 false。

whitelist_names

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

仅当字段名称与指定正则表达式匹配时才包含字段，默认为空列表，这意味着包含所有内容。

    filter {
      prune {
        whitelist_names => [ "method", "(referrer|status)", "${some}_field" ]
      }
    }

whitelist_values

编辑

仅当字段值与提供的正则表达式之一匹配时才包含指定的字段。如果字段值为数组，则每个数组项都与正则表达式匹配，并且仅包含匹配的数组项。默认情况下，除非其他设置将其修剪，否则会保留此设置中未列出的所有字段。

    filter {
      prune {
        whitelist_values => [ "uripath", "/index.php",
                              "method", "(GET|POST)",
                              "status", "^[^2]" ]
      }
    }

通用选项

编辑

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

设置 输入类型 必填

add_field

哈希表

否

add_tag

数组

否

enable_metric

布尔值

否

id

字符串

否

periodic_flush

布尔值

否

remove_field

数组

否

remove_tag

数组

否

add_field

编辑

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

示例

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

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

add_tag

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

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

示例

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

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

enable_metric

编辑

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

id

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

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

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

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

periodic_flush

编辑

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

remove_field

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

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

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

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

remove_tag

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

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

示例

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

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

« Mutate 过滤器插件 Range 过滤器插件 »