IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.objectgrid.stats
Interface AgentStatsModule

All Superinterfaces:
StatsModule

public interface AgentStatsModule
extends StatsModule

This interface represents a statistic module for an Agent. An Agent statistic module contains the following statistics:

  1. agent class serialization time
  2. agent class inflation time
  3. failure count
  4. invocation count
  5. partition count
  6. reduce time
  7. result set inflation time
  8. result set serialization time
  9. total run time
The path to a map statistic module is the ObjectGrid name, concatenated with "/", map name, and then the agent class name. You can also use an array to represent the path, with the first element being the ObjectGrid name, the second element being the map name, and the third being the agent class name.

Since:
WAS XD 6.1.0.5
See Also:
AgentManagerMBean.retrieveStatsModule(String)

Field Summary
 
Fields inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule
MODULE_TYPE_AGENT, MODULE_TYPE_HASHINDEX, MODULE_TYPE_MAP, MODULE_TYPE_OBJECT_GRID, MODULE_TYPE_QUERY, MODULE_TYPE_SESSION, MODULE_TYPE_UNDEFINED, PATH_DELIMITER
 
Method Summary
 ActiveTimeStatistic getAgentInflationTime(boolean copyMode)
          Gets the agent inflation time statistic.
 ActiveTimeStatistic getAgentSerializationTime(boolean copyMode)
          Gets the agent serialization time statistic.
 ActiveCountStatistic getFailureCount(boolean copyMode)
          Gets the failure count statistic.
 ActiveCountStatistic getInvocationCount(boolean copyMode)
          Gets the invocation count statistic.
 ActiveCountStatistic getPartitionCount(boolean copyMode)
          Gets the partition count statistic.
 ActiveTimeStatistic getReduceTime(boolean copyMode)
          Gets the reduce time statistic.
 ActiveTimeStatistic getResultInflationTime(boolean copyMode)
          Gets the result inflation time statistic.
 ActiveTimeStatistic getResultSerializationTime(boolean copyMode)
          Gets the result serialization time statistic.
 ActiveTimeStatistic getTotalDurationTime(boolean copyMode)
          Gets the total duration time statistic.
 
Methods inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule
combine, copy, getPath, getStatsSpec, reset, setGroupModule, statsToString, update
 

Method Detail

getReduceTime

ActiveTimeStatistic getReduceTime(boolean copyMode)
Gets the reduce time statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
the reduce time, time statistic
See Also:
ActiveTimeStatistic

getTotalDurationTime

ActiveTimeStatistic getTotalDurationTime(boolean copyMode)
Gets the total duration time statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
the total duration time statistic
See Also:
ActiveTimeStatistic

getAgentSerializationTime

ActiveTimeStatistic getAgentSerializationTime(boolean copyMode)
Gets the agent serialization time statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
the agent serialization time statistic
See Also:
ActiveTimeStatistic

getAgentInflationTime

ActiveTimeStatistic getAgentInflationTime(boolean copyMode)
Gets the agent inflation time statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
the agent inflation time statistic
See Also:
ActiveTimeStatistic

getResultInflationTime

ActiveTimeStatistic getResultInflationTime(boolean copyMode)
Gets the result inflation time statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
the result inflation time statistic
See Also:
ActiveTimeStatistic

getResultSerializationTime

ActiveTimeStatistic getResultSerializationTime(boolean copyMode)
Gets the result serialization time statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
the result serialization time statistic
See Also:
ActiveTimeStatistic

getPartitionCount

ActiveCountStatistic getPartitionCount(boolean copyMode)
Gets the partition count statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
the partition count statistic
See Also:
ActiveCountStatistic

getFailureCount

ActiveCountStatistic getFailureCount(boolean copyMode)
Gets the failure count statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
the failure count statistic
See Also:
ActiveCountStatistic

getInvocationCount

ActiveCountStatistic getInvocationCount(boolean copyMode)
Gets the invocation count statistic.

If the copyMode is set to true, a copy is returned. It is recommended to set the copy mode to true when this method is called in the same JVM as the JVM in which the statistics are gathered.

Parameters:
copyMode - if set to true, a copy is returned.
Returns:
the invocation count statistic
See Also:
ActiveCountStatistic

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.