org.mule.management.stats

Class ComponentStatistics

java.lang.Object

org.mule.management.stats.ComponentStatistics

All Implemented Interfaces:

Serializable, Statistics

public class ComponentStatistics
extends Object
implements Statistics

ComponentStatistics is a basic metrics aggregation class that is accessible via the JMX api. This class is not thread-safe - occasional errors in reported statistics should be expected, especially when the clear() method is used.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComponentStatistics() The constructor added to initialize the interval time in ms that stats are measured for from the property statIntervalTime.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCompleteExecutionTime(long time) Add the complete execution time for a flow that also reports branch execution times.
void	addExecutionBranchTime(boolean first, long branch, long total) Add a new execution-time measurement for one branch of processing an event.
void	addExecutionTime(long time) Add a new execution-time measurement for processing an event.
void	clear() Resets the state of this component statistics collector.
long	getAverageExecutionTime() Returns the average execution time, rounded downwards.
long	getExecutedEvents() Then number of events executed since last cleared.
long	getMaxExecutionTime() The maximum total event execution time seen since last cleared.
long	getMinExecutionTime() The minimum total event execution time seen since last cleared.
long	getTotalExecutionTime() The total cumulative execution time since statistics were last cleared.
boolean	isEnabled() Returns true if this stats collector is enabled.
void	logSummary()
void	logSummary(PrintWriter printer)
void	setEnabled(boolean enabled) Tags this stats collector as enabled or disabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentStatistics

public ComponentStatistics()

The constructor added to initialize the interval time in ms that stats are measured for from the property statIntervalTime. If the property is not set or cannot be parsed, disable interval time and just compute stats from start of mule.

TODO: The code to create and use an interval time for measuring average execution time could be removed once a complete solution is available in MuleHQ to monitor this

Method Detail

clear

public void clear()

Resets the state of this component statistics collector.

If called while a branch is being executed, then statistics may be slightly erroneous.

isEnabled

public boolean isEnabled()

Returns true if this stats collector is enabled.

This value does not affect statistics tabulation directly - it is up to the component to enable/disable collection based on the value of this method.

Specified by:

isEnabled in interface Statistics

Returns:

true if stats collection is enabled, otherwise false.

logSummary

public void logSummary()

logSummary

public void logSummary(PrintWriter printer)

setEnabled

public void setEnabled(boolean enabled)

Tags this stats collector as enabled or disabled.

Does not affect stats calculation - it is up to the caller to check this flag.

Parameters:

enabled - true if stats should be enabled, otherwise false.

getMaxExecutionTime

public long getMaxExecutionTime()

The maximum total event execution time seen since last cleared.

Returns:

The maximum time, or zero if no events have been started.

getMinExecutionTime

public long getMinExecutionTime()

The minimum total event execution time seen since last cleared.

Returns:

The maximum time, or zero if no events have been completed.

getTotalExecutionTime

public long getTotalExecutionTime()

The total cumulative execution time since statistics were last cleared. Includes the sum of all branch times plus any directly recorded execution times.

Returns:

The total cumulative execution time, in milliseconds.

getExecutedEvents

public long getExecutedEvents()

Then number of events executed since last cleared.

NOTE: When branch times are recorded, an event will typically be recorded as 'executed' on the first branch event. See addExecutionBranchTime(boolean, long, long).

Returns:

The number of events executed since last cleared.

addExecutionBranchTime

public void addExecutionBranchTime(boolean first,
                          long branch,
                          long total)

Add a new execution-time measurement for one branch of processing an event.

Parameters:

first - true if this is the first branch for this event

branch - the time to execute this branch

total - the total time (so far) for processing this event

addCompleteExecutionTime

public void addCompleteExecutionTime(long time)

Add the complete execution time for a flow that also reports branch execution times.

Use in conjunction with addExecutionBranchTime(boolean, long, long).

Parameters:

time - the total time required to process this event

addExecutionTime

public void addExecutionTime(long time)

Add a new execution-time measurement for processing an event.

Do not use when reporting branch execution times; instead see addCompleteExecutionTime(long).

Parameters:

time - The total event time to be logged/recorded.

getAverageExecutionTime

public long getAverageExecutionTime()

Returns the average execution time, rounded downwards.

Returns:

the total event time accumulated to this point, divided by the total number of events recorded.