-
Notifications
You must be signed in to change notification settings - Fork 507
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Liz Snyder <31932630+lizsnyder@users.noreply.github.com>
- Loading branch information
Showing
1 changed file
with
54 additions
and
0 deletions.
There are no files selected for viewing
54 changes: 54 additions & 0 deletions
54
_data-prepper/pipelines/configuration/processors/parse-xml.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
layout: default | ||
title: parse_xml | ||
parent: Processors | ||
grand_parent: Pipelines | ||
nav_order: 83 | ||
--- | ||
|
||
# parse_xml | ||
|
||
The `parse_xml` processor parses XML data for an event. | ||
|
||
## Configuration | ||
|
||
You can configure the `parse_xml` processor with the following options. | ||
|
||
| Option | Required | Type | Description | | ||
| :--- | :--- | :--- | :--- | | ||
| `source` | No | String | The field in the `event` that is parsed. Default value is `message`. | | ||
| `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. There is no `pointer` 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`. If the key that is pointed to already exists in the `event` and the `destination` is the root, then the pointer uses the entire path of the key. | | ||
| `tags_on_failure` | No | String | A list of strings that specify the tags to be set in the event that the processors fails or an unknown exception occurs while parsing. | ||
|
||
## Usage | ||
|
||
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: | ||
|
||
```yaml | ||
parse-xml-pipeline: | ||
source: | ||
stdin: | ||
processor: | ||
- parse_xml: | ||
source: "my_xml" | ||
sink: | ||
- stdout: | ||
``` | ||
{% include copy.html %} | ||
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" } | ||
``` |