Run a task completely even without time-periods #763
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
There are multiple conditions how a task can be completed. Either the user explicitly specifies a maximum number of iterations or a time-period or a task is implicitly completed when the parameter source is exhausted (e.g. when reading parameters from a file). In the latter case it is not necessary to provide any indication when a task is complete because the parameter source can determine it. However, so far this was required. With this commit we introduce a change in the parameter source API so that it is possible to determine this case and also provide proper progress indication. Furthermore we adapt all parameter sources that come with Rally out of the box and provide guidance for users how to change their own parameter sources.
danielmitterdorfer
added
bug
This was referenced Sep 5, 2019
dliappis
reviewed
Sep 9, 2019
| return | ||
| if task_progress_control.infinite: | ||
| logger.info("Parameter source will determine when the schedule for [%s] terminates.", task_name) | ||
| param_source_knows_progress = hasattr(params, "percent_completed") |
There was a problem hiding this comment.
I love the name of this variable 👍
docs/adding_tracks.rst
Outdated
| * ``params(self)``: This method returns a dictionary with all parameters that the corresponding "runner" expects. This method will be invoked once for every iteration during the race. In the example, we parameterize the query by randomly selecting a profession from a list. | ||
| * ``infinite``: This property helps Rally to determine whether to let the parameter source determine when a task should be finished (usually when ``infinite`` is ``False``) or whether the task properties (e.g. ``iterations`` or ``time-period``) determine when a task should be finished. |
There was a problem hiding this comment.
I think we are missing the crucial information here about how the custom parameter source can trigger a task stop by raising a StopIteration.
There was a problem hiding this comment.
Good catch. I've addressed this in 06add96.
|
LGTM thanks! |
|
Thank you both for the reviews! :) |
danielmitterdorfer
added a commit
to danielmitterdorfer/rally
that referenced
this pull request
Sep 10, 2019
With this commit we honor the parameter `ingest-percentage` again for bulk requests. Before elastic#763, the method `size()` was used to determine upfront when a parameter source is exhausted. When we changed the API then in elastic#763 the parameter source's progress indication was instead done with the `percent_completed` property but this is only informational and the parameter source is required to raise `StopIteration` to indicate completion. This means that `ingest-percentage` was not considered anymore for bulks but instead we always read the input file(s) completely and then terminated with `StopIteration`. Relates elastic#763
danielmitterdorfer
added a commit
that referenced
this pull request
Sep 10, 2019
With this commit we honor the parameter `ingest-percentage` again for bulk requests. Before #763, the method `size()` was used to determine upfront when a parameter source is exhausted. When we changed the API then in #763 the parameter source's progress indication was instead done with the `percent_completed` property but this is only informational and the parameter source is required to raise `StopIteration` to indicate completion. This means that `ingest-percentage` was not considered anymore for bulks but instead we always read the input file(s) completely and then terminated with `StopIteration`. Relates #763 Relates #768
novosibman
pushed a commit
to novosibman/rally
that referenced
this pull request
Oct 2, 2019
There are multiple conditions how a task can be completed. Either the user explicitly specifies a maximum number of iterations or a time-period or a task is implicitly completed when the parameter source is exhausted (e.g. when reading parameters from a file). In the latter case it is not necessary to provide any indication when a task is complete because the parameter source can determine it. However, so far this was required. With this commit we introduce a change in the parameter source API so that it is possible to determine this case and also provide proper progress indication. Furthermore we adapt all parameter sources that come with Rally out of the box and provide guidance for users how to change their own parameter sources. Relates elastic#763
novosibman
pushed a commit
to novosibman/rally
that referenced
this pull request
Oct 2, 2019
With this commit we honor the parameter `ingest-percentage` again for bulk requests. Before elastic#763, the method `size()` was used to determine upfront when a parameter source is exhausted. When we changed the API then in elastic#763 the parameter source's progress indication was instead done with the `percent_completed` property but this is only informational and the parameter source is required to raise `StopIteration` to indicate completion. This means that `ingest-percentage` was not considered anymore for bulks but instead we always read the input file(s) completely and then terminated with `StopIteration`. Relates elastic#763 Relates elastic#768
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.
There are multiple conditions how a task can be completed. Either the user
explicitly specifies a maximum number of iterations or a time-period or a task
is implicitly completed when the parameter source is exhausted (e.g. when
reading parameters from a file). In the latter case it is not necessary to
provide any indication when a task is complete because the parameter source can
determine it. However, so far this was required.
With this commit we introduce a change in the parameter source API so that it is
possible to determine this case and also provide proper progress indication.
Furthermore we adapt all parameter sources that come with Rally out of the box
and provide guidance for users how to change their own parameter sources.