org.perfcake.reporting.reporter

Class StatsReporter

java.lang.Object

org.perfcake.reporting.reporter.AbstractReporter

org.perfcake.reporting.reporter.StatsReporter

All Implemented Interfaces:

Reporter

Direct Known Subclasses:

ResponseTimeStatsReporter, ServiceTimeStatsReporter, ThroughputStatsReporter

public abstract class StatsReporter
extends AbstractReporter

Reports the minimal, maximal and average value from the beginning of the measuring to the moment when the results are published including. The actual value about what the statistics are gathered is computed as a result of the computeResult(MeasurementUnit) method.

The default value of the reporter is a current value at the moment of publishing.

Author:

Pavel Macík

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatsReporter.WindowType The type of the window, either the number of iterations or a time duration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AVERAGE A String representation of a metric of an average value.
static String	MAXIMUM A String representation of a metric of a maximal value.
static String	MINIMUM A String representation of a metric of a minimal value.

Constructor Summary

Constructors

Constructor and Description
StatsReporter()

Method Summary

Modifier and Type	Method and Description
String	getHistogram() Gets the string specifying where the histogram should be split.
String	getHistogramPrefix() Gets the string prefix used in the result map for histogram entries.
int	getWindowSize() Gets the sliding window size if set.
StatsReporter.WindowType	getWindowType() Returns the type of the window.
boolean	isAverageEnabled() Gets the status of the metric of an average value.
boolean	isMaximumEnabled() Gets the status of the metric of a maximal value
boolean	isMinimumEnabled() Gets the status of the metric of a minimal value.
boolean	isRequestSizeEnabled() Is the metric of the request size enabled?
boolean	isResponseSizeEnabled() Is the metric of the response size enabled?
void	publishResult(PeriodType periodType, Destination destination) Publishes results to the destination.
StatsReporter	setAverageEnabled(boolean averageEnabled) Enables or disables the metric of an average value.
StatsReporter	setHistogram(String histogram) Sets the string specifying where the histogram should be split.
StatsReporter	setHistogramPrefix(String histogramPrefix) Sets the string prefix used in the result map for histogram entries.
StatsReporter	setMaximumEnabled(boolean maximumEnabled) Enables or disables the metric of a maximal value.
StatsReporter	setMinimumEnabled(boolean minimumEnabled) Enables or disables the metric of a minimal value.
StatsReporter	setRequestSizeEnabled(boolean requestSizeEnabled) Enables and disables the metric of the request size.
StatsReporter	setResponseSizeEnabled(boolean responseSizeEnabled) Enables and disables the metric of the response size.
StatsReporter	setWindowSize(int windowSize) Sets the size of the sliding window.
StatsReporter	setWindowType(StatsReporter.WindowType windowType) Sets the type of the window.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM

public static final String MAXIMUM

A String representation of a metric of a maximal value.

See Also:

Constant Field Values

MINIMUM

public static final String MINIMUM

A String representation of a metric of a minimal value.

See Also:

Constant Field Values

AVERAGE

public static final String AVERAGE

A String representation of a metric of an average value.

See Also:

Constant Field Values

Constructor Detail

StatsReporter

public StatsReporter()

Method Detail

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.

isMaximumEnabled

public boolean isMaximumEnabled()

Gets the status of the metric of a maximal value

Returns:

Returns true if the metric of a maximal is enabled or false otherwise.

setMaximumEnabled

public StatsReporter setMaximumEnabled(boolean maximumEnabled)

Enables or disables the metric of a maximal value.

Parameters:

maximumEnabled - Set true to enable the metric of a maximal value or false to disable it.

Returns:

Instance of this for fluent API.

isMinimumEnabled

public boolean isMinimumEnabled()

Gets the status of the metric of a minimal value.

Returns:

true if the metric of a minimal value is enabled or false otherwise.

setMinimumEnabled

public StatsReporter setMinimumEnabled(boolean minimumEnabled)

Enables or disables the metric of a minimal value.

Parameters:

minimumEnabled - true to enable the metric of a minimal value or false to disable it.

Returns:

Instance of this for fluent API.

isAverageEnabled

public boolean isAverageEnabled()

Gets the status of the metric of an average value.

Returns:

true if the metric of an average value is enabled or false otherwise.

setAverageEnabled

public StatsReporter setAverageEnabled(boolean averageEnabled)

Enables or disables the metric of an average value.

Parameters:

averageEnabled - true to enable the metric of an average value or false to disable it.

Returns:

Instance of this for fluent API.

getWindowSize

public int getWindowSize()

Gets the sliding window size if set. If the size is equal to Integer.MAX_VALUE, then it means the sliding window is not used at all and the statistics are taken from the whole run.

Returns:

The sliding window size.

setWindowSize

public StatsReporter setWindowSize(int windowSize)

Sets the size of the sliding window.

If the size is equal to Integer.MAX_VALUE (which is the default value), then it means the sliding window is not used at all and the statistics are taken from the whole run.

Parameters:

windowSize - The sliding window size.

Returns:

Instance of this for fluent API.

getHistogram

public String getHistogram()

Gets the string specifying where the histogram should be split.

Returns:

The string specifying where the histogram should be split.

setHistogram

public StatsReporter setHistogram(String histogram)

Sets the string specifying where the histogram should be split.

Parameters:

histogram - The string specifying where the histogram should be split.

Returns:

Instance of this to support fluent API.

getHistogramPrefix

public String getHistogramPrefix()

Gets the string prefix used in the result map for histogram entries.

Returns:

The string prefix used in the result map for histogram entries.

setHistogramPrefix

public StatsReporter setHistogramPrefix(String histogramPrefix)

Sets the string prefix used in the result map for histogram entries.

Parameters:

histogramPrefix - The string prefix used in the result map for histogram entries.

Returns:

Instance of this to support fluent API.

isRequestSizeEnabled

public boolean isRequestSizeEnabled()

Is the metric of the request size enabled?

Returns:

True if and only if the metric of the request size is enabled.

setRequestSizeEnabled

public StatsReporter setRequestSizeEnabled(boolean requestSizeEnabled)

Enables and disables the metric of the request size.

Parameters:

requestSizeEnabled - True to enable the metric.

Returns:

Instance of this to support fluent API.

isResponseSizeEnabled

public boolean isResponseSizeEnabled()

Is the metric of the response size enabled?

Returns:

True if and only if the metric of the response size is enabled.

setResponseSizeEnabled

public StatsReporter setResponseSizeEnabled(boolean responseSizeEnabled)

Enables and disables the metric of the response size.

Parameters:

responseSizeEnabled - True to enable the metric.

Returns:

Instance of this to support fluent API.

getWindowType

public StatsReporter.WindowType getWindowType()

Returns the type of the window.

Returns:

The window type.

setWindowType

public StatsReporter setWindowType(StatsReporter.WindowType windowType)

Sets the type of the window.

Parameters:

windowType - Either ITERATION or TIME is supported.

Returns:

The instance of this for a fluent API.