All Known Subinterfaces:

CommonMetrics.Updater

All Known Implementing Classes:

CommonMetrics.BlackHole, StandardCommonMetrics
```
public interface CommonMetrics
```
Statistic metrics common to every cache type.

Author:

Jens Wilke

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class CommonMetrics.BlackHole

static interface CommonMetrics.Updater

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`getExpiredKeptCount()`	Number of entries expired, but kept in the cache because of ongoing processing on the entry (pinned) or because keepData is enabled.
`long`	`getExplicitLoadCount()`	Entry was explicitly loaded, that is every load that is not read through or refresh.
`long`	`getGoneSpinCount()`	Entry was removed while waiting to get the mutation lock.
`long`	`getHeapHitButNoReadCount()`	Operation was accessing a heap entry and counted a hit if it is existing, but it should not be counted as read/get operation (e.g.
`long`	`getHeapHitCount()`
`long`	`getLoadExceptionCount()`	Counter of exceptions thrown from the loader.
`long`	`getLoadMillis()`	Accumulated milliseconds spend in load operations.
`long`	`getPeekHitNotFreshCount()`	Peek, but entry available was not fresh (expired).
`long`	`getPeekMissCount()`	Incremented if data is requested from the cache but no entry is present (e.g.
`long`	`getPutHitCount()`	Counted for a put that updates an existing cache entry.
`long`	`getPutNewEntryCount()`	Counted for a put that triggers the insert of a new cache entry.
`long`	`getReadThroughCount()`	Entry was loaded, triggered by a get().
`long`	`getRefreshCount()`	Entry was loaded again, triggered by timer
`long`	`getRefreshedHitCount()`	Entry on probation for refresh got hit.
`long`	`getRefreshRejectedCount()`	Refresh submit failed.
`long`	`getSuppressedExceptionCount()`	Counter of suppressed exceptions from the loader
`long`	`getTimerEventCount()`	Count of timer events delivered to this cache.
`boolean`	`isDisabled()`	True if statistics are disabled.

- Method Detail
  - getHeapHitCount
```
long getHeapHitCount()
```
  - getPutNewEntryCount
```
long getPutNewEntryCount()
```
    Counted for a put that triggers the insert of a new cache entry.
    
    See Also:
    
    InternalCacheInfo.getPutCount()
  - getPutHitCount
```
long getPutHitCount()
```
    Counted for a put that updates an existing cache entry.
    
    See Also:
    
    InternalCacheInfo.getPutCount()
  - getHeapHitButNoReadCount
```
long getHeapHitButNoReadCount()
```
    Operation was accessing a heap entry and counted a hit if it is existing, but it should not be counted as read/get operation (e.g. contains). This is a correction counter applied to the get counter.
  - getTimerEventCount
```
long getTimerEventCount()
```
    Count of timer events delivered to this cache.
    
    See Also:
    
    InternalCacheInfo.getTimerEventCount()
  - getReadThroughCount
```
long getReadThroughCount()
```
    Entry was loaded, triggered by a get(). A read through event means also a get, load and miss event.
    
    See Also:
    
    InternalCacheInfo.getLoadCount()
  - getExplicitLoadCount
```
long getExplicitLoadCount()
```
    Entry was explicitly loaded, that is every load that is not read through or refresh.
    
    See Also:
    
    InternalCacheInfo.getExplicitLoadCount()
  - getRefreshCount
```
long getRefreshCount()
```
    Entry was loaded again, triggered by timer
    
    See Also:
    
    InternalCacheInfo.getRefreshCount()
  - getLoadMillis
```
long getLoadMillis()
```
    Accumulated milliseconds spend in load operations.
    
    See Also:
    
    InternalCacheInfo.getLoadMillis()
  - getLoadExceptionCount
```
long getLoadExceptionCount()
```
    Counter of exceptions thrown from the loader.
    
    See Also:
    
    InternalCacheInfo.getLoadExceptionCount()
  - getSuppressedExceptionCount
```
long getSuppressedExceptionCount()
```
    Counter of suppressed exceptions from the loader
    
    See Also:
    
    InternalCacheInfo.getSuppressedExceptionCount()
  - getExpiredKeptCount
```
long getExpiredKeptCount()
```
    Number of entries expired, but kept in the cache because of ongoing processing on the entry (pinned) or because keepData is enabled.
    
    See Also:
    
    InternalCacheInfo.getExpiredCount()
  - getPeekMissCount
```
long getPeekMissCount()
```
    Incremented if data is requested from the cache but no entry is present (e.g. via peek or get). If a load is started this is not incremented, since the actual miss is recorded via the load/readThrough counter.
  - getPeekHitNotFreshCount
```
long getPeekHitNotFreshCount()
```
    Peek, but entry available was not fresh (expired). This is effectively a miss, but we count separately for debugging purposes. Always 0 if not Cache2kBuilder.keepDataAfterExpired(boolean)
  - getRefreshedHitCount
```
long getRefreshedHitCount()
```
    Entry on probation for refresh got hit.
    
    See Also:
    
    InternalCacheInfo.getRefreshedHitCount()
  - getRefreshRejectedCount
```
long getRefreshRejectedCount()
```
    Refresh submit failed. Happens if the loader executor has not enough available resources and rejects the refresh task.
  - getGoneSpinCount
```
long getGoneSpinCount()
```
    Entry was removed while waiting to get the mutation lock.
    
    See Also:
    
    InternalCacheInfo.getGoneSpinCount()
  - isDisabled
```
boolean isDisabled()
```
    True if statistics are disabled.

Modifier and Type	Interface	Description
`static class`	`CommonMetrics.BlackHole`
`static interface`	`CommonMetrics.Updater`

Interface CommonMetrics

Nested Class Summary

Method Summary

Method Detail

getHeapHitCount

getPutNewEntryCount

getPutHitCount

getHeapHitButNoReadCount

getTimerEventCount

getReadThroughCount

getExplicitLoadCount

getRefreshCount

getLoadMillis

getLoadExceptionCount

getSuppressedExceptionCount

getExpiredKeptCount

getPeekMissCount

getPeekHitNotFreshCount

getRefreshedHitCount

getRefreshRejectedCount

getGoneSpinCount

isDisabled