CacheInfoMXBean (cache2k JMX API 1.0.2.Final API)

All Known Subinterfaces:

CacheMXBean
```
public interface CacheInfoMXBean
```
Exposed statistics via JMX from a cache.

Author:

Jens Wilke

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getAlert()` Single health value from 0 meaning good, 1 meaning warning, and 2 meaning failure.
`long`	`getClearCount()` Number of `Cache.clear()` invocations.
`long`	`getClearedEntriesCount()` Number entries removed from the cache by the `Cache.clear()` operation.
`Date`	`getClearedTime()` Time of the most recent `Cache.clear()` operation.
`Date`	`getCreatedTime()` Time when the cache was created.
`long`	`getEntryCapacity()` The configured maximum number of entries in the cache.
`long`	`getEvictedCount()` An entry was evicted from the cache because of size limits.
`String`	`getEvictionStatistics()` Additional statistics from the eviction algorithm.
`long`	`getExpiredCount()` Counter for the event that data in the cache has expired.
`long`	`getGetCount()` How often data was requested from the cache.
`int`	`getHashQuality()` A value between 0 and 100 to help evaluate the quality of the hashing function.
`double`	`getHitRate()` The percentage of cache accesses the cache delivered data.
`String`	`getImplementation()` Implementation class of the cache.
`int`	`getInfoCreatedDeltaMillis()` Milliseconds needed to provide the data.
`Date`	`getInfoCreatedTime()` Time when the cache information was created for JMX.
`long`	`getInsertCount()` How many times a new entry was inserted into the cache.
`String`	`getIntegrityDescriptor()` The cache checks some internal values for correctness.
`long`	`getKeyMutationCount()` Number of key mutations occurred.
`String`	`getKeyType()` Type of the cache key.
`long`	`getLoadCount()` How many times a load succeeded.
`long`	`getLoadExceptionCount()` Number of exceptions thrown by the `CacheLoader`.
`double`	`getMillisPerLoad()` Average number of milliseconds per load.
`long`	`getMissCount()` Counter of the event that: a client requested a data which was not present in the cache or had expired.
`long`	`getPutCount()` The total number of insert or update operations.
`long`	`getRefreshCount()` Counter for the event that the data of a cache entry was refreshed.
`long`	`getRefreshedHitCount()` How many times we had a hit on a refreshed entry.
`long`	`getRefreshFailedCount()` Counter how many times a refresh failed, because there were not enough thread resources available.
`long`	`getRemoveCount()` Number of remove operations.
`long`	`getSize()` The current number of entries within the cache, starting with 0.
`long`	`getSuppressedLoadExceptionCount()` Number of exceptions thrown by the `CacheLoader` that were ignored and the previous data value got returned.
`long`	`getTotalLoadMillis()` Total number of time spent loading entries from the cache loader.
`String`	`getValueType()` Type of the cache value.

- Method Detail
  - getKeyType
```
String getKeyType()
```
    Type of the cache key.
  - getValueType
```
String getValueType()
```
    Type of the cache value.
  - getSize
```
long getSize()
```
    The current number of entries within the cache, starting with 0. When iterating the entries the cache will always return less or an identical number of entries.
    Expired entries may stay in the cache Cache2kBuilder.keepDataAfterExpired(boolean). These entries will be counted, but will not be returned by the iterator or a peek operation
  - getEntryCapacity
```
long getEntryCapacity()
```
    The configured maximum number of entries in the cache.
  - getInsertCount
```
long getInsertCount()
```
    How many times a new entry was inserted into the cache.
  - getGetCount
```
long getGetCount()
```
    How often data was requested from the cache. In multi threading scenarios this counter may be not totally accurate. For performance reason the cache implementation may choose to only present a best effort value. It is guaranteed that the usage count is always greater than the miss count.
  - getMissCount
```
long getMissCount()
```
    Counter of the event that: a client requested a data which was not present in the cache or had expired.
  - getLoadCount
```
long getLoadCount()
```
    How many times a load succeeded.
  - getRefreshCount
```
long getRefreshCount()
```
    Counter for the event that the data of a cache entry was refreshed.
  - getRefreshFailedCount
```
long getRefreshFailedCount()
```
    Counter how many times a refresh failed, because there were not enough thread resources available.
  - getRefreshedHitCount
```
long getRefreshedHitCount()
```
    How many times we had a hit on a refreshed entry.
  - getExpiredCount
```
long getExpiredCount()
```
    Counter for the event that data in the cache has expired.
    This can mean that the cache entry is removed or just marked as expired in case that the keep value option is enabled.
    
    See Also:
    
    Cache2kConfiguration.setKeepDataAfterExpired(boolean)
  - getEvictedCount
```
long getEvictedCount()
```
    An entry was evicted from the cache because of size limits.
  - getPutCount
```
long getPutCount()
```
    The total number of insert or update operations.
  - getRemoveCount
```
long getRemoveCount()
```
    Number of remove operations.
  - getClearedEntriesCount
```
long getClearedEntriesCount()
```
    Number entries removed from the cache by the Cache.clear() operation.
  - getClearCount
```
long getClearCount()
```
    Number of Cache.clear() invocations.
  - getKeyMutationCount
```
long getKeyMutationCount()
```
    Number of key mutations occurred. This should be always 0, otherwise it is an indicator that the hash keys objects are modified by the application after usage within a cache request.
  - getLoadExceptionCount
```
long getLoadExceptionCount()
```
    Number of exceptions thrown by the CacheLoader.
  - getSuppressedLoadExceptionCount
```
long getSuppressedLoadExceptionCount()
```
    Number of exceptions thrown by the CacheLoader that were ignored and the previous data value got returned.
  - getHitRate
```
double getHitRate()
```
    The percentage of cache accesses the cache delivered data.
  - getHashQuality
```
int getHashQuality()
```
    A value between 0 and 100 to help evaluate the quality of the hashing function. 100 means perfect, there are no collisions. A value of 80 means that 80% of the entries are reachable without collision. The size of the longest collision list is also combined into this value, for example if the longest collision size is 20, then this value is 85 and below. This way this metrics can be used to detect bad hash function and hash collision attacks.
  - getMillisPerLoad
```
double getMillisPerLoad()
```
    Average number of milliseconds per load.
  - getTotalLoadMillis
```
long getTotalLoadMillis()
```
    Total number of time spent loading entries from the cache loader.
  - getImplementation
```
String getImplementation()
```
    Implementation class of the cache.
  - getCreatedTime
```
Date getCreatedTime()
```
    Time when the cache was created.
  - getClearedTime
```
Date getClearedTime()
```
    Time of the most recent Cache.clear() operation.
  - getInfoCreatedTime
```
Date getInfoCreatedTime()
```
    Time when the cache information was created for JMX. Some of the values may take processing time. The cache does not always return the latest values if the object is requested very often.
  - getInfoCreatedDeltaMillis
```
int getInfoCreatedDeltaMillis()
```
    Milliseconds needed to provide the data.
  - getAlert
```
int getAlert()
```
    Single health value from 0 meaning good, 1 meaning warning, and 2 meaning failure. Some operations may cause a warning alert level and then, after a few seconds, when everything is back to normal, reset it. A monitoring trigger, should have a delay (e.g. 30 seconds) before escalating to the operations team.
  - getEvictionStatistics
```
String getEvictionStatistics()
```
    Additional statistics from the eviction algorithm. This is an arbitrary string for debugging and tuning the eviction algorithm.
  - getIntegrityDescriptor
```
String getIntegrityDescriptor()
```
    The cache checks some internal values for correctness. If this does not start with "0.", then please raise a bug.

Interface CacheInfoMXBean

Method Summary

Method Detail

getKeyType

getValueType

getSize

getEntryCapacity

getInsertCount

getGetCount

getMissCount

getLoadCount

getRefreshCount

getRefreshFailedCount

getRefreshedHitCount

getExpiredCount

getEvictedCount

getPutCount

getRemoveCount

getClearedEntriesCount

getClearCount

getKeyMutationCount

getLoadExceptionCount

getSuppressedLoadExceptionCount

getHitRate

getHashQuality

getMillisPerLoad

getTotalLoadMillis

getImplementation

getCreatedTime

getClearedTime

getInfoCreatedTime

getInfoCreatedDeltaMillis

getAlert

getEvictionStatistics

getIntegrityDescriptor