Update documentation for delete_entries and select_entries processors #11476
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: Kennedy Onyia <[email protected]>
…ude_keys_regex feature Signed-off-by: Kennedy Onyia <[email protected]>
kennedy-onyia
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. |
kolchfa-aws
added
Tech review
dlvenable
reviewed
Nov 3, 2025
Member
dlvenable
left a comment
dlvenable
left a comment
There was a problem hiding this comment.
Thank you @kennedy-onyia for the documentation update!
Also, check the errors reported by the "Style Check" job.
| the exact keys to delete. To delete keys that match a regular expression pattern, use the `with_keys_regex` field. You can | ||
| prevent deletion of specific events when using regular expressions by configuring the `exclude_from_regex` field. | ||
|
|
||
| To use both `with_keys` and `with_keys_regex` in the same configuration, define them under the `entries` field. |
Member
There was a problem hiding this comment.
I think this is a little confusing. Do you mean to say that the pipeline author would need to create two different entries?
Contributor
Author
There was a problem hiding this comment.
lol yes. i'll modify the grammar to make it more clear
… to clarify new features. Signed-off-by: Kennedy Onyia <[email protected]>
kolchfa-aws
reviewed
Nov 6, 2025
Collaborator
kolchfa-aws
left a comment
kolchfa-aws
left a comment
There was a problem hiding this comment.
Thank you, @kennedy-onyia! Please see my comments and let me know if you have any questions. Intro sentences for the code have to explain what the user should notice in the results. Thanks!
_data-prepper/pipelines/configuration/processors/delete-entries.md
Outdated
Show resolved
Hide resolved
_data-prepper/pipelines/configuration/processors/delete-entries.md
Outdated
Show resolved
Hide resolved
_data-prepper/pipelines/configuration/processors/delete-entries.md
Outdated
Show resolved
Hide resolved
_data-prepper/pipelines/configuration/processors/delete-entries.md
Outdated
Show resolved
Hide resolved
_data-prepper/pipelines/configuration/processors/delete-entries.md
Outdated
Show resolved
Hide resolved
_data-prepper/pipelines/configuration/processors/select-entries.md
Outdated
Show resolved
Hide resolved
_data-prepper/pipelines/configuration/processors/select-entries.md
Outdated
Show resolved
Hide resolved
_data-prepper/pipelines/configuration/processors/select-entries.md
Outdated
Show resolved
Hide resolved
_data-prepper/pipelines/configuration/processors/select-entries.md
Outdated
Show resolved
Hide resolved
_data-prepper/pipelines/configuration/processors/select-entries.md
Outdated
Show resolved
Hide resolved
kolchfa-aws
added
Doc review
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]>
…s.md Signed-off-by: kolchfa-aws <[email protected]>
…s.md Signed-off-by: kolchfa-aws <[email protected]>
…s.md Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
added
Editorial review
natebower
reviewed
Nov 10, 2025
_data-prepper/pipelines/configuration/processors/delete-entries.md
Outdated
Show resolved
Hide resolved
natebower
reviewed
Nov 10, 2025
_data-prepper/pipelines/configuration/processors/select-entries.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Nathan Bower <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Nov 10, 2025
…#11476) * Update delete_entries processor to add new features Signed-off-by: Kennedy Onyia <[email protected]> * update select_entries processor documentation to account for new include_keys_regex feature Signed-off-by: Kennedy Onyia <[email protected]> * fix style check errors and include additional pipeline configurations to clarify new features. Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Signed-off-by: kolchfa-aws <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Signed-off-by: kolchfa-aws <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Signed-off-by: Nathan Bower <[email protected]> --------- Signed-off-by: Kennedy Onyia <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 1d239cc) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
aryasoni98
pushed a commit
to aryasoni98/documentation-website
that referenced
this pull request
Nov 11, 2025
…opensearch-project#11476) * Update delete_entries processor to add new features Signed-off-by: Kennedy Onyia <[email protected]> * update select_entries processor documentation to account for new include_keys_regex feature Signed-off-by: Kennedy Onyia <[email protected]> * fix style check errors and include additional pipeline configurations to clarify new features. Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/select-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Signed-off-by: kolchfa-aws <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Signed-off-by: kolchfa-aws <[email protected]> * Update _data-prepper/pipelines/configuration/processors/delete-entries.md Signed-off-by: kolchfa-aws <[email protected]> * Apply suggestions from code review Signed-off-by: Nathan Bower <[email protected]> --------- Signed-off-by: Kennedy Onyia <[email protected]> Signed-off-by: Kennedy Onyia <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Arya Soni <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
Include the new regex feature in both documentations
Version
All
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.