io.hyperfoil.api.config

Class SLABuilder<P>

java.lang.Object

io.hyperfoil.api.config.SLABuilder<P>

All Implemented Interfaces:

Rewritable<SLABuilder<P>>

public class SLABuilder<P>
extends Object
implements Rewritable<SLABuilder<P>>

Defines a Service Level Agreement (SLA) - conditions that must hold for benchmark to be deemed successful.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SLABuilder.LimitsBuilder Percentile limits.
static class	SLABuilder.ListBuilder<P> Defines a list of Service Level Agreements (SLAs) - conditions that must hold for benchmark to be deemed successful.

Constructor Summary

Constructors

Constructor and Description
SLABuilder(P parent)

Method Summary

Modifier and Type	Method and Description
SLABuilder<P>	blockedRatio(double blockedRatio) Maximum allowed ratio of time spent waiting for usable connection to sum of response latencies.
SLA	build()
P	endSLA()
SLABuilder<P>	errorRatio(double errorRatio) Maximum allowed ratio of errors.
SLABuilder.LimitsBuilder	limits() Percentile limits.
SLABuilder<P>	meanResponseTime(long meanResponseTime, TimeUnit timeUnit)
SLABuilder<P>	meanResponseTime(String meanResponseTime) Maximum allowed mean (average) response time.
void	prepareBuild()
void	readFrom(SLABuilder<P> other)
SLABuilder<P>	window(long window, TimeUnit timeUnit)
SLABuilder<P>	window(String window) Period over which the stats should be collected.

Methods inherited from class java.lang.Object

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

Constructor Detail

SLABuilder

public SLABuilder(P parent)

Method Detail

prepareBuild

public void prepareBuild()

build

public SLA build()

endSLA

public P endSLA()

window

public SLABuilder<P> window(long window,
                            TimeUnit timeUnit)

window

public SLABuilder<P> window(String window)

Period over which the stats should be collected. By default the SLA applies to stats from whole phase.

Parameters:

window - Window size with suffix ('s', 'm' or 'h') or just in milliseconds.

Returns:

Self.

errorRatio

public SLABuilder<P> errorRatio(double errorRatio)

Maximum allowed ratio of errors. Valid values are 0.0 - 1.0 (inclusive).

Parameters:

errorRatio - Ratio.

Returns:

Self.

meanResponseTime

public SLABuilder<P> meanResponseTime(long meanResponseTime,
                                      TimeUnit timeUnit)

meanResponseTime

public SLABuilder<P> meanResponseTime(String meanResponseTime)

Maximum allowed mean (average) response time. Use suffix `ns`, `us`, `ms` or `s` to specify units.

Parameters:

meanResponseTime - Mean response time.

Returns:

Self.

blockedRatio

public SLABuilder<P> blockedRatio(double blockedRatio)

Maximum allowed ratio of time spent waiting for usable connection to sum of response latencies. Default is 0 - client must not be blocked.

Parameters:

blockedRatio - Maximum ratio.

Returns:

Self.

limits

public SLABuilder.LimitsBuilder limits()

Percentile limits.

Returns:

Builder.

readFrom

public void readFrom(SLABuilder<P> other)

Specified by:

readFrom in interface Rewritable<SLABuilder<P>>