Add timeout parameter to bulk operation #1362
Merged
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
probakowski
added
enhancement
There was a problem hiding this comment.
Thanks for your PR! The change itself looks fine but can you please add a unit-test that the timeout parameter is used by the client (see BulkIndexRunnerTests)? We should also add user-level docs for that parameter and it would be good to link to the respective section of the Elasticsearch reference docs as well there.
|
@danielmitterdorfer I added test and docs |
docs/track.rst
Outdated
| @@ -736,6 +736,7 @@ Properties | |||
| * ``on-conflict`` (optional, defaults to ``index``): Determines whether Rally should use the action ``index`` or ``update`` on id conflicts. | |||
| * ``recency`` (optional, defaults to 0): A number between [0,1] indicating whether to bias conflicting ids towards more recent ids (``recency`` towards 1) or whether to consider all ids for id conflicts (``recency`` towards 0). See the diagram below for details. | |||
| * ``detailed-results`` (optional, defaults to ``false``): Records more detailed meta-data for bulk requests. As it analyzes the corresponding bulk response in more detail, this might incur additional overhead which can skew measurement results. See the section below for the meta-data that are returned. | |||
| * ``timeout`` (optional, defaults to ``1m``): `Query parameter <https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html#docs-bulk-api-query-params>`_ defining period each action waits for the following operations: Automatic index creation, Dynamic mapping updates, Waiting for active shards | |||
There was a problem hiding this comment.
How about slightly rewording this to:
defines the `time period that Elasticsearch will wait per action <https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html#docs-bulk-api-query-params>`_ until it has finished processing the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
There was a problem hiding this comment.
Yeah, it's better, I've updated docs per your suggestion
danielmitterdorfer
approved these changes
Oct 19, 2021
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.
This change adds
timeoutparameter that can be used inbulkoperation to define server-side timeout (for applying mappings updates, automatic index creation etc)