-
Notifications
You must be signed in to change notification settings - Fork 240
[Streams] Add enrich processor docs #5775
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.
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
Merged
mdbirnstiehl
merged 6 commits into
elastic:main
from
mdbirnstiehl:streams-enrich-processor
Apr 6, 2026
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
486c073
[Streams] Add enrich processor
mdbirnstiehl 8653405
update applies to
mdbirnstiehl f4b0553
fix link
mdbirnstiehl fd9ab2c
add applies to
mdbirnstiehl 92c1e9b
fix applies to
mdbirnstiehl 03aa471
Merge branch 'main' into streams-enrich-processor
mdbirnstiehl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
47 changes: 47 additions & 0 deletions
47
solutions/observability/streams/management/extract/enrich.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| applies_to: | ||
| serverless: ga | ||
| stack: ga 9.4+ | ||
| products: | ||
| - id: observability | ||
| - id: elasticsearch | ||
| - id: kibana | ||
| - id: cloud-serverless | ||
| - id: cloud-hosted | ||
| - id: cloud-enterprise | ||
| - id: cloud-kubernetes | ||
| - id: elastic-stack | ||
| --- | ||
|
|
||
| # Enrich processor [streams-enrich-processor] | ||
|
|
||
| The **Enrich** processor adds data from an existing [enrich policy](elasticsearch://reference/enrich-processor/enrich-processor.md) to incoming documents during processing. Use it to look up and append supplemental data, such as geographic coordinates from an IP address or account details from a user ID, without modifying the original source. | ||
|
|
||
| Before using the enrich processor, you must have at least one enrich policy configured in {{es}}. Refer to [Enrich your data](/manage-data/ingest/transform-enrich/data-enrichment.md) for setup instructions. | ||
|
|
||
| To enrich documents: | ||
|
|
||
| 1. Select **Create** → **Create processor**. | ||
| 1. Select **Enrich** from the **Processor** menu. | ||
| 1. Select an **Enrich policy** from the list of available policies. | ||
| 1. Set **Target field** to the field where the enriched data is stored. | ||
|
|
||
| This functionality uses the {{es}} [Enrich processor](elasticsearch://reference/enrich-processor/enrich-processor.md) internally, but you configure it in Streamlang. Streamlang doesn't always have 1:1 parity with the ingest processor options and behavior. Refer to [Processor limitations and inconsistencies](../extract.md#streams-processor-inconsistencies). | ||
|
|
||
| ## YAML reference [streams-enrich-yaml-reference] | ||
|
|
||
| In [YAML mode](../extract.md#streams-editing-yaml-mode), configure the enrich processor using the following parameters. For the complete Streamlang syntax, refer to the [Streamlang reference](../streamlang.md). | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| | --- | --- | --- | --- | | ||
| | `policy_name` | string | Yes | The name of the enrich policy to use. | | ||
| | `to` | string | Yes | Target field for the enriched data. | | ||
| | `override` | boolean | No | When `true`, overwrite pre-existing non-null field values. Defaults to `true`. | | ||
| | `ignore_missing` | boolean | No | When `true`, skip this processor if the source field is missing. | | ||
|
|
||
| ```yaml | ||
| - action: enrich | ||
| policy_name: ip_location | ||
| to: attributes.geo | ||
| override: true | ||
| ``` | ||
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.