解码 XML
编辑解码 XML编辑
decode_xml
处理器解码存储在 field
键下的 XML 数据。它将结果输出到 target_field
。
此示例演示如何解码 message
字段中包含的 XML 字符串并将生成的字段写入文档根目录。任何已存在的字段将被覆盖。
processors: - decode_xml: field: message target_field: "" overwrite_keys: true
默认情况下,任何发生的解码错误都会停止处理链,并且错误将被添加到 error.message
字段中。要忽略所有错误并继续执行到下一个处理器,可以设置 ignore_failure: true
。要专门忽略由 field
不存在引起的失败,可以设置 ignore_missing: true
。
processors: - decode_xml: field: example target_field: xml ignore_missing: true ignore_failure: true
默认情况下,所有从 XML 转换的键的名称都将转换为小写。如果需要禁用此行为,可以使用以下示例
processors: - decode_xml: field: message target_field: xml to_lower: false
示例 XML 输入
<catalog> <book seq="1"> <author>William H. Gaddis</author> <title>The Recognitions</title> <review>One of the great seminal American novels of the 20th century.</review> </book> </catalog>
将产生以下输出
{ "xml": { "catalog": { "book": { "author": "William H. Gaddis", "review": "One of the great seminal American novels of the 20th century.", "seq": "1", "title": "The Recognitions" } } } }
支持的配置选项为
-
field
- (必填) 包含 XML 的源字段。默认为
message
。 -
target_field
- (可选) 将解码的 XML 写入的字段。默认情况下,解码的 XML 对象将替换从中读取的字段。要将解码的 XML 字段合并到事件的根目录,请使用空字符串指定
target_field
(target_field: ""
)。请注意,null
值 (target_field:
) 被视为未设置字段。 -
overwrite_keys
- (可选) 一个布尔值,指定是否用解码的 XML 对象中的键覆盖事件中已存在的键。默认值为
true
。 -
to_lower
- (可选) 将所有键转换为小写。接受
true
或false
。默认值为true
。 -
document_id
- (可选) 用作文档 ID 的 XML 键。如果配置,该字段将从原始 XML 文档中删除并存储在
@metadata._id
中。 -
ignore_missing
- (可选) 如果为
true
,则处理器在指定字段不存在时不会返回错误。默认为false
。 -
ignore_failure
- (可选) 忽略处理器产生的所有错误。默认为
false
。
有关支持条件的列表,请参阅 条件。