Json_encode 过滤器插件
编辑Json_encode 过滤器插件
编辑- 插件版本：v3.0.3
- 发布日期：2017-11-07
- 更改日志
对于其他版本，请参阅 版本化插件文档。
安装
编辑对于默认情况下不包含的插件，可以通过运行 bin/logstash-plugin install logstash-filter-json_encode 轻松安装。有关更多详细信息，请参阅 使用插件。
获取帮助
编辑有关插件的问题，请在 Discuss 论坛中发布主题。对于错误或功能请求，请在 Github 中提交问题。有关 Elastic 支持的插件列表，请查阅 Elastic 支持矩阵。
描述
编辑JSON 编码过滤器。获取一个字段并将其序列化为 JSON。
如果未指定目标，则源字段将被 JSON 文本覆盖。
例如，如果您有一个名为 foo 的字段，并且您希望将 JSON 编码的字符串存储在 bar 中，请执行以下操作
filter {
json_encode {
source => "foo"
target => "bar"
}
}
常见选项
编辑所有过滤器插件都支持这些配置选项
| 设置 | 输入类型 | 必填 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field
编辑- 值类型为 哈希
- 默认值为
{}
如果此过滤器成功，则将任何任意字段添加到此事件。字段名称可以是动态的，并包含使用 %{field} 的事件部分。
示例
filter {
json_encode {
add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
}
}
# You can also add multiple fields at once:
filter {
json_encode {
add_field => {
"foo_%{somefield}" => "Hello world, from %{host}"
"new_field" => "new_static_value"
}
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加字段 foo_hello（如果存在），其值为上述值，并且 %{host} 部分将替换为事件中的该值。第二个示例还将添加一个硬编码字段。
add_tag
编辑- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则将任意标签添加到事件。标签可以是动态的，并包含使用 %{field} 语法构建的事件部分。
示例
filter {
json_encode {
add_tag => [ "foo_%{somefield}" ]
}
}
# You can also add multiple tags at once:
filter {
json_encode {
add_tag => [ "foo_%{somefield}", "taggedy_tag"]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加标签 foo_hello（当然，第二个示例将添加 taggedy_tag 标签）。
id
编辑- 值类型为 字符串
- 此设置没有默认值。
向插件配置添加唯一的 ID。如果未指定 ID，Logstash 将生成一个。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 json_encode 过滤器。在这种情况下，添加命名 ID 将有助于在使用监控 API 监控 Logstash 时提供帮助。
filter {
json_encode {
id => "ABC"
}
}
id 字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。
remove_field
编辑- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并包含使用 %{field} 示例的事件部分
filter {
json_encode {
remove_field => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple fields at once:
filter {
json_encode {
remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除名称为 foo_hello 的字段（如果存在）。第二个示例将删除一个额外的非动态字段。
remove_tag
编辑- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则从事件中删除任意标签。标签可以是动态的，并包含使用 %{field} 语法构建的事件部分。
示例
filter {
json_encode {
remove_tag => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple tags at once:
filter {
json_encode {
remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除标签 foo_hello（如果存在）。第二个示例也将删除一个令人沮丧的、不需要的标签。