```
public interface InternalCacheInfo
```
Collection of all metrics of a cache. The data can be retrieved via InternalCache.getInfo() or InternalCache.getConsistentInfo().
The interface is not exposed via the exposed API since it may change between versions. Exposed metrics are defined in CacheStatistics which can be retrieved via CacheControl.sampleStatistics()

Author:

Jens Wilke

See Also:

EvictionMetrics, CommonMetrics

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`getClearCount()`	Number of calls to `clear` this cache has received.
`long`	`getClearedEntriesCount()`	Number of entries removed from the cache by the `clear` operation.
`Instant`	`getClearedTime()`	Time of last clear operation.
`long`	`getEvictedCount()`	Entry was evicted.
`long`	`getEvictedWeight()`
`int`	`getEvictionRunningCount()`	Number of entries currently being evicted.
`long`	`getExpiredCount()`	Counts entries that expired.
`long`	`getExplicitLoadCount()`
`String`	`getFailedIntegrityChecks()`
`long`	`getGetCount()`	Number of cache operations, only access
`long`	`getGoneSpinCount()`	Entry was removed while waiting to get the mutation lock.
`long`	`getHeapCapacity()`	Configured limit of the total cache entry capacity or -1 if weigher is used.
`long`	`getHeapHitCount()`	Total counted hits on the heap cache data.
`double`	`getHitRate()`	Hit rate of the cache
`String`	`getHitRateString()`	Hit rate of the cache in string representation
`String`	`getImplementation()`
`Instant`	`getInfoCreatedTime()`	Time when the info object was created.
`long`	`getInternalExceptionCount()`	The cache produced an exception by itself that should have been prevented.
`long`	`getKeyMutationCount()`	After inserting into the cache the key object changed its hash code.
`long`	`getLoadCount()`	Successful loads including reloads and refresh.
`long`	`getLoadExceptionCount()`	Counter of exceptions thrown from the loader.
`long`	`getLoadMillis()`	Accumulated loader execution time.
`long`	`getMaximumWeight()`	Configured maximum weight or -1 if entry capacity is used.
`double`	`getMillisPerLoad()`	Average duration in milliseconds for each load operation.
`long`	`getMissCount()`	A value was requested, either the entry is not present or the data was expired.
`String`	`getName()`	Configured name of the cache or null if anonymous.
`long`	`getNewEntryCount()`	Number of created cache entries.
`long`	`getPutCount()`	Entry was inserted in the cache via put or another operation not including a load.
`long`	`getRefreshCount()`	Entry was loaded again, triggered by timer.
`long`	`getRefreshedHitCount()`	A previously refreshed entry was accessed.
`long`	`getRefreshRejectedCount()`	Entry was supposed to be refreshed, but there was no thread available for executing it.
`long`	`getRemoveCount()`	Removed entries, because of programmatic removal.
`long`	`getScanCount()`
`long`	`getSize()`	Current number of entries in the cache.
`Instant`	`getStartedTime()`	Time when the cache started the operation.
`long`	`getSuppressedExceptionCount()`	Loader exception occurred, but the resilience policy decided to suppress the exception and continue to use the available value.
`long`	`getTimerEventCount()`	Count of timer events delivered to this cache.
`long`	`getTotalWeight()`	Current sum of entry weights as returned by the `Weigher`
`boolean`	`isIntegrityFailure()`

- Method Detail
  - getName
```
String getName()
```
    Configured name of the cache or null if anonymous.
  - getImplementation
```
String getImplementation()
```
  - getSize
```
long getSize()
```
    Current number of entries in the cache. This may include entries with expired values.
  - getHeapCapacity
```
long getHeapCapacity()
```
    Configured limit of the total cache entry capacity or -1 if weigher is used.
  - getMaximumWeight
```
long getMaximumWeight()
```
    Configured maximum weight or -1 if entry capacity is used.
  - getTotalWeight
```
long getTotalWeight()
```
    Current sum of entry weights as returned by the Weigher
  - getHeapHitCount
```
long getHeapHitCount()
```
    Total counted hits on the heap cache data. The counter is increased when an entry is present in the cache, regardless whether the value is valid or not.
  - getGetCount
```
long getGetCount()
```
    Number of cache operations, only access
  - getMissCount
```
long getMissCount()
```
    A value was requested, either the entry is not present or the data was expired.
  - getNewEntryCount
```
long getNewEntryCount()
```
    Number of created cache entries. Counter is increased for a load operation, put, etc. when the entry is not yet in the cache. A load operation always creates a new cache entry, even if the the expiry is immediately to block multiple loads. This counter is provided by the eviction implementation.
    
    See Also:
    
    EvictionMetrics.getNewEntryCount()
  - getLoadCount
```
long getLoadCount()
```
    Successful loads including reloads and refresh.
  - getExplicitLoadCount
```
long getExplicitLoadCount()
```
    See Also:
    
    CommonMetrics.getExplicitLoadCount()
  - getRefreshCount
```
long getRefreshCount()
```
    Entry was loaded again, triggered by timer. The count includes all triggered and tried refresh actions, including those that produced and exception as result. A refresh is also counted as load in getLoadCount()
    
    See Also:
    
    CommonMetrics.getRefreshCount()
  - getInternalExceptionCount
```
long getInternalExceptionCount()
```
    The cache produced an exception by itself that should have been prevented.
  - getRefreshRejectedCount
```
long getRefreshRejectedCount()
```
    Entry was supposed to be refreshed, but there was no thread available for executing it.
    
    See Also:
    
    CommonMetrics.getRefreshRejectedCount()
  - getSuppressedExceptionCount
```
long getSuppressedExceptionCount()
```
    Loader exception occurred, but the resilience policy decided to suppress the exception and continue to use the available value.
    
    See Also:
    
    CommonMetrics.getSuppressedExceptionCount()
  - getLoadExceptionCount
```
long getLoadExceptionCount()
```
    Counter of exceptions thrown from the loader.
    
    See Also:
    
    CommonMetrics.getLoadExceptionCount()
  - getRefreshedHitCount
```
long getRefreshedHitCount()
```
    A previously refreshed entry was accessed. The access is only counted once after a refresh operation, so the ration of refresh and refreshed hit is the efficiency of the refresh operation.
    
    See Also:
    
    CommonMetrics.getRefreshedHitCount()
  - getExpiredCount
```
long getExpiredCount()
```
    Counts entries that expired. This counter includes removed entries from the cache and entries that are kept in the cache but expired.
    
    See Also:
    
    EvictionMetrics.getExpiredRemovedCount(), CommonMetrics.getExpiredKeptCount()
  - getEvictedCount
```
long getEvictedCount()
```
    Entry was evicted.
    
    See Also:
    
    EvictionMetrics.getEvictedCount()
  - getEvictionRunningCount
```
int getEvictionRunningCount()
```
    Number of entries currently being evicted.
    
    See Also:
    
    EvictionMetrics.getEvictionRunningCount()
  - getRemoveCount
```
long getRemoveCount()
```
    Removed entries, because of programmatic removal. Removal of entries by clear is counted separately. Provided by the eviction implementation.
    
    See Also:
    
    getClearedEntriesCount(), EvictionMetrics.getRemovedCount()
  - getPutCount
```
long getPutCount()
```
    Entry was inserted in the cache via put or another operation not including a load.
    
    See Also:
    
    CommonMetrics.getPutNewEntryCount(), CommonMetrics.getPutHitCount()
  - getClearedEntriesCount
```
long getClearedEntriesCount()
```
    Number of entries removed from the cache by the clear operation.
    
    See Also:
    
    Cache.clear()
  - getClearCount
```
long getClearCount()
```
    Number of calls to clear this cache has received.
    
    See Also:
    
    Cache.clear()
  - getKeyMutationCount
```
long getKeyMutationCount()
```
    After inserting into the cache the key object changed its hash code.
  - getTimerEventCount
```
long getTimerEventCount()
```
    Count of timer events delivered to this cache.
    
    See Also:
    
    CommonMetrics.getTimerEventCount()
  - getHitRate
```
double getHitRate()
```
    Hit rate of the cache
  - getHitRateString
```
String getHitRateString()
```
    Hit rate of the cache in string representation
  - getMillisPerLoad
```
double getMillisPerLoad()
```
    Average duration in milliseconds for each load operation.
  - getLoadMillis
```
long getLoadMillis()
```
    Accumulated loader execution time.
    
    See Also:
    
    CommonMetrics.getLoadTicks()
  - isIntegrityFailure
```
boolean isIntegrityFailure()
```
  - getFailedIntegrityChecks
```
String getFailedIntegrityChecks()
```
  - getGoneSpinCount
```
long getGoneSpinCount()
```
    Entry was removed while waiting to get the mutation lock.
    
    See Also:
    
    CommonMetrics.getGoneSpinCount()
  - getStartedTime
```
Instant getStartedTime()
```
    Time when the cache started the operation.
  - getClearedTime
```
Instant getClearedTime()
```
    Time of last clear operation.
  - getInfoCreatedTime
```
Instant getInfoCreatedTime()
```
    Time when the info object was created. The information needs time to collect. Whenever statistics are requested, a new values may be collected or old values are used. The recency of the information can be determined by this value.
  - getEvictedWeight
```
long getEvictedWeight()
```
  - getScanCount
```
long getScanCount()
```

Interface InternalCacheInfo

Method Summary

Method Detail

getName

getImplementation

getSize

getHeapCapacity

getMaximumWeight

getTotalWeight

getHeapHitCount

getGetCount

getMissCount

getNewEntryCount

getLoadCount

getExplicitLoadCount

getRefreshCount

getInternalExceptionCount

getRefreshRejectedCount

getSuppressedExceptionCount

getLoadExceptionCount

getRefreshedHitCount

getExpiredCount

getEvictedCount

getEvictionRunningCount

getRemoveCount

getPutCount

getClearedEntriesCount

getClearCount

getKeyMutationCount

getTimerEventCount

getHitRate

getHitRateString

getMillisPerLoad

getLoadMillis

isIntegrityFailure

getFailedIntegrityChecks

getGoneSpinCount

getStartedTime

getClearedTime

getInfoCreatedTime

getEvictedWeight

getScanCount