Package io.hyperfoil.api.config

Class Benchmark

java.lang.Object

io.hyperfoil.api.config.Benchmark

All Implemented Interfaces:

Serializable

public class Benchmark
extends Object
implements Serializable

A benchmark is a collection of simulation, user, SLA and scaling strategy (Ramp up, Steady State, Ramp Down, steady state variance) that are to be run against the target environment.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Benchmark.FailurePolicy

Constructor Summary

Constructors

Constructor	Description
Benchmark(String name, String version, BenchmarkSource source, Map<String,String> params, Map<String,byte[]> files, Agent[] agents, int defaultThreads, Map<Class<? extends PluginConfig>,PluginConfig> plugins, Collection<Phase> phases, Map<String,Object> tags, long statisticsCollectionPeriod, String triggerUrl, List<RunHook> preHooks, List<RunHook> postHooks, Benchmark.FailurePolicy failurePolicy)

Method Summary

Modifier and Type	Method	Description
Agent[]	agents()
int	defaultThreads()
static Benchmark	empty(String name, Map<String,String> templateParams)
Benchmark.FailurePolicy	failurePolicy()
Map<String,byte[]>	files()
static Benchmark	forTesting()
String	name()
Map<String,String>	params()
Collection<Phase>	phases()
Phase[]	phasesById()
<T extends PluginConfig> T	plugin(Class<T> clazz)
Collection<PluginConfig>	plugins()
List<RunHook>	postHooks()
List<RunHook>	preHooks()
double	slice(double totalValue, int agentId)
int	slice(int totalValue, int agentId)
BenchmarkSource	source()	As the transformation from YAML is one-way (due to forks and iterations) here we store the original source (be it YAML or JSON)
long	statisticsCollectionPeriod()
Stream<Step>	steps()
Map<String,Object>	tags()
int	threads(int agentId)
String	toString()
int	totalThreads()
String	triggerUrl()
String	version()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Benchmark

public Benchmark(String name,
 String version,
 BenchmarkSource source,
 Map<String,String> params,
 Map<String,byte[]> files,
 Agent[] agents,
 int defaultThreads,
 Map<Class<? extends PluginConfig>,PluginConfig> plugins,
 Collection<Phase> phases,
 Map<String,Object> tags,
 long statisticsCollectionPeriod,
 String triggerUrl,
 List<RunHook> preHooks,
 List<RunHook> postHooks,
 Benchmark.FailurePolicy failurePolicy)

Method Details

forTesting

public static Benchmark forTesting()

empty

public static Benchmark empty(String name,
 Map<String,String> templateParams)

name

public String name()

version

public String version()

agents

public Agent[] agents()

source

public BenchmarkSource source()

As the transformation from YAML is one-way (due to forks and iterations) here we store the original source (be it YAML or JSON)

Returns:

Source YAML for the benchmark.

params

public Map<String,String> params()

files

public Map<String,byte[]> files()

defaultThreads

public int defaultThreads()

phases

public Collection<Phase> phases()

tags

public Map<String,Object> tags()

statisticsCollectionPeriod

public long statisticsCollectionPeriod()

triggerUrl

public String triggerUrl()

preHooks

public List<RunHook> preHooks()

postHooks

public List<RunHook> postHooks()

toString

public String toString()

Overrides:

toString in class Object

steps

public Stream<Step> steps()

phasesById

public Phase[] phasesById()

slice

public int slice(int totalValue,
 int agentId)

slice

public double slice(double totalValue,
 int agentId)

threads

public int threads(int agentId)

totalThreads

public int totalThreads()

plugin

public <T extends PluginConfig> T plugin(Class<T> clazz)

plugins

public Collection<PluginConfig> plugins()

failurePolicy

public Benchmark.FailurePolicy failurePolicy()