Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifies that Data Prepper select_entries processor does not remove events #6917

Merged
merged 3 commits into from
Apr 19, 2024
Merged

Clarifies that Data Prepper select_entries processor does not remove events #6917

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7093fde
Adds some clarity to the Data Prepper select_entries processor docume…
dlvenable Apr 5, 2024
99ac828
Apply suggestions from code review
Naarcha-AWS Apr 18, 2024
f7d6279
Apply suggestions from code review
Naarcha-AWS Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions _data-prepper/pipelines/configuration/processors/select-entries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ nav_order: 59

# select_entries

The `select_entries` processor selects entries from a Data Prepper event. Only the selected entries will remain in the event, and all other entries will be removed from the event.
The `select_entries` processor selects entries from a Data Prepper event.
Only the selected entries will remain in the event, and all other entries will be removed from the event.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
This processor will not remove any events from the pipeline.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

## Configuration

Expand All @@ -17,7 +19,7 @@ You can configure the `select_entries` processor using the following options.
| Option | Required | Description |
| :--- | :--- | :--- |
| `include_keys` | Yes | A list of keys to be selected from an event. |
| `select_when` | No | A [conditional expression](https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/), such as `/some-key == "test"'`, that will be evaluated to determine whether the processor will be run on the event. |
| `select_when` | No | A [conditional expression](https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/), such as `/some-key == "test"'`, that will be evaluated to determine whether the processor will be run on the event. If the condition is false, then the event will continue through the pipeline unmodified with all the original fields. |
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

### Usage

Expand Down
Loading