org.perfcake.reporting.reporter

Class WarmUpReporter

java.lang.Object

org.perfcake.reporting.reporter.AbstractReporter

org.perfcake.reporting.reporter.WarmUpReporter

All Implemented Interfaces:

Reporter

public class WarmUpReporter
extends AbstractReporter

Determines when the tested system is warmed up. The warming is enabled/disabled by the presence of the WarmUpReporter in the scenario. The minimal iteration count and the warm-up period duration can be tweaked by the respective properties (minimalWarmUpCount with the default value of 10,000 and minimalWarmUpDuration with the default value of 15,000 ms).

The system is considered warmed up when all of the following conditions are satisfied: The iteration length is not changing much over the time, the minimal iteration count has been executed and the minimal duration from the very start has exceeded.

Author:

Pavel Macík, Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
WarmUpReporter()

Method Summary

Modifier and Type	Method and Description
double	getAbsoluteThreshold() Gets the value of absolute threshold.
long	getMaximalWarmUpDuration() Gets the maximal tolerance of waiting for the end of the warm-up phase.
PeriodType	getMaximalWarmUpType() Gets the unit in which we measure the maximal warm-up count.
long	getMinimalWarmUpCount() Gets the value of minimal warm-up iteration count.
long	getMinimalWarmUpDuration() Gets the value of minimal warm-up period duration.
double	getRelativeThreshold() Gets the value of relative threshold.
void	publishResult(PeriodType periodType, Destination destination) Publishes results to the destination.
WarmUpReporter	setAbsoluteThreshold(double absoluteThreshold) Sets the value of absolute threshold.
WarmUpReporter	setMaximalWarmUpDuration(long maximalWarmUpDuration) Sets the maximal tolerance of waiting for the end of the warm-up phase.
WarmUpReporter	setMaximalWarmUpType(PeriodType maximalWarmUpType) Sets the unit in which we measure the maximal warm-up count.
WarmUpReporter	setMinimalWarmUpCount(long minimalWarmUpCount) Sets the value of minimal warm-up iteration count.
WarmUpReporter	setMinimalWarmUpDuration(long minimalWarmUpDuration) Sets the value of minimal warm-up period duration.
WarmUpReporter	setRelativeThreshold(double relativeThreshold) Sets the value of relative threshold.
void	start() Starts the reporter.

Methods inherited from class org.perfcake.reporting.reporter.AbstractReporter

getDestinations, getReportingPeriods, newMeasurement, registerDestination, registerDestination, report, reset, setReportManager, setRunInfo, stop, unregisterDestination

Methods inherited from class java.lang.Object

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

Constructor Detail

WarmUpReporter

public WarmUpReporter()

Method Detail

start

public void start()

Description copied from interface: Reporter

Starts the reporter. After a call to this method, reporter will report measurement results to the registered destinations. All destinations are started as well.

Specified by:

start in interface Reporter

Overrides:

start in class AbstractReporter

publishResult

public void publishResult(PeriodType periodType,
                          Destination destination)
                   throws ReportingException

Description copied from interface: Reporter

Publishes results to the destination. This method is called only when the results should be published.

Parameters:

periodType - A period type that caused the invocation of this method.

destination - A destination to which the result should be reported.

Throws:

ReportingException - When it was not possible to publish results to the given destination.

getMinimalWarmUpDuration

public long getMinimalWarmUpDuration()

Gets the value of minimal warm-up period duration.

Returns:

The minimal warm-up period duration.

setMinimalWarmUpDuration

public WarmUpReporter setMinimalWarmUpDuration(long minimalWarmUpDuration)

Sets the value of minimal warm-up period duration.

Parameters:

minimalWarmUpDuration - The minimal warm-up period duration to set.

Returns:

Instance of this for fluent API.

getMinimalWarmUpCount

public long getMinimalWarmUpCount()

Gets the value of minimal warm-up iteration count.

Returns:

The value of minimal warm-up iteration count.

setMinimalWarmUpCount

public WarmUpReporter setMinimalWarmUpCount(long minimalWarmUpCount)

Sets the value of minimal warm-up iteration count.

Parameters:

minimalWarmUpCount - The value of minimal warm-up iteration count to set.

Returns:

Instance of this for fluent API.

getRelativeThreshold

public double getRelativeThreshold()

Gets the value of relative threshold.

Returns:

The value of relative threshold.

setRelativeThreshold

public WarmUpReporter setRelativeThreshold(double relativeThreshold)

Sets the value of relative threshold.

Parameters:

relativeThreshold - The value of relative threshold to set.

Returns:

Instance of this for fluent API.

getAbsoluteThreshold

public double getAbsoluteThreshold()

Gets the value of absolute threshold.

Returns:

The value of absolute threshold.

setAbsoluteThreshold

public WarmUpReporter setAbsoluteThreshold(double absoluteThreshold)

Sets the value of absolute threshold.

Parameters:

absoluteThreshold - The value of absolute threshold to set.

Returns:

Instance of this for fluent API.

getMaximalWarmUpType

public PeriodType getMaximalWarmUpType()

Gets the unit in which we measure the maximal warm-up count. Can be iteration, time, or percentage.

Returns:

The unit in which we measure the maximal warm-up count.

setMaximalWarmUpType

public WarmUpReporter setMaximalWarmUpType(PeriodType maximalWarmUpType)

Sets the unit in which we measure the maximal warm-up count. Can be iteration, time, or percentage.

Parameters:

maximalWarmUpType - The unit in which we measure the maximal warm-up count.

Returns:

Instance of this to support fluent API.

getMaximalWarmUpDuration

public long getMaximalWarmUpDuration()

Gets the maximal tolerance of waiting for the end of the warm-up phase. If we run out of this time/iteration count (determined by maximalWarmUpType, we simply break the test and do not waste more time. -1 means that the check is disabled.

Returns:

The maximal tolerance of waiting for the end of the warm-up phase.

setMaximalWarmUpDuration

public WarmUpReporter setMaximalWarmUpDuration(long maximalWarmUpDuration)

Sets the maximal tolerance of waiting for the end of the warm-up phase. If we run out of this time/iteration count (determined by maximalWarmUpType, we simply break the test and do not waste more time. -1 means that the check is disabled.

Parameters:

maximalWarmUpDuration - The maximal tolerance of waiting for the end of the warm-up phase.

Returns:

Instance of this to support fluent API.