Package io.narayana.perf

Class RegressionChecker

java.lang.Object

io.narayana.perf.RegressionChecker

public class RegressionChecker
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_DIRECTORY_PROPERTY
static final Double	DEFAULT_VARIANCE
static final String	FAIL_ON_PERF_REGRESSION_PROP
static final String	PERF_ARGS_FILENAME
static final String	PERF_DATA_FILENAME
static final String	PERF_VAR_FILENAME
static final String	PROPFILE_COMMENT
static final String	RESET_NETRICS_PROP

Constructor Summary

Constructors

Constructor	Description
RegressionChecker()
RegressionChecker(String perfArgsFileName, String perfHistoryFileName, String perfVarFileName)

Method Summary

Modifier and Type	Method	Description
<T> T	getArg(String metricName, String[] args, int index, T defaultValue, Class<T> argClass)	Convert a String to another type
Map<String,Double>	getMatchingMetrics(String pattern)	get metrics matching a particular pattern
String[]	getTestArgs(String metricName)	Lookup any configured test arguments
double	getVariance(String metricName)
boolean	isFailOnRegression()	If isFailOnRegression is false then new metrics will not be persisted to the metrics store
static boolean	isRegressionCheckEnabled()
boolean	isResetMetrics()
static Boolean	readBooleanProperty(String propName)
void	setFailOnRegression(boolean failOnRegression)
void	setResetMetrics(boolean resetMetrics)

Methods inherited from class java.lang.Object

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

Field Details

BASE_DIRECTORY_PROPERTY

public static final String BASE_DIRECTORY_PROPERTY

See Also:

• Constant Field Values

RESET_NETRICS_PROP

public static final String RESET_NETRICS_PROP

See Also:

• Constant Field Values

FAIL_ON_PERF_REGRESSION_PROP

public static final String FAIL_ON_PERF_REGRESSION_PROP

See Also:

• Constant Field Values

PERF_ARGS_FILENAME

public static final String PERF_ARGS_FILENAME

See Also:

• Constant Field Values

PERF_DATA_FILENAME

public static final String PERF_DATA_FILENAME

See Also:

• Constant Field Values

PERF_VAR_FILENAME

public static final String PERF_VAR_FILENAME

See Also:

• Constant Field Values

PROPFILE_COMMENT

public static final String PROPFILE_COMMENT

See Also:

• Constant Field Values

DEFAULT_VARIANCE

public static final Double DEFAULT_VARIANCE

Constructor Details

RegressionChecker

public RegressionChecker()
                  throws IOException

Throws:

IOException

RegressionChecker

public RegressionChecker(String perfArgsFileName,
 String perfHistoryFileName,
 String perfVarFileName)
                  throws IOException

Throws:

IOException

Method Details

isRegressionCheckEnabled

public static boolean isRegressionCheckEnabled()

readBooleanProperty

public static Boolean readBooleanProperty(String propName)

isFailOnRegression

public boolean isFailOnRegression()

If isFailOnRegression is false then new metrics will not be persisted to the metrics store

Returns:

whether or not to mark regressions as failures

isResetMetrics

public boolean isResetMetrics()

setFailOnRegression

public void setFailOnRegression(boolean failOnRegression)

setResetMetrics

public void setResetMetrics(boolean resetMetrics)

getArg

public <T> T getArg(String metricName,
 String[] args,
 int index,
 T defaultValue,
 Class<T> argClass)

Convert a String to another type

Type Parameters:

T - the type which args[index] should be converted to

Parameters:

metricName - the name of the test to use if there was a data format error

args - arguments returned from a prior call to getTestArgs(String)

index - index into the args array to the value to be converted

defaultValue - default value if the index is out of range

argClass - class type to convert the value to (which must have a constructor that takes a String value)

Returns:

the converted value

getTestArgs

public String[] getTestArgs(String metricName)

Lookup any configured test arguments

Parameters:

metricName - the name of the test

Returns:

any test arguments or an empty array if there are none

getMatchingMetrics

public Map<String,Double> getMatchingMetrics(String pattern)

get metrics matching a particular pattern

Parameters:

pattern - the regex used as the pattern

Returns:

a map of matching metric names to the current value of the metric

getVariance

public double getVariance(String metricName)