org.infinispan.stats.impl

Class StatsCollector

java.lang.Object

org.infinispan.stats.impl.StatsCollector

All Implemented Interfaces:

JmxStatisticsExposer, Stats

@MBean(objectName="Statistics",
       description="General statistics such as timings, hit/miss ratio, etc.")
public final class StatsCollector
extends Object
implements Stats, JmxStatisticsExposer

Author:

Radim Vansa <rvansa@redhat.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatsCollector.Factory

Constructor Summary

Constructors

Constructor and Description
StatsCollector()

Method Summary

Modifier and Type	Method and Description
long	getAverageReadTime()
long	getAverageReadTimeNanos()
long	getAverageRemoveTime()
long	getAverageRemoveTimeNanos()
long	getAverageWriteTime()
long	getAverageWriteTimeNanos()
int	getCurrentNumberOfEntries() Returns the number of entries currently in this cache instance.
int	getCurrentNumberOfEntriesInMemory() The same as Stats.getCurrentNumberOfEntries(), however passivated entries are not included.
long	getDataMemoryUsed() Provides how much memory the current eviction algorithm estimates is in use for data.
long	getEvictions()
double	getHitRatio()
long	getHits()
long	getMisses()
int	getNumberOfEntries()
long	getOffHeapMemoryUsed() The amount of off-heap memory used by this cache
double	getReadWriteRatio()
long	getRemoveHits()
long	getRemoveMisses()
int	getRequiredMinimumNumberOfNodes()
long	getRetrievals()
boolean	getStatisticsEnabled() Returns whether an interceptor's statistics are being captured.
long	getStores()
long	getTimeSinceReset()
long	getTimeSinceStart()
long	getTotalNumberOfEntries() Number of entries stored in cache since the cache started running.
void	recordEviction()
void	recordHits(int hits, long time)
void	recordMisses(int misses, long time)
void	recordRemoveHits(int removes, long time)
void	recordRemoveMisses(int removes)
void	recordStores(int stores, long time)
void	reset() Reset statistics
void	resetStatistics() Resets an interceptor's cache statistics
void	setStatisticsEnabled(boolean enabled) Enables or disables statistics at runtime.
void	start()

Methods inherited from class java.lang.Object

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

Constructor Detail

StatsCollector

public StatsCollector()

Method Detail

start

public void start()

getHits

@ManagedAttribute(description="Number of cache attribute hits",
                  displayName="Number of cache hits",
                  measurementType=TRENDSUP)
public long getHits()

Specified by:

getHits in interface Stats

Returns:

Number of cache get hits.

getMisses

@ManagedAttribute(description="Number of cache attribute misses",
                  displayName="Number of cache misses",
                  measurementType=TRENDSUP)
public long getMisses()

Specified by:

getMisses in interface Stats

Returns:

Number of cache get misses.

getRemoveHits

@ManagedAttribute(description="Number of cache removal hits",
                  displayName="Number of cache removal hits",
                  measurementType=TRENDSUP)
public long getRemoveHits()

Specified by:

getRemoveHits in interface Stats

Returns:

Number of cache removal hits.

getRemoveMisses

@ManagedAttribute(description="Number of cache removals where keys were not found",
                  displayName="Number of cache removal misses",
                  measurementType=TRENDSUP)
public long getRemoveMisses()

Specified by:

getRemoveMisses in interface Stats

Returns:

Number of cache removal misses.

getStores

@ManagedAttribute(description="Number of cache attribute put operations",
                  displayName="Number of cache puts",
                  measurementType=TRENDSUP)
public long getStores()

Specified by:

getStores in interface Stats

Returns:

Number of put operations on the cache.

getRetrievals

public long getRetrievals()

Specified by:

getRetrievals in interface Stats

Returns:

Number of get operations.

getEvictions

@ManagedAttribute(description="Number of cache eviction operations",
                  displayName="Number of cache evictions",
                  measurementType=TRENDSUP)
public long getEvictions()

Specified by:

getEvictions in interface Stats

Returns:

Number of cache eviction.

getHitRatio

@ManagedAttribute(description="Percentage hit/(hit+miss) ratio for the cache",
                  displayName="Hit ratio",
                  units=PERCENTAGE)
public double getHitRatio()

getReadWriteRatio

@ManagedAttribute(description="Read/writes ratio for the cache",
                  displayName="Read/write ratio",
                  units=PERCENTAGE)
public double getReadWriteRatio()

getAverageReadTime

@ManagedAttribute(description="Average number of milliseconds for a read operation on the cache",
                  displayName="Average read time",
                  units=MILLISECONDS)
public long getAverageReadTime()

Specified by:

getAverageReadTime in interface Stats

Returns:

Average number of milliseconds for a cache get on the cache

getAverageReadTimeNanos

@ManagedAttribute(description="Average number of nanoseconds for a read operation on the cache",
                  displayName="Average read time (ns)",
                  units=NANOSECONDS)
public long getAverageReadTimeNanos()

Specified by:

getAverageReadTimeNanos in interface Stats

Returns:

Average number of nanoseconds for a cache get on the cache

getAverageWriteTime

@ManagedAttribute(description="Average number of milliseconds for a write operation in the cache",
                  displayName="Average write time",
                  units=MILLISECONDS)
public long getAverageWriteTime()

Specified by:

getAverageWriteTime in interface Stats

Returns:

Average number of milliseconds for a cache put on the cache

getAverageWriteTimeNanos

@ManagedAttribute(description="Average number of nanoseconds for a write operation in the cache",
                  displayName="Average write time (ns)",
                  units=NANOSECONDS)
public long getAverageWriteTimeNanos()

Specified by:

getAverageWriteTimeNanos in interface Stats

Returns:

Average number of milliseconds for a cache put on the cache

getAverageRemoveTime

@ManagedAttribute(description="Average number of milliseconds for a remove operation in the cache",
                  displayName="Average remove time",
                  units=MILLISECONDS)
public long getAverageRemoveTime()

Specified by:

getAverageRemoveTime in interface Stats

Returns:

Average number of milliseconds for a cache remove on the cache

getAverageRemoveTimeNanos

@ManagedAttribute(description="Average number of nanoseconds for a remove operation in the cache",
                  displayName="Average remove time (ns)",
                  units=NANOSECONDS)
public long getAverageRemoveTimeNanos()

Specified by:

getAverageRemoveTimeNanos in interface Stats

Returns:

Average number of nanoseconds for a cache remove on the cache

getRequiredMinimumNumberOfNodes

@ManagedAttribute(description="Required minimum number of nodes to hold current cache data",
                  displayName="Required minimum number of nodes")
public int getRequiredMinimumNumberOfNodes()

Specified by:

getRequiredMinimumNumberOfNodes in interface Stats

Returns:

Required minimum number of nodes to guarantee data consistency

reset

public void reset()

Description copied from interface: Stats

Reset statistics

Specified by:

reset in interface Stats

getStatisticsEnabled

public boolean getStatisticsEnabled()

Description copied from interface: JmxStatisticsExposer

Returns whether an interceptor's statistics are being captured.

Specified by:

getStatisticsEnabled in interface JmxStatisticsExposer

Returns:

true if statistics are captured

setStatisticsEnabled

@ManagedAttribute(description="Enables or disables the gathering of statistics by this component",
                  writable=true)
public void setStatisticsEnabled(boolean enabled)

Description copied from interface: Stats

Enables or disables statistics at runtime.

Specified by:

setStatisticsEnabled in interface JmxStatisticsExposer

Specified by:

setStatisticsEnabled in interface Stats

Parameters:

enabled - boolean indicating whether statistics should be enable or not

getNumberOfEntries

@ManagedAttribute(description="Number of entries in the cache including passivated entries",
                  displayName="Number of current cache entries")
public int getNumberOfEntries()

getCurrentNumberOfEntriesInMemory

@ManagedAttribute(description="Number of entries currently in-memory excluding expired entries",
                  displayName="Number of in-memory cache entries")
public int getCurrentNumberOfEntriesInMemory()

Description copied from interface: Stats

The same as Stats.getCurrentNumberOfEntries(), however passivated entries are not included.

Specified by:

getCurrentNumberOfEntriesInMemory in interface Stats

getTimeSinceStart

@ManagedAttribute(description="Number of seconds since cache started",
                  displayName="Seconds since cache started",
                  units=SECONDS,
                  measurementType=TRENDSUP)
public long getTimeSinceStart()

Specified by:

getTimeSinceStart in interface Stats

Returns:

Number of seconds since cache started.

getTimeSinceReset

@ManagedAttribute(description="Number of seconds since the cache statistics were last reset",
                  displayName="Seconds since cache statistics were reset",
                  units=SECONDS)
public long getTimeSinceReset()

Specified by:

getTimeSinceReset in interface Stats

Returns:

Number of seconds since stats where reset

getCurrentNumberOfEntries

public int getCurrentNumberOfEntries()

Description copied from interface: Stats

Returns the number of entries currently in this cache instance. When the cache is configured with distribution, this method only returns the number of entries in the local cache instance. In other words, it does not attempt to communicate with other nodes to find out about the data stored in other nodes in the cluster that is not available locally.

Specified by:

getCurrentNumberOfEntries in interface Stats

Returns:

Number of entries currently in the cache, including passivated entries.

getTotalNumberOfEntries

public long getTotalNumberOfEntries()

Description copied from interface: Stats

Number of entries stored in cache since the cache started running.

Specified by:

getTotalNumberOfEntries in interface Stats

getDataMemoryUsed

@ManagedAttribute(description="Amount of memory in bytes allocated for use in eviction for data in the cache",
                  displayName="Memory used by data in the cache")
public long getDataMemoryUsed()

Description copied from interface: Stats

Provides how much memory the current eviction algorithm estimates is in use for data. This method will return a number 0 or greater if memory eviction is in use. If memory eviction is not enabled this method will always return 0.

Specified by:

getDataMemoryUsed in interface Stats

Returns:

memory in use or 0 if memory eviction is not enabled

getOffHeapMemoryUsed

@ManagedAttribute(description="Amount off-heap memory used by this cache (bytes)",
                  displayName="Off-Heap memory used")
public long getOffHeapMemoryUsed()

Description copied from interface: Stats

The amount of off-heap memory used by this cache

Specified by:

getOffHeapMemoryUsed in interface Stats

Returns:

resetStatistics

@ManagedOperation(description="Resets statistics gathered by this component",
                  displayName="Reset Statistics (Statistics)")
public void resetStatistics()

Description copied from interface: JmxStatisticsExposer

Resets an interceptor's cache statistics

Specified by:

resetStatistics in interface JmxStatisticsExposer

recordMisses

public void recordMisses(int misses,
                         long time)

recordHits

public void recordHits(int hits,
                       long time)

recordEviction

public void recordEviction()

recordStores

public void recordStores(int stores,
                         long time)

recordRemoveHits

public void recordRemoveHits(int removes,
                             long time)

recordRemoveMisses

public void recordRemoveMisses(int removes)