› ›

Alter 过滤器插件

编辑

Alter 过滤器插件

编辑

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

其他版本，请参考版本化插件文档。

安装

编辑

对于非默认捆绑的插件，可以通过运行 bin/logstash-plugin install logstash-filter-alter 轻松安装。更多详情，请参考使用插件。

获取帮助

编辑

如有任何关于插件的问题，请在 Discuss 论坛发帖提问。如有bug或功能需求，请在 Github 上提交issue。如需查看 Elastic 支持的插件列表，请参考 Elastic 支持矩阵。

描述

编辑

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

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

Alter 过滤器配置选项

编辑

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

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

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

`coalesce`

编辑

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

将字段名称的值设置为其参数中第一个非空表达式。

示例

    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。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 alter 过滤器。在这种情况下，添加命名 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。第二个示例还将删除一个令人不快的、不需要的标签。

« Aggregate 过滤器插件 Bytes 过滤器插件 »