截断过滤器插件
编辑截断过滤器插件
编辑- 插件版本: v1.0.6
- 发布于: 2023-05-10
- 更新日志
对于其他版本，请参阅版本化插件文档。
获取帮助
编辑有关该插件的问题，请在Discuss论坛中开一个主题。对于错误或功能请求，请在Github中打开一个问题。有关 Elastic 支持的插件列表，请查阅Elastic 支持矩阵。
描述
编辑允许您截断长度超过给定长度的字段。
这是按字节值截断，而不是按字符计数截断。实际上，这意味着截断后的长度介于 length_bytes 和 length_bytes - 6 之间（UTF-8 支持最多 6 字节字符）。
截断过滤器配置选项
编辑此插件支持以下配置选项以及稍后描述的通用选项。
另请参阅通用选项，获取所有过滤器插件支持的选项列表。
通用选项
编辑所有过滤器插件都支持这些配置选项
添加_字段
编辑- 值类型为 哈希
- 默认值为
{}
如果此过滤器成功，则将任何任意字段添加到此事件。字段名称可以是动态的，并且可以使用 %{field} 来包括事件的某些部分。
示例
filter {
truncate {
add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
}
}
# You can also add multiple fields at once:
filter {
truncate {
add_field => {
"foo_%{somefield}" => "Hello world, from %{host}"
"new_field" => "new_static_value"
}
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加字段 foo_hello（如果存在），其值如上所示，并且 %{host} 部分将替换为事件中的该值。第二个示例还将添加一个硬编码的字段。
添加_标签
编辑- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则将任意标签添加到事件。标签可以是动态的，并且可以使用 %{field} 语法来包括事件的某些部分。
示例
filter {
truncate {
add_tag => [ "foo_%{somefield}" ]
}
}
# You can also add multiple tags at once:
filter {
truncate {
add_tag => [ "foo_%{somefield}", "taggedy_tag"]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加标签 foo_hello（第二个示例当然会添加 taggedy_tag 标签）。
id
编辑- 值类型为 字符串
- 此设置没有默认值。
向插件配置添加唯一的 ID。如果未指定 ID，Logstash 将生成一个 ID。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时，例如，如果您有 2 个截断过滤器，这将特别有用。在这种情况下添加命名的 ID 将有助于在使用监视 API 时监视 Logstash。
filter {
truncate {
id => "ABC"
}
}
id 字段中的变量替换仅支持环境变量，不支持使用来自秘密存储的值。
删除_字段
编辑- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并且可以使用 %{field} 来包括事件的某些部分。示例
filter {
truncate {
remove_field => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple fields at once:
filter {
truncate {
remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除名称为 foo_hello 的字段（如果存在）。第二个示例将删除一个额外的非动态字段。
删除_标签
编辑- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意标签。标签可以是动态的，并且可以使用 %{field} 语法来包括事件的某些部分。
示例
filter {
truncate {
remove_tag => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple tags at once:
filter {
truncate {
remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除标签 foo_hello（如果存在）。第二个示例也将删除一个悲伤的、不需要的标签。