yardstick.benchmark.runners package

Submodules

yardstick.benchmark.runners.arithmetic module

A runner that every run arithmetically steps specified input value(s) to the scenario. This just means step value(s) is added to the previous value(s). It is possible to combine several named input values and run with those either as nested for loops or combine each i:th index of each “input value list” until the end of the shortest list is reached (optimally all lists should be defined with the same number of values when using such iter_type).

class yardstick.benchmark.runners.arithmetic.ArithmeticRunner(config, queue)

Bases: yardstick.benchmark.runners.base.Runner

Run a scenario arithmetically stepping input value(s)

Parameters:

• - time to wait between each scenario invocation (interval) – type: int unit: seconds default: 1 sec
• iter_type –

  • Iteration type of input parameter: nested_for_loops

    or tuple_loops

  type: string unit: na default: nested_for_loops

• - –

  name - name of scenario option that will be increased for each invocation

  type: string unit: na default: na

  start - value to use in first invocation of scenario

  type: int unit: na default: none

  stop - value indicating end of invocation. Can be set to same

  value as start for one single value.

  type: int unit: na default: none

  step - value added to start value in next invocation of scenario.

  Must not be set to zero. Can be set negative if start > stop

  type: int unit: na default: none

• - – name - and so on......

yardstick.benchmark.runners.base module

class yardstick.benchmark.runners.base.Runner(config, queue)

Bases: object

abort()

Abort the execution of a scenario

dump_process = None

static get(config)

Returns instance of a scenario runner for execution type.

static get_cls(runner_type)

return class of specified type

static get_types()

return a list of known runner type (class) names

join(timeout=None)

queue = None

static release(runner)

Release the runner

static release_dump_process()

Release the dumper process

run(scenario_cfg, context_cfg)

run_post_stop_action()

run a potentially configured post-stop action

runners = []

static terminate(runner)

Terminate the runner

static terminate_all()

Terminate all runners (subprocesses)

yardstick.benchmark.runners.duration module

A runner that runs a specific time before it returns

class yardstick.benchmark.runners.duration.DurationRunner(config, queue)

Bases: yardstick.benchmark.runners.base.Runner

Run a scenario for a certain amount of time

If the scenario ends before the time has elapsed, it will be started again.

Parameters

duration - amount of time the scenario will be run for

type: int unit: seconds default: 1 sec

interval - time to wait between each scenario invocation

type: int unit: seconds default: 1 sec

yardstick.benchmark.runners.iteration module

A runner that runs a configurable number of times before it returns

class yardstick.benchmark.runners.iteration.IterationRunner(config, queue)

Bases: yardstick.benchmark.runners.base.Runner

Run a scenario for a configurable number of times

If the scenario ends before the time has elapsed, it will be started again.

Parameters

iterations - amount of times the scenario will be run for

type: int unit: na default: 1

interval - time to wait between each scenario invocation

type: int unit: seconds default: 1 sec

yardstick.benchmark.runners.sequence module

A runner that every run changes a specified input value to the scenario. The input value in the sequence is specified in a list in the input file.

class yardstick.benchmark.runners.sequence.SequenceRunner(config, queue)

Bases: yardstick.benchmark.runners.base.Runner

Run a scenario by changing an input value defined in a list

Parameters:

• - time to wait between each scenario invocation (interval) – type: int unit: seconds default: 1 sec
• - name of the option that is increased each invocation (scenario_option_name) – type: string unit: na default: none
• - list of values which are executed in their respective scenarios (sequence) – type: [int] unit: na default: none

Module contents