org.perfcake.reporting.reporter

Class MemoryUsageReporter

java.lang.Object

org.perfcake.reporting.reporter.AbstractReporter

org.perfcake.reporting.reporter.MemoryUsageReporter

All Implemented Interfaces:

Reporter

public class MemoryUsageReporter
extends AbstractReporter

Reports memory usage information from a remote JVM, where PerfCake agent is deployed. It communicates with the PerfCake agent to get the information via TCP sockets.

Author:

Pavel Macík

Constructor Summary

Constructors

Constructor and Description
MemoryUsageReporter()

Method Summary

Modifier and Type	Method and Description
String	getAgentHostname() Gets the agent hostname.
String	getAgentPort() Gets the agent port.
String	getMemoryDumpFile() Gets the name of the memory dump file created by PerfCake agent.
long	getMemoryLeakDetectionMonitoringPeriod() Gets the period in which a memory usage is gathered from the PerfCake agent.
double	getMemoryLeakSlopeThreshold() Gets the possible memory leak detection threshold.
int	getUsedMemoryTimeWindowSize() Gets the size of the memory time window (number of latest records) for possible memory leak detection.
boolean	isMemoryDumpOnLeak() Returns a value of the property to make a memory dump, when possible memory leak is detected.
boolean	isMemoryLeakDetectionEnabled() Is the possible memory leak detection enabled?
boolean	isPerformGcOnMemoryUsage() Returns the value of the property that indicate if performing garbage collection (each time the memory usage of the tested system is measured and published) is enabled or disabled.
void	publishResult(PeriodType periodType, Destination destination) Publishes results to the destination.
MemoryUsageReporter	setAgentHostname(String agentHostname) Sets the agent hostname.
MemoryUsageReporter	setAgentPort(String agentPort) Sets the agent port.
MemoryUsageReporter	setMemoryDumpFile(String memoryDumpFile) Sets a the name of the memory dump file created by PerfCake agent.
MemoryUsageReporter	setMemoryDumpOnLeak(boolean memoryDumpOnLeak) Sets the value of the property to make a memory dump, when possible memory leak is detected.
MemoryUsageReporter	setMemoryLeakDetectionEnabled(boolean memoryLeakDetectionEnabled) Enables/disables the possible memory leak detection mechanism.
MemoryUsageReporter	setMemoryLeakDetectionMonitoringPeriod(long memoryLeakDetectionMonitoringPeriod) Sets the period in which a memory usage is gathered from the PerfCake agent.
MemoryUsageReporter	setMemoryLeakSlopeThreshold(double memoryLeakSlopeThreshold) Sets the possible memory leak detection threshold.
MemoryUsageReporter	setPerformGcOnMemoryUsage(boolean performGcOnMemoryUsage) Enables/disables garbage collection to be performed each time the memory usage of the tested system is measured and published.
MemoryUsageReporter	setUsedMemoryTimeWindowSize(int timeWindowSize) Sets the size of the memory time window (number of latest records) for possible memory leak detection.
void	start() Starts the reporter.
void	stop() Stops the reporter.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryUsageReporter

public MemoryUsageReporter()

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

stop

public void stop()

Description copied from interface: Reporter

Stops the reporter. After a call to this method, no more results will be reported to the destinatons. All destinations are stopped as well.

Specified by:

stop in interface Reporter

Overrides:

stop 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.

getAgentHostname

public String getAgentHostname()

Gets the agent hostname.

Returns:

The agent hostname.

setAgentHostname

public MemoryUsageReporter setAgentHostname(String agentHostname)

Sets the agent hostname.

Parameters:

agentHostname - The agent hostname.

Returns:

Instance of this to support fluent API.

getAgentPort

public String getAgentPort()

Gets the agent port.

Returns:

The agent port.

setAgentPort

public MemoryUsageReporter setAgentPort(String agentPort)

Sets the agent port.

Parameters:

agentPort - The agent port.

Returns:

Instance of this to support fluent API.

getUsedMemoryTimeWindowSize

public int getUsedMemoryTimeWindowSize()

Gets the size of the memory time window (number of latest records) for possible memory leak detection.

Returns:

The used memory time window size.

setUsedMemoryTimeWindowSize

public MemoryUsageReporter setUsedMemoryTimeWindowSize(int timeWindowSize)

Sets the size of the memory time window (number of latest records) for possible memory leak detection.

Parameters:

timeWindowSize - The used memory time window size.

Returns:

Instance of this to support fluent API.

getMemoryLeakSlopeThreshold

public double getMemoryLeakSlopeThreshold()

Gets the possible memory leak detection threshold. Possible memory leak is found, when the actual slope of the linear regression line computed from the time window data set is greater than the threshold.

Returns:

The memory leak slope threshold.

setMemoryLeakSlopeThreshold

public MemoryUsageReporter setMemoryLeakSlopeThreshold(double memoryLeakSlopeThreshold)

Sets the possible memory leak detection threshold. Possible memory leak is found, when the actual slope of the linear regression line computed from the time window data set is greater than the threshold.

Parameters:

memoryLeakSlopeThreshold - The memory leak slope threshold.

Returns:

Instance of this to support fluent API.

isMemoryLeakDetectionEnabled

public boolean isMemoryLeakDetectionEnabled()

Is the possible memory leak detection enabled?

Returns:

The memory leak detection status.

setMemoryLeakDetectionEnabled

public MemoryUsageReporter setMemoryLeakDetectionEnabled(boolean memoryLeakDetectionEnabled)

Enables/disables the possible memory leak detection mechanism.

Parameters:

memoryLeakDetectionEnabled - true to enable memory leak detection mechanism.

Returns:

Instance of this to support fluent API.

getMemoryLeakDetectionMonitoringPeriod

public long getMemoryLeakDetectionMonitoringPeriod()

Gets the period in which a memory usage is gathered from the PerfCake agent.

Returns:

The memory leak detection monitoring period.

setMemoryLeakDetectionMonitoringPeriod

public MemoryUsageReporter setMemoryLeakDetectionMonitoringPeriod(long memoryLeakDetectionMonitoringPeriod)

Sets the period in which a memory usage is gathered from the PerfCake agent.

Parameters:

memoryLeakDetectionMonitoringPeriod - The memory leak detection monitoring period.

Returns:

Instance of this to support fluent API.

getMemoryDumpFile

public String getMemoryDumpFile()

Gets the name of the memory dump file created by PerfCake agent.

Returns:

Name of the memory dump file.

setMemoryDumpFile

public MemoryUsageReporter setMemoryDumpFile(String memoryDumpFile)

Sets a the name of the memory dump file created by PerfCake agent.

Parameters:

memoryDumpFile - Memory dump file name.

Returns:

Instance of this to support fluent API.

isMemoryDumpOnLeak

public boolean isMemoryDumpOnLeak()

Returns a value of the property to make a memory dump, when possible memory leak is detected. The MemoryUsageReporter will send a command to PerfCake agent that will create a heap dump.

Returns:

true if the memory dump on leak is enabled. false otherwise.

setMemoryDumpOnLeak

public MemoryUsageReporter setMemoryDumpOnLeak(boolean memoryDumpOnLeak)

Sets the value of the property to make a memory dump, when possible memory leak is detected. The MemoryUsageReporter will send a command to PerfCake agent that will create a heap dump.

Parameters:

memoryDumpOnLeak - Enables or disables the memory dump on leak.

Returns:

Instance of this to support fluent API.

isPerformGcOnMemoryUsage

public boolean isPerformGcOnMemoryUsage()

Returns the value of the property that indicate if performing garbage collection (each time the memory usage of the tested system is measured and published) is enabled or disabled.

Returns:

true if the garbage collection feature is enabled, false otherwise.

setPerformGcOnMemoryUsage

public MemoryUsageReporter setPerformGcOnMemoryUsage(boolean performGcOnMemoryUsage)

Enables/disables garbage collection to be performed each time the memory usage of the tested system is measured and published. Since the garbage collection is CPU intensive operation be careful to enable it and to how often the memory usage is measured because it will have a significant impact on the measured system and naturally the measured results too.

It is disabled by default.

Parameters:

performGcOnMemoryUsage - true to enable the feature. The false otherwise.

Returns:

Instance of this to support fluent API.