-
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.
Revert "Add Parse JSON processor doc. (#3237)"
This reverts commit 1637a6f.
- Loading branch information
Showing
1 changed file
with
13 additions
and
65 deletions.
There are no files selected for viewing
78 changes: 13 additions & 65 deletions
78
_data-prepper/pipelines/configuration/processors/parse-json.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 |
---|---|---|
@@ -1,79 +1,27 @@ | ||
--- | ||
layout: default | ||
title: parse_json | ||
title: Parse JSON | ||
parent: Processors | ||
grand_parent: Pipelines | ||
nav_order: 45 | ||
--- | ||
|
||
# parse_json | ||
# Parse JSON | ||
|
||
The `parse_json` processor parses JSON data for an event, including any nested fields. The processor extracts the JSON pointer data and adds the input event to the extracted fields. | ||
## Overview | ||
|
||
The `parse_json` processor parses JSON data for an event, including any nested fields. The following table describes several optional parameters you can configure in the `parse_json` processor. | ||
|
||
## Configuration | ||
Option | Required | Type | Description | ||
:--- | :--- | :--- | :--- | ||
source | No | String | The field in the `Event` that will be parsed. Default value is `message`. | ||
destination | No | String | The destination field of the parsed JSON. Defaults to the root of the `Event`. Cannot be `""`, `/`, or any whitespace-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 the entire `source` is parsed. The `pointer` can access JSON Array indices as well. If the JSON Pointer is invalid then the entire `source` data is parsed into the outgoing `Event`. If the pointed-to key already exists in the `Event` and the `destination` is the root, then the pointer uses the entire path of the key. | ||
|
||
You can configure the `parse_json` processor with the following options. | ||
<!---## Configuration | ||
| Option | Required | Type | Description | | ||
| :--- | :--- | :--- | :--- | | ||
| `source` | No | String | The field in the `event` that will be parsed. Default value is `message`. | | ||
| `destination` | No | String | The destination field of the parsed JSON. Defaults to the root of the `event`. Cannot be `""`, `/`, or any whitespace-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 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. | | ||
Content will be added to this section. | ||
## Usage | ||
## Metrics | ||
To get started, create the following `pipeline.yaml` file: | ||
|
||
```yaml | ||
parse-json-pipeline: | ||
source: | ||
stdin: | ||
processor: | ||
- parse_json: | ||
sink: | ||
- stdout: | ||
``` | ||
### Basic example | ||
To test the `parse_json` processor with the previous configuration, run the pipeline and paste the following line into your console, then enter `exit` on a new line: | ||
|
||
``` | ||
{"outer_key": {"inner_key": "inner_value"}} | ||
``` | ||
{% include copy.html %} | ||
The `parse_json` processor parses the message into the following format: | ||
``` | ||
{"message": {"outer_key": {"inner_key": "inner_value"}}", "outer_key":{"inner_key":"inner_value"}}} | ||
``` | ||
### Example with a JSON pointer | ||
You can use a JSON pointer to parse a selection of the JSON data by specifying the `pointer` option in the configuration. To get started, create the following `pipeline.yaml` file: | ||
```yaml | ||
parse-json-pipeline: | ||
source: | ||
stdin: | ||
processor: | ||
- parse_json: | ||
pointer: "outer_key/inner_key" | ||
sink: | ||
- stdout: | ||
``` | ||
|
||
To test the `parse_json` processor with the pointer option, run the pipeline, paste the following line into your console, and then enter `exit` on a new line: | ||
|
||
``` | ||
{"outer_key": {"inner_key": "inner_value"}} | ||
``` | ||
{% include copy.html %} | ||
|
||
The processor parses the message into the following format: | ||
|
||
``` | ||
{"message": {"outer_key": {"inner_key": "inner_value"}}", "inner_key": "inner_value"} | ||
``` | ||
Content will be added to this section.---> |