Fixes table in Data Prepper write_json processor #7518
Merged
Conversation
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
Signed-off-by: Heather Halter <[email protected]>
hdhalter
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
Naarcha-AWS
approved these changes
Jun 27, 2024
| @@ -13,6 +13,6 @@ The `write_json` processor converts an object in an event into a JSON string. Yo | |||
|
|
|||
| | Option | Description | Example | | |||
| | :--- | :--- | :--- | | |||
| | source | Mandatory field that specifies the name of the field in the event containing the message or object to be parsed. | If `source` is set to `"message"` and the input is `{"message": {"key1":"value1", "key2":{"key3":"value3"}}`, then the `write_json` processor generates `{"message": "{\"key1\":\"value`\", \"key2\":"{\"key3\":\"value3\"}"}"`. | |||
| | target | An optional field that specifies the name of the field in which the resulting JSON string should be stored. If `target` is not specified, then the `source` field is used. | |||
| | source | Mandatory field that specifies the name of the field in the event containing the message or object to be parsed. | If `source` is set to `"message"` and the input is `{"message": {"key1":"value1", "key2":{"key3":"value3"}}}`, then the `write_json` processor generates `{"message": "{\"key1\":\"value\", \"key2\":{\"key3\":\"value3\"}}"}`. | |||
There was a problem hiding this comment.
Is there a reason the example needed to change? Also, adding the line at the end will fix the table.
Suggested change
| | source | Mandatory field that specifies the name of the field in the event containing the message or object to be parsed. | If `source` is set to `"message"` and the input is `{"message": {"key1":"value1", "key2":{"key3":"value3"}}}`, then the `write_json` processor generates `{"message": "{\"key1\":\"value\", \"key2\":{\"key3\":\"value3\"}}"}`. | |
| | source | Mandatory field that specifies the name of the field in the event containing the message or object to be parsed. | If `source` is set to `"message"` and the input is `{"message": {"key1":"value1", "key2":{"key3":"value3"}}}`, then the `write_json` processor generates `{"message": "{\"key1\":\"value\", \"key2\":{\"key3\":\"value3\"}"}"`. | |
There was a problem hiding this comment.
I was trying to fix the formatting:
There was a problem hiding this comment.
@dlvenable is going to take a look and help clarify.
dlvenable
approved these changes
Jul 3, 2024
dlvenable
requested changes
Jul 3, 2024
| @@ -13,6 +13,6 @@ The `write_json` processor converts an object in an event into a JSON string. Yo | |||
|
|
|||
| | Option | Description | Example | | |||
| | :--- | :--- | :--- | | |||
| | source | Mandatory field that specifies the name of the field in the event containing the message or object to be parsed. | If `source` is set to `"message"` and the input is `{"message": {"key1":"value1", "key2":{"key3":"value3"}}`, then the `write_json` processor generates `{"message": "{\"key1\":\"value`\", \"key2\":"{\"key3\":\"value3\"}"}"`. | |||
| | target | An optional field that specifies the name of the field in which the resulting JSON string should be stored. If `target` is not specified, then the `source` field is used. | |||
| | source | Mandatory field that specifies the name of the field in the event containing the message or object to be parsed. | If `source` is set to `"message"` and the input is `{"message": {"key1":"value1", "key2":{"key3":"value3"}}}`, then the `write_json` processor generates `{"message": "{\"key1\":\"value\", \"key2\":{\"key3\":\"value3\"}}"}`. | |||
There was a problem hiding this comment.
I just noticed two small errors. This should be:
"{\"key1\":\"value1\",\"key2\":{\"key3\":\"value3\"}}"
There was a problem hiding this comment.
To clarify, the part that is generated should be:
"{\"key1\":\"value1\",\"key2\":{\"key3\":\"value3\"}}"
You have a value instead of value1 and also a space. The string will not have any spaces, and this may be a significant change.
dlvenable
reviewed
Jul 3, 2024
| @@ -13,6 +13,6 @@ The `write_json` processor converts an object in an event into a JSON string. Yo | |||
|
|
|||
| | Option | Description | Example | | |||
| | :--- | :--- | :--- | | |||
| | source | Mandatory field that specifies the name of the field in the event containing the message or object to be parsed. | If `source` is set to `"message"` and the input is `{"message": {"key1":"value1", "key2":{"key3":"value3"}}`, then the `write_json` processor generates `{"message": "{\"key1\":\"value`\", \"key2\":"{\"key3\":\"value3\"}"}"`. | |||
| | target | An optional field that specifies the name of the field in which the resulting JSON string should be stored. If `target` is not specified, then the `source` field is used. | |||
| | source | Mandatory field that specifies the name of the field in the event containing the message or object to be parsed. | If `source` is set to `"message"` and the input is `{"message": {"key1":"value1", "key2":{"key3":"value3"}}}`, then the `write_json` processor generates `{"message": "{\"key1\":\"value\", \"key2\":{\"key3\":\"value3\"}}"}`. | |||
There was a problem hiding this comment.
Also, we might want to reword this.
then the
write_jsonprocessor generates
What is really happening is that write_json changes the existing event to look like what you show.
So perhaps:
then the
write_jsonoutputs the event
hdhalter
added
4 - Doc review
Naarcha-AWS
reviewed
Jul 5, 2024
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
|
@dlvenable: Mind taking another look at this one? |
dlvenable
approved these changes
Jul 10, 2024
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jul 10, 2024
* fixtable Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update write_json.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> (cherry picked from commit f2d1cd5) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
leanneeliatra
pushed a commit
to leanneeliatra/opensearch-documentation-website-forl
that referenced
this pull request
Jul 24, 2024
…7518) * fixtable Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update write_json.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: [email protected] <[email protected]>
sandervandegeijn
pushed a commit
to sandervandegeijn/documentation-website
that referenced
this pull request
Jul 30, 2024
…7518) * fixtable Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update write_json.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Sander van de Geijn <[email protected]>
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
Fixes the table and the JSON.
Issues Resolved
Closes #7457
Version
all
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.