com.ibm.websphere.objectgrid.stats
Interface MapStatsModule

All Superinterfaces:

StatsModule

public interface MapStatsModule
extends StatsModule

This interface represents a statistic module for map. A map statistic module contains 3 statistics:

1. number of entries
2. the map hit rate, which includes map get count and hit count
3. the loader batch update time

The path to a map statistic module is the ObjectGrid name, concatenated with "/", and then the map name. You can also use an array to represent the path, with the first element being the ObjectGrid name, and the second element being the map name.

Since:

WAS XD 6.0.1

See Also:

MapMBean.retrieveStatsModule()

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	getBatchUpdateTime(boolean copyMode) Gets the map's loader batch update time.
PercentageStatistic	getHitRate(boolean copyMode) Gets the map hit rate statistic.
ActiveCountStatistic	getNumEntries(boolean copyMode) Gets the number of entries statistic.
ActiveCountStatistic	getUsedBytes(boolean copyMode) Gets the number of bytes in use by the map.

Methods inherited from interface com.ibm.websphere.objectgrid.stats.StatsModule

combine, copy, getPath, getStatsSpec, reset, setGroupModule, statsToString, update

Method Detail

getNumEntries

ActiveCountStatistic getNumEntries(boolean copyMode)

Gets the number of entries 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 number of entries count statistic

See Also:

ActiveCountStatistic

getUsedBytes

ActiveCountStatistic getUsedBytes(boolean copyMode)

Gets the number of bytes in use by the map.

The used bytes statistics are accurate only when you are using simple objects or the COPY_TO_BYTES copy mode.

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 number of bytes used count statistic

See Also:

ActiveCountStatistic

getHitRate

PercentageStatistic getHitRate(boolean copyMode)

Gets the map hit rate 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.

This statistic also contains the map get count and hit count from which the hit rate is derived.

Parameters:

copyMode - if set to true, a copy is returned.

Returns:

the map hit rate statistic

See Also:

PercentageStatistic

getBatchUpdateTime

ActiveTimeStatistic getBatchUpdateTime(boolean copyMode)

Gets the map's loader batch update time.

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 map's loader batch update time statistic

See Also:

ActiveTimeStatistic, Loader.batchUpdate(TxID, LogSequence)