Link Search Menu Expand Document Documentation Menu


The parse_xml processor parses XML data for an event.


You can configure the parse_xml processor with the following options.

Option Required Type Description
source No String Specifies which event field to parse.
destination No String The destination field of the parsed XML. Defaults to the root of the event. Cannot be "", /, or any white-space-only string because these are not valid event fields.
pointer No String A JSON pointer to the field to be parsed. The value is null by default, meaning that the entire source is parsed. The pointer can access JSON array indexes as well. If the JSON pointer is invalid, then the entire source data is parsed into the outgoing event object. If the key that is pointed to already exists in the event object and the destination is the root, then the pointer uses the entire path of the key.
parse_when No String Specifies under what conditions the processor should perform parsing. Default is no condition. Accepts a Data Prepper expression string following the Data Prepper Expression Syntax.
tags_on_failure No String A list of strings that specify the tags to be set if the processor fails or an unknown exception occurs while parsing.


The following examples show how to use the parse_xml processor in your pipeline.

Example: Minimum configuration

The following example shows the minimum configuration for the parse_xml processor:

    - parse_xml:
        source: "my_xml"
    - stdout:

When the input event contains the following data:

{ "my_xml": "<Person><name>John Doe</name><age>30</age></Person>" }

The processor parses the event into the following output:

{ "name": "John Doe", "age": "30" }
350 characters left

Have a question? .

Want to contribute? or .