Clarifies that Data Prepper select_entries processor does not remove …

…events (#6917) * Adds some clarity to the Data Prepper select_entries processor documentation that events are not dropped. Signed-off-by: David Venable <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: David Venable <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]>
opensearch-project · Apr 19, 2024 · 8b71973 · 8b71973
1 parent b8211a4
commit 8b71973
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/_data-prepper/pipelines/configuration/processors/select-entries.md b/_data-prepper/pipelines/configuration/processors/select-entries.md
@@ -8,7 +8,8 @@ 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 remain in the processed event and while all other entries are removed. However, the processor does not remove any events from the Data Prepper pipeline.
 
 ## Configuration
 
@@ -17,7 +18,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 not met, then the event continues through the pipeline unmodified with all the original fields present. |
 
 ## Usage