Stats (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

All Known Subinterfaces:

CacheContainerStats, ClusterCacheStats

All Known Implementing Classes:

CacheContainerStatsImpl, ClusterCacheStatsImpl, StatsCollector, StatsImpl
```
public interface Stats
```
Stats.

Since:

4.0

Author:

Galder Zamarreño

Method Summary

All Methods Instance Methods Abstract Methods
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 `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()`
`long`	`getHits()`
`long`	`getMisses()`
`long`	`getOffHeapMemoryUsed()` The amount of off-heap memory used by this cache
`long`	`getRemoveHits()`
`long`	`getRemoveMisses()`
`int`	`getRequiredMinimumNumberOfNodes()`
`long`	`getRetrievals()`
`long`	`getStores()`
`long`	`getTimeSinceReset()`
`long`	`getTimeSinceStart()`
`long`	`getTotalNumberOfEntries()` Number of entries stored in cache since the cache started running.
`void`	`reset()` Reset statistics
`void`	`setStatisticsEnabled(boolean enabled)` Enables or disables statistics at runtime.

- Method Detail
  - getTimeSinceStart
```
long getTimeSinceStart()
```
    Returns:
    
    Number of seconds since cache started.
  - getTimeSinceReset
```
long getTimeSinceReset()
```
    Returns:
    
    Number of seconds since stats where reset
  - getCurrentNumberOfEntries
```
int getCurrentNumberOfEntries()
```
    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.
    
    Returns:
    
    Number of entries currently in the cache, including passivated entries.
  - getCurrentNumberOfEntriesInMemory
```
int getCurrentNumberOfEntriesInMemory()
```
    The same as getCurrentNumberOfEntries(), however passivated entries are not included.
  - getTotalNumberOfEntries
```
long getTotalNumberOfEntries()
```
    Number of entries stored in cache since the cache started running.
  - getOffHeapMemoryUsed
```
long getOffHeapMemoryUsed()
```
    The amount of off-heap memory used by this cache
    
    Returns:
  - getDataMemoryUsed
```
long getDataMemoryUsed()
```
    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.
    
    Returns:
    
    memory in use or 0 if memory eviction is not enabled
  - getStores
```
long getStores()
```
    Returns:
    
    Number of put operations on the cache.
  - getRetrievals
```
long getRetrievals()
```
    Returns:
    
    Number of get operations.
  - getHits
```
long getHits()
```
    Returns:
    
    Number of cache get hits.
  - getMisses
```
long getMisses()
```
    Returns:
    
    Number of cache get misses.
  - getRemoveHits
```
long getRemoveHits()
```
    Returns:
    
    Number of cache removal hits.
  - getRemoveMisses
```
long getRemoveMisses()
```
    Returns:
    
    Number of cache removal misses.
  - getEvictions
```
long getEvictions()
```
    Returns:
    
    Number of cache eviction.
  - getAverageReadTime
```
long getAverageReadTime()
```
    Returns:
    
    Average number of milliseconds for a cache get on the cache
  - getAverageReadTimeNanos
```
long getAverageReadTimeNanos()
```
    Returns:
    
    Average number of nanoseconds for a cache get on the cache
  - getAverageWriteTime
```
long getAverageWriteTime()
```
    Returns:
    
    Average number of milliseconds for a cache put on the cache
  - getAverageWriteTimeNanos
```
long getAverageWriteTimeNanos()
```
    Returns:
    
    Average number of milliseconds for a cache put on the cache
  - getAverageRemoveTime
```
long getAverageRemoveTime()
```
    Returns:
    
    Average number of milliseconds for a cache remove on the cache
  - getAverageRemoveTimeNanos
```
long getAverageRemoveTimeNanos()
```
    Returns:
    
    Average number of nanoseconds for a cache remove on the cache
  - getRequiredMinimumNumberOfNodes
```
int getRequiredMinimumNumberOfNodes()
```
    Returns:
    
    Required minimum number of nodes to guarantee data consistency
  - reset
```
void reset()
```
    Reset statistics
  - setStatisticsEnabled
```
void setStatisticsEnabled(boolean enabled)
```
    Enables or disables statistics at runtime.
    
    Parameters:
    
    enabled - boolean indicating whether statistics should be enable or not

Interface Stats

Method Summary

Method Detail

getTimeSinceStart

getTimeSinceReset

getCurrentNumberOfEntries

getCurrentNumberOfEntriesInMemory

getTotalNumberOfEntries

getOffHeapMemoryUsed

getDataMemoryUsed

getStores

getRetrievals

getHits

getMisses

getRemoveHits

getRemoveMisses

getEvictions

getAverageReadTime

getAverageReadTimeNanos

getAverageWriteTime

getAverageWriteTimeNanos

getAverageRemoveTime

getAverageRemoveTimeNanos

getRequiredMinimumNumberOfNodes

reset

setStatisticsEnabled