Skip to content

Align enrich node settings with the reference page #7066

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

Open
charlotte-hoblik wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Align enrich node settings with the reference page #7066

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions manage-data/ingest/transform-enrich/set-up-an-enrich-processor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,14 +140,23 @@ The `enrich` processor has node settings for enrich coordinator and enrich polic
The enrich coordinator supports the following node settings:

`enrich.cache_size`
: Maximum size of the cache that caches searches for enriching documents. The size can be specified in three units: the raw number of cached searches (for example, `1000`), an absolute size in bytes (for example, `100Mb`), or a percentage of the max heap space of the node (for example, `1%`). Both for the absolute byte size and the percentage of heap space, {{es}} does not guarantee that the enrich cache size will adhere exactly to that maximum, as {{es}} uses the byte size of the serialized search response which is is a good representation of the used space on the heap, but not an exact match. Defaults to `1%`. There is a single cache for all enrich processors in the cluster.
: Maximum size of the cache that stores searches used to enrich documents. You can specify the size in three units:

* A raw number of cached searches, for example `1000`.
* An absolute size in bytes, for example `100Mb`.
* A percentage of the node's maximum heap space, for example `1%`.

If you specify an absolute byte size or a heap percentage, {{es}} doesn't guarantee that the cache stays exactly within the configured maximum. The cache size is measured using the byte size of the serialized search response, which is a good approximation of actual heap usage but not an exact match. There is a single cache for all enrich processors in the cluster. Defaults to `1%`.

`enrich.coordinator_proxy.max_concurrent_requests`
: Maximum number of concurrent [multi-search requests]({{es-apis}}operation/operation-msearch) to run when enriching documents. Defaults to `8`.

`enrich.coordinator_proxy.max_lookups_per_request`
: Maximum number of searches to include in a [multi-search request]({{es-apis}}operation/operation-msearch) when enriching documents. Defaults to `128`.

`enrich.coordinator_proxy.queue_capacity`
: Coordinator queue capacity. Defaults to `max_concurrent_requests * max_lookups_per_request`.

@bmorelli25 bmorelli25 Jun 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This defines the setting, but we're not really telling the user what it controls or how/when to tune it. Is there anything more we can offer here to help the reader?


The enrich policy executor supports the following node settings:

`enrich.fetch_size`
Expand All @@ -160,6 +169,6 @@ The enrich policy executor supports the following node settings:
: How often {{es}} checks whether unused enrich indices can be deleted. Defaults to `15m`.

`enrich.max_concurrent_policy_executions`
: Maximum number of enrich policies to execute concurrently. Defaults to `50`.
: Maximum number of enrich policies to run concurrently. Defaults to `50`.


Loading