Add JSON processor documentation #5982
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
requested review from
AMoo-Miki,
Naarcha-AWS,
hdhalter,
kolchfa-aws and
natebower
as code owners
45 tasks
|
@hdhalter We need a dev to take the first pass at drafting this content. I can support them in refining the content and getting it through the documentation process. The ingest processor template is provided with this PR, so it should help the dev get started. Thanks! |
vagimeli
changed the title
vagimeli
requested review from
dlvenable,
epugh and
stephen-crawford
as code owners
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
|
@gaobinlong This PR is ready for your technical review. Thank you. |
Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
gaobinlong
reviewed
May 31, 2024
_ingest-pipelines/processors/json.md
Outdated
| "json": { | ||
| "field": "raw_data", | ||
| "target_field": "parsed_data", | ||
| "add_to_root": false, |
There was a problem hiding this comment.
add_to_root is not needed here because it defaults to false.
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
natebower
requested changes
Jun 5, 2024
_ingest-pipelines/processors/json.md
Outdated
|
|
||
| # JSON processor | ||
|
|
||
| The `json` processor serializes a string-valued field into a map of maps, which can be useful for various data processing and enrichment tasks. |
There was a problem hiding this comment.
Is "string-valued" the right phrasing here, or should it just be "string value field"?
_ingest-pipelines/processors/json.md
Outdated
| Parameter | Required/Optional | Description | | ||
| |-----------|-----------|-----------| | ||
| `field` | Required | The name of the field containing the JSON-formatted string to be deserialized. | ||
| `target_field` | Optional | The name of the field where the deserialized JSON data will be stored. If `target_field` is unspecified, the value is stored in field. If `target_field` exists, it is overwritten. |
There was a problem hiding this comment.
The last two sentences here have me a bit confused. Can we check for clarity/accuracy?
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
commented
Jun 5, 2024
natebower
approved these changes
Jun 5, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jun 5, 2024
* Add JSON processor documentation Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add pipeline examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add parameters Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update parameters Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update json.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update json.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Address tech review feedback Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/json.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/json.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/json.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/json.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/json.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/json.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit 4b99619) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes content gap
Issues Resolved
#4647
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.