expanding on join data prepper docs #11502
Conversation
Signed-off-by: Anton Rubin <[email protected]>
AntonEliatra
requested review from
AMoo-Miki,
dlvenable,
epugh,
kolchfa-aws,
natebower and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
|
@dlvenable could you please review this PR |
dlvenable
left a comment
dlvenable
left a comment
There was a problem hiding this comment.
Thanks @AntonEliatra , overall this looks good. I have a few small comments.
_data-prepper/pipelines/join.md
Outdated
| ## Parameters | ||
|
|
||
| You can specify an alternative delimiter inside the expression. For example, `join("-", /source)` joins each source field using a hyphen `-` as the delimiter. | ||
| - **delimiter** (string, optional): The text placed between elements. Examples: `","`, `" | "`, `"; "`. Default is `","`. |
There was a problem hiding this comment.
Maybe we should use "string" instead of "text" as this is what we call these types. Thoughts?
_data-prepper/pipelines/join.md
Outdated
| - **string**: All elements concatenated with the chosen delimiter. | ||
|
|
||
| ## Quick examples | ||
| - `join("-", /tags)` returns `"prod-api-us"` for `tags: ["prod","api","us"]` |
There was a problem hiding this comment.
Maybe we should avoid using tags as an example. Tags is a different concept and this could cause confusion. Perhaps change change to labels. Also, see line 35 and update that example as well.
_data-prepper/pipelines/join.md
Outdated
| ## Example | ||
| The following pipeline ingests JSON events using the HTTP source, uses `add_entries` with `join()` to build two new fields, `tags_csv` and `authors_pipe`: |
There was a problem hiding this comment.
Again, let's not use "tags" as the example. Maybe "labels" or something more specific.
Signed-off-by: Anton Rubin <[email protected]>
|
@dlvenable thats updated now |
3 participants
Description
expanding on join data prepper docs
Version
all
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.