[DOCS] Improve enrich policy execute 'wait_for_completion' docs #102291
Conversation
This file contains 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
abdonpijpelink
added
>docs
|
Documentation preview: |
elasticsearchmachine
added
v8.12.0
Team:Data Management
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-data-management (Team:Data Management) |
|
Would anyone on the @elastic/es-data-management team have a moment to review this PR for correctness? |
jrodewig
approved these changes
Nov 16, 2023
docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: James Rodewig <[email protected]>
abdonpijpelink
deleted the
docs-enrich-policy-execute-wait-for-completion
branch
💚 Backport successful
|
abdonpijpelink
added a commit
to abdonpijpelink/elasticsearch
that referenced
this pull request
Nov 27, 2023
…tic#102291) * [DOCS] Improve enrich policy execute 'wait_for_completion' docs * Update docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc Co-authored-by: James Rodewig <[email protected]> --------- Co-authored-by: James Rodewig <[email protected]>
elasticsearchmachine
pushed a commit
that referenced
this pull request
Nov 27, 2023
) (#102664) * [DOCS] Improve enrich policy execute 'wait_for_completion' docs * Update docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc --------- Co-authored-by: James Rodewig <[email protected]>
timgrein
pushed a commit
to timgrein/elasticsearch
that referenced
this pull request
Nov 30, 2023
…tic#102291) * [DOCS] Improve enrich policy execute 'wait_for_completion' docs * Update docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc Co-authored-by: James Rodewig <[email protected]> --------- Co-authored-by: James Rodewig <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We've had some feedback from users trying out enrich in ES|QL, that for large source indices, executing an enrich policy can take a long time and lead to timeouts.
One way to prevent timeouts is by setting
wait_for_completiontofalse. However, this is not obvious from the documentation. This PR tries to improve that by: 1) improving the description ofwait_for_completionin the reference documentation for_execute2) adding a paragraph about this setting in the reference documentation, and 3) changing all examples of_executeto use?wait_for_completion=false.