Skip to content
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

Remove lap feature and all references. #739

Merged
merged 11 commits into from
Aug 14, 2019
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
5 changes: 0 additions & 5 deletions docs/command_line_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,11 +251,6 @@ Selects the :doc:`pipeline </pipelines>` that Rally should run.

Rally can autodetect the pipeline in most cases. If you specify ``--distribution-version`` it will auto-select the pipeline ``from-distribution`` otherwise it will use ``from-sources-complete``.

``laps``
drawlerr marked this conversation as resolved.
Show resolved Hide resolved
~~~~~~~~

Allows to run the benchmark for multiple laps (defaults to 1 lap). Each lap corresponds to one full execution of a track but note that the benchmark candidate is not restarted in between.

.. _clr_enable_driver_profiling:

``enable-driver-profiling``
Expand Down
7 changes: 0 additions & 7 deletions docs/metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ Here is a typical metrics record::
"task": "index-append-no-conflicts",
"operation": "index-append-no-conflicts",
"operation-type": "Index",
"lap": 1,
"meta": {
"cpu_physical_cores": 36,
"cpu_logical_cores": 72,
Expand Down Expand Up @@ -98,12 +97,6 @@ task, operation, operation-type

``operation-type`` is the more abstract type of an operation. During a race, multiple queries may be issued which are different ``operation``s but they all have the same ``operation-type`` (Search). For some metrics, only the operation type matters, e.g. it does not make any sense to attribute the CPU usage to an individual query but instead attribute it just to the operation type.

lap
~~~

The lap number in which this metric was gathered. Laps start at 1. See the :doc:`command line reference </command_line_reference>` for more info on laps.


meta
~~~~

Expand Down
12 changes: 12 additions & 0 deletions docs/migrate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ Races now stored by ID instead of timestamp
With Rally 1.3.0, Races will be stored by their Trial ID instead of their timestamp.
This means that on disk, a given race will be found at ``benchmarks/races/62d1e928-48b0-4d07-9899-07b45d031566/`` instead of ``benchmarks/races/2019-07-03-17-52-07``

Laps feature removed
^^^^^^^^^^^^^^^^^^^^
The ```--laps``` parameter and corresponding multi-run trial functionality has been removed from execution and reporting.
Copy link
Member

Choose a reason for hiding this comment

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

This needs to be enclosed in double-backticks, not triple-backticks.

If you need lap functionality, the following shell script can be used instead::

RALLY_LAPS=3

for lap in $(seq 1 ${RALLY_LAPS})
do
esrally --pipeline=benchmark-only --user-tag lap:$lap
done


Migrating to Rally 1.2.1
------------------------
Expand Down
9 changes: 3 additions & 6 deletions esrally/driver/driver.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,12 @@ class StartBenchmark:
Starts a benchmark.
"""

def __init__(self, config, track, metrics_meta_info, lap):
def __init__(self, config, track, metrics_meta_info):
"""
:param config: Rally internal configuration object.
:param track: The track to use.
:param metrics_meta_info: meta info for the metrics store.
:param lap: The current lap.
"""
self.lap = lap
self.config = config
self.track = track
self.metrics_meta_info = metrics_meta_info
Expand Down Expand Up @@ -200,7 +198,7 @@ def receiveUnrecognizedMessage(self, msg, sender):
def receiveMsg_StartBenchmark(self, msg, sender):
self.start_sender = sender
self.coordinator = Driver(self, msg.config)
self.coordinator.start_benchmark(msg.track, msg.lap, msg.metrics_meta_info)
self.coordinator.start_benchmark(msg.track, msg.metrics_meta_info)
self.wakeupAfter(datetime.timedelta(seconds=DriverActor.WAKEUP_INTERVAL_SECONDS))

@actor.no_retry("driver")
Expand Down Expand Up @@ -342,7 +340,7 @@ def __init__(self, target, config):
self.tasks_per_join_point = None
self.complete_current_task_sent = False

def start_benchmark(self, t, lap, metrics_meta_info):
def start_benchmark(self, t, metrics_meta_info):
self.track = t
self.challenge = select_challenge(self.config, self.track)
self.quiet = self.config.opts("system", "quiet.mode", mandatory=False, default_value=False)
Expand All @@ -351,7 +349,6 @@ def start_benchmark(self, t, lap, metrics_meta_info):
track=self.track.name,
challenge=self.challenge.name,
meta_info=metrics_meta_info,
lap=lap,
read_only=False)
for host in self.config.opts("driver", "load_driver_hosts"):
if host != "localhost":
Expand Down
9 changes: 3 additions & 6 deletions esrally/mechanic/mechanic.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ def __init__(self, system_metrics):


class OnBenchmarkStart:
def __init__(self, lap):
self.lap = lap
def __init__(self):
pass


class BenchmarkStarted:
Expand Down Expand Up @@ -346,8 +346,7 @@ def receiveMsg_MetricsMetaInfoApplied(self, msg, sender):

@actor.no_retry("mechanic")
def receiveMsg_OnBenchmarkStart(self, msg, sender):
self.metrics_store.lap = msg.lap
# in the first lap, we are in state "cluster_started", after that in "benchmark_stopped"
# we are in state "cluster_started", after that in "benchmark_stopped"
self.send_to_children_and_transition(sender, msg, ["cluster_started", "benchmark_stopped"], "benchmark_starting")

@actor.no_retry("mechanic")
Expand Down Expand Up @@ -575,7 +574,6 @@ def receiveMsg_StartNodes(self, msg, sender):
self.metrics_store = cls(self.config)
self.metrics_store.open(ctx=msg.open_metrics_context)
# avoid follow-up errors in case we receive an unexpected ActorExitRequest due to an early failure in a parent actor.
self.metrics_store.lap = 0

self.mechanic = create(self.config, self.metrics_store, msg.all_node_ips, msg.cluster_settings, msg.sources, msg.build,
msg.distribution, msg.external, msg.docker)
Expand Down Expand Up @@ -610,7 +608,6 @@ def receiveUnrecognizedMessage(self, msg, sender):
self.logger.info("Resetting relative time of system metrics store on host [%s].", self.host)
self.metrics_store.reset_relative_time()
elif isinstance(msg, OnBenchmarkStart):
self.metrics_store.lap = msg.lap
self.mechanic.on_benchmark_start()
self.wakeupAfter(METRIC_FLUSH_INTERVAL_SECONDS)
self.send(sender, BenchmarkStarted())
Expand Down
2 changes: 1 addition & 1 deletion esrally/mechanic/telemetry.py
Original file line number Diff line number Diff line change
Expand Up @@ -1169,7 +1169,7 @@ def __init__(self, client, metrics_store):
self.first_time = True

def on_benchmark_start(self):
# we only determine this value at the start of the benchmark (in the first lap). This is actually only useful for
# we only determine this value at the start of the benchmark. This is actually only useful for
# the pipeline "benchmark-only" where we don't have control over the cluster and the user might not have restarted
# the cluster so we can at least tell them.
if self.first_time:
Expand Down
Loading