› ›

修改过滤器插件

编辑

修改过滤器插件

编辑

插件版本: v3.0.3
发布日期: 2017-11-07
变更日志

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

安装

编辑

对于默认未捆绑的插件，可以通过运行 bin/logstash-plugin install logstash-filter-alter 轻松安装。有关更多详细信息，请参阅使用插件。

获取帮助

编辑

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

描述

编辑

修改过滤器允许您对普通 mutate 过滤器中未包含的字段进行常规修改。

此插件提供的功能很可能会在未来的版本中合并到 mutate 过滤器中。

修改过滤器配置选项

编辑

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

设置	输入类型	必需
`coalesce`	数组	否
`condrewrite`	数组	否
`condrewriteother`	数组	否

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

`coalesce`

编辑

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

将 field_name 的值设置为其参数中第一个非空表达式。

示例

    filter {
      alter {
        coalesce => [
             "field_name", "value1", "value2", "value3", ...
        ]
      }
    }

`condrewrite`

编辑

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

如果实际内容与预期内容相等，则将字段的内容更改为指定的值。

示例

    filter {
      alter {
        condrewrite => [
             "field_name", "expected_value", "new_value",
             "field_name2", "expected_value2", "new_value2",
             ....
           ]
      }
    }

`condrewriteother`

编辑

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

如果另一个字段的内容与预期内容相等，则将字段的内容更改为指定的值。

示例

    filter {
      alter {
        condrewriteother => [
             "field_name", "expected_value", "field_name_to_change", "value",
             "field_name2", "expected_value2", "field_name_to_change2", "value2",
             ....
        ]
      }
    }

通用选项

编辑

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

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

`add_field`

编辑

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

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

示例

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

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

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

`add_tag`

编辑

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

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

示例

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

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

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

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

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

`periodic_flush`

编辑

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

以固定间隔调用过滤器刷新方法。可选。

`remove_field`

编辑

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

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

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

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

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

`remove_tag`

编辑

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

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

示例

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

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

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

« 聚合过滤器插件 Bytes 过滤器插件 »