CacheStats (Apache HBase 2.4.0 API)

java.lang.Object
- org.apache.hadoop.hbase.io.hfile.CacheStats

Direct Known Subclasses:

BucketCacheStats, CombinedBlockCache.CombinedCacheStats
```
@InterfaceAudience.Private
public class CacheStats
extends Object
```
Class that implements cache metrics.

Field Summary

Fields
Modifier and Type	Field and Description
`private FastLongHistogram`	`ageAtEviction` Keep running age at eviction time
`private LongAdder`	`bloomChunkHitCount`
`private LongAdder`	`bloomChunkMissCount`
`private LongAdder`	`dataHitCount`
`private LongAdder`	`dataMissCount` Per Block Type Counts
`(package private) static int`	`DEFAULT_WINDOW_PERIODS` Sliding window statistics.
`private LongAdder`	`deleteFamilyBloomHitCount`
`private LongAdder`	`deleteFamilyBloomMissCount`
`private LongAdder`	`evictedBlockCount` The total number of blocks that have been evicted
`private LongAdder`	`evictionCount` The number of times an eviction has occurred
`private AtomicLong`	`failedInserts` The total number of blocks that were not inserted.
`private LongAdder`	`fileInfoHitCount`
`private LongAdder`	`fileInfoMissCount`
`private LongAdder`	`generalBloomMetaHitCount`
`private LongAdder`	`generalBloomMetaMissCount`
`private LongAdder`	`hitCachingCount` The number of getBlock requests that were cache hits, but only from requests that were set to use the block cache.
`private long[]`	`hitCachingCounts` Caching hit counts for each period in window
`private LongAdder`	`hitCount` The number of getBlock requests that were cache hits
`private long[]`	`hitCounts` Hit counts for each period in window
`private LongAdder`	`intermediateIndexHitCount`
`private LongAdder`	`intermediateIndexMissCount`
`private long`	`lastHitCachingCount` Last hit caching count read
`private long`	`lastHitCount` Last hit count read
`private long`	`lastRequestCachingCount` Last request caching count read
`private long`	`lastRequestCount` Last request count read
`private LongAdder`	`leafIndexHitCount`
`private LongAdder`	`leafIndexMissCount`
`private LongAdder`	`metaHitCount`
`private LongAdder`	`metaMissCount`
`private LongAdder`	`missCachingCount` The number of getBlock requests that were cache misses, but only from requests that were set to use the block cache.
`private LongAdder`	`missCount` The number of getBlock requests that were cache misses
`private int`	`numPeriodsInWindow` The number of metrics periods to include in window
`private LongAdder`	`primaryEvictedBlockCount` The total number of blocks for primary replica that have been evicted
`private LongAdder`	`primaryHitCount` The number of getBlock requests that were cache hits from primary replica
`private LongAdder`	`primaryMissCount` The number of getBlock requests for primary replica that were cache misses
`private long[]`	`requestCachingCounts` Caching access counts for each period in window
`private long[]`	`requestCounts` Access counts for each period in window
`private LongAdder`	`rootIndexHitCount`
`private LongAdder`	`rootIndexMissCount`
`private long`	`startTime`
`private LongAdder`	`trailerHitCount`
`private LongAdder`	`trailerMissCount`
`private int`	`windowIndex` Current window index (next to be updated)

Constructor Summary

Constructors
Constructor and Description

CacheStats(String name)

CacheStats(String name, int numPeriodsInWindow)

Constructors
Constructor and Description
`CacheStats(String name)`
`CacheStats(String name, int numPeriodsInWindow)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`evict()`
`void`	`evicted(long t, boolean primary)`
`double`	`evictedPerEviction()`
`long`	`failInsert()`
`AgeSnapshot`	`getAgeAtEvictionSnapshot()`
`long`	`getBloomChunkHitCount()`
`long`	`getBloomChunkMissCount()`
`long`	`getDataHitCount()`
`long`	`getDataMissCount()`
`long`	`getDeleteFamilyBloomHitCount()`
`long`	`getDeleteFamilyBloomMissCount()`
`long`	`getEvictedCount()`
`long`	`getEvictionCount()`
`long`	`getFailedInserts()`
`long`	`getFileInfoHitCount()`
`long`	`getFileInfoMissCount()`
`long`	`getGeneralBloomMetaHitCount()`
`long`	`getGeneralBloomMetaMissCount()`
`long`	`getHitCachingCount()`
`double`	`getHitCachingRatio()`
`double`	`getHitCachingRatioPastNPeriods()`
`long`	`getHitCount()`
`double`	`getHitRatio()`
`double`	`getHitRatioPastNPeriods()`
`long`	`getIntermediateIndexHitCount()`
`long`	`getIntermediateIndexMissCount()`
`long`	`getLeafIndexHitCount()`
`long`	`getLeafIndexMissCount()`
`long`	`getMetaHitCount()`
`long`	`getMetaMissCount()`
`long`	`getMissCachingCount()`
`double`	`getMissCachingRatio()`
`long`	`getMissCount()`
`double`	`getMissRatio()`
`long`	`getPrimaryEvictedCount()`
`long`	`getPrimaryHitCount()`
`long`	`getPrimaryMissCount()`
`long`	`getRequestCachingCount()`
`long`	`getRequestCount()`
`long`	`getRootIndexHitCount()`
`long`	`getRootIndexMissCount()`
`long`	`getSumHitCachingCountsPastNPeriods()`
`long`	`getSumHitCountsPastNPeriods()`
`long`	`getSumRequestCachingCountsPastNPeriods()`
`long`	`getSumRequestCountsPastNPeriods()`
`long`	`getTrailerHitCount()`
`long`	`getTrailerMissCount()`
`void`	`hit(boolean caching, boolean primary, BlockType type)`
`void`	`miss(boolean caching, boolean primary, BlockType type)`
`void`	`rollMetricsPeriod()`
`private static long`	`sum(long[] counts)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- DEFAULT_WINDOW_PERIODS
```
static final int DEFAULT_WINDOW_PERIODS
```
  Sliding window statistics. The number of metric periods to include in sliding window hit ratio calculations.
  
  See Also:
  
  Constant Field Values
- hitCount
```
private final LongAdder hitCount
```
  The number of getBlock requests that were cache hits
- primaryHitCount
```
private final LongAdder primaryHitCount
```
  The number of getBlock requests that were cache hits from primary replica
- hitCachingCount
```
private final LongAdder hitCachingCount
```
  The number of getBlock requests that were cache hits, but only from requests that were set to use the block cache. This is because all reads attempt to read from the block cache even if they will not put new blocks into the block cache. See HBASE-2253 for more information.
- missCount
```
private final LongAdder missCount
```
  The number of getBlock requests that were cache misses
- primaryMissCount
```
private final LongAdder primaryMissCount
```
  The number of getBlock requests for primary replica that were cache misses
- missCachingCount
```
private final LongAdder missCachingCount
```
  The number of getBlock requests that were cache misses, but only from requests that were set to use the block cache.
- evictionCount
```
private final LongAdder evictionCount
```
  The number of times an eviction has occurred
- evictedBlockCount
```
private final LongAdder evictedBlockCount
```
  The total number of blocks that have been evicted
- primaryEvictedBlockCount
```
private final LongAdder primaryEvictedBlockCount
```
  The total number of blocks for primary replica that have been evicted
- failedInserts
```
private final AtomicLong failedInserts
```
  The total number of blocks that were not inserted.
- dataMissCount
```
private final LongAdder dataMissCount
```
  Per Block Type Counts
- leafIndexMissCount
```
private final LongAdder leafIndexMissCount
```
- bloomChunkMissCount
```
private final LongAdder bloomChunkMissCount
```
- metaMissCount
```
private final LongAdder metaMissCount
```
- rootIndexMissCount
```
private final LongAdder rootIndexMissCount
```
- intermediateIndexMissCount
```
private final LongAdder intermediateIndexMissCount
```
- fileInfoMissCount
```
private final LongAdder fileInfoMissCount
```
- generalBloomMetaMissCount
```
private final LongAdder generalBloomMetaMissCount
```
- deleteFamilyBloomMissCount
```
private final LongAdder deleteFamilyBloomMissCount
```
- trailerMissCount
```
private final LongAdder trailerMissCount
```
- dataHitCount
```
private final LongAdder dataHitCount
```
- leafIndexHitCount
```
private final LongAdder leafIndexHitCount
```
- bloomChunkHitCount
```
private final LongAdder bloomChunkHitCount
```
- metaHitCount
```
private final LongAdder metaHitCount
```
- rootIndexHitCount
```
private final LongAdder rootIndexHitCount
```
- intermediateIndexHitCount
```
private final LongAdder intermediateIndexHitCount
```
- fileInfoHitCount
```
private final LongAdder fileInfoHitCount
```
- generalBloomMetaHitCount
```
private final LongAdder generalBloomMetaHitCount
```
- deleteFamilyBloomHitCount
```
private final LongAdder deleteFamilyBloomHitCount
```
- trailerHitCount
```
private final LongAdder trailerHitCount
```
- numPeriodsInWindow
```
private final int numPeriodsInWindow
```
  The number of metrics periods to include in window
- hitCounts
```
private final long[] hitCounts
```
  Hit counts for each period in window
- hitCachingCounts
```
private final long[] hitCachingCounts
```
  Caching hit counts for each period in window
- requestCounts
```
private final long[] requestCounts
```
  Access counts for each period in window
- requestCachingCounts
```
private final long[] requestCachingCounts
```
  Caching access counts for each period in window
- lastHitCount
```
private long lastHitCount
```
  Last hit count read
- lastHitCachingCount
```
private long lastHitCachingCount
```
  Last hit caching count read
- lastRequestCount
```
private long lastRequestCount
```
  Last request count read
- lastRequestCachingCount
```
private long lastRequestCachingCount
```
  Last request caching count read
- windowIndex
```
private int windowIndex
```
  Current window index (next to be updated)
- ageAtEviction
```
private FastLongHistogram ageAtEviction
```
  Keep running age at eviction time
- startTime
```
private long startTime
```

Constructor Detail

CacheStats
```
public CacheStats(String name)
```

CacheStats

public CacheStats(String name,
                  int numPeriodsInWindow)

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

miss

public void miss(boolean caching,
                 boolean primary,
                 BlockType type)

hit

public void hit(boolean caching,
                boolean primary,
                BlockType type)

evict
```
public void evict()
```

evicted

public void evicted(long t,
                    boolean primary)

failInsert
```
public long failInsert()
```

getDataMissCount
```
public long getDataMissCount()
```

getLeafIndexMissCount
```
public long getLeafIndexMissCount()
```

getBloomChunkMissCount
```
public long getBloomChunkMissCount()
```

getMetaMissCount
```
public long getMetaMissCount()
```

getRootIndexMissCount
```
public long getRootIndexMissCount()
```

getIntermediateIndexMissCount

public long getIntermediateIndexMissCount()

getFileInfoMissCount
```
public long getFileInfoMissCount()
```

getGeneralBloomMetaMissCount

public long getGeneralBloomMetaMissCount()

getDeleteFamilyBloomMissCount

public long getDeleteFamilyBloomMissCount()

getTrailerMissCount
```
public long getTrailerMissCount()
```

getDataHitCount
```
public long getDataHitCount()
```

getLeafIndexHitCount
```
public long getLeafIndexHitCount()
```

getBloomChunkHitCount
```
public long getBloomChunkHitCount()
```

getMetaHitCount
```
public long getMetaHitCount()
```

getRootIndexHitCount
```
public long getRootIndexHitCount()
```

getIntermediateIndexHitCount

public long getIntermediateIndexHitCount()

getFileInfoHitCount
```
public long getFileInfoHitCount()
```

getGeneralBloomMetaHitCount

public long getGeneralBloomMetaHitCount()

getDeleteFamilyBloomHitCount

public long getDeleteFamilyBloomHitCount()

getTrailerHitCount
```
public long getTrailerHitCount()
```

getRequestCount
```
public long getRequestCount()
```

getRequestCachingCount
```
public long getRequestCachingCount()
```

getMissCount
```
public long getMissCount()
```

getPrimaryMissCount
```
public long getPrimaryMissCount()
```

getMissCachingCount
```
public long getMissCachingCount()
```

getHitCount
```
public long getHitCount()
```

getPrimaryHitCount
```
public long getPrimaryHitCount()
```

getHitCachingCount
```
public long getHitCachingCount()
```

getEvictionCount
```
public long getEvictionCount()
```

getEvictedCount
```
public long getEvictedCount()
```

getPrimaryEvictedCount
```
public long getPrimaryEvictedCount()
```

getHitRatio
```
public double getHitRatio()
```

getHitCachingRatio
```
public double getHitCachingRatio()
```

getMissRatio
```
public double getMissRatio()
```

getMissCachingRatio
```
public double getMissCachingRatio()
```

evictedPerEviction
```
public double evictedPerEviction()
```

getFailedInserts
```
public long getFailedInserts()
```

rollMetricsPeriod
```
public void rollMetricsPeriod()
```

getSumHitCountsPastNPeriods

public long getSumHitCountsPastNPeriods()

getSumRequestCountsPastNPeriods

public long getSumRequestCountsPastNPeriods()

getSumHitCachingCountsPastNPeriods

public long getSumHitCachingCountsPastNPeriods()

getSumRequestCachingCountsPastNPeriods

public long getSumRequestCachingCountsPastNPeriods()

getHitRatioPastNPeriods

public double getHitRatioPastNPeriods()

getHitCachingRatioPastNPeriods

public double getHitCachingRatioPastNPeriods()

getAgeAtEvictionSnapshot

public AgeSnapshot getAgeAtEvictionSnapshot()

sum

private static long sum(long[] counts)

Class CacheStats

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_WINDOW_PERIODS

hitCount

primaryHitCount

hitCachingCount

missCount

primaryMissCount

missCachingCount

evictionCount

evictedBlockCount

primaryEvictedBlockCount

failedInserts

dataMissCount

leafIndexMissCount

bloomChunkMissCount

metaMissCount

rootIndexMissCount

intermediateIndexMissCount

fileInfoMissCount

generalBloomMetaMissCount

deleteFamilyBloomMissCount

trailerMissCount

dataHitCount

leafIndexHitCount

bloomChunkHitCount

metaHitCount

rootIndexHitCount

intermediateIndexHitCount

fileInfoHitCount

generalBloomMetaHitCount

deleteFamilyBloomHitCount

trailerHitCount

numPeriodsInWindow

hitCounts

hitCachingCounts

requestCounts

requestCachingCounts

lastHitCount

lastHitCachingCount

lastRequestCount

lastRequestCachingCount

windowIndex

ageAtEviction

startTime

Constructor Detail

CacheStats

CacheStats

Method Detail

toString

miss

hit

evict

evicted

failInsert

getDataMissCount

getLeafIndexMissCount

getBloomChunkMissCount

getMetaMissCount

getRootIndexMissCount

getIntermediateIndexMissCount

getFileInfoMissCount

getGeneralBloomMetaMissCount

getDeleteFamilyBloomMissCount

getTrailerMissCount

getDataHitCount

getLeafIndexHitCount

getBloomChunkHitCount

getMetaHitCount

getRootIndexHitCount

getIntermediateIndexHitCount

getFileInfoHitCount

getGeneralBloomMetaHitCount

getDeleteFamilyBloomHitCount

getTrailerHitCount

getRequestCount