RegionMetrics (Apache HBase 2.5.0 API)

All Known Implementing Classes:

RegionLoad
```
@InterfaceAudience.Public
public interface RegionMetrics
```
Encapsulates per-region load metrics.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`long`	`getBlocksLocalWeight()` Returns the data at local weight of this region in the regionserver
`long`	`getBlocksLocalWithSsdWeight()` Different from blocksLocalWeight,this metric's numerator only include the data stored on ssd
`long`	`getBlocksTotalWeight()` Returns the block total weight of this region
`Size`	`getBloomFilterSize()` Returns The total size of all Bloom filter blocks, not just loaded into the block cache
`long`	`getCompactedCellCount()` Returns the number of already compacted kvs in current compaction
`long`	`getCompactingCellCount()` Returns the total number of cells in current compaction
`CompactionState`	`getCompactionState()` Returns the compaction state of this region
`long`	`getCompletedSequenceId()` This does not really belong inside RegionLoad but its being done in the name of expediency.
`float`	`getDataLocality()` Returns the data locality of region in the regionserver.
`float`	`getDataLocalityForSsd()` Different from dataLocality,this metric's numerator only include the data stored on ssd
`long`	`getFilteredReadRequestCount()` Returns the number of filtered read requests made to region
`long`	`getLastMajorCompactionTimestamp()` Returns the timestamp of the oldest hfile for any store of this region.
`int`	`getMaxCompactedStoreFileRefCount()` Returns the max reference count for any store file among all compacted stores files of this region
`Size`	`getMemStoreSize()` Returns the memstore size
`default String`	`getNameAsString()` Returns the region name as a string
`long`	`getReadRequestCount()` Returns the number of read requests made to region
`byte[]`	`getRegionName()` Returns the region name
`default long`	`getRequestCount()` Returns the number of write requests and read requests made to region
`int`	`getStoreCount()` Returns the number of stores
`int`	`getStoreFileCount()` Returns the number of storefiles
`Size`	`getStoreFileIndexSize()` TODO: why we pass the same value to different counters? Currently, the value from getStoreFileIndexSize() is same with getStoreFileRootLevelIndexSize() see HRegionServer#createRegionLoad.
`Size`	`getStoreFileRootLevelIndexSize()` Returns The current total size of root-level indexes for the region
`Size`	`getStoreFileSize()` Returns the total size of the storefiles
`Size`	`getStoreFileUncompressedDataIndexSize()` Returns The total size of all index blocks, not just the root level
`int`	`getStoreRefCount()` Returns the reference count for the stores of this region
`Map<byte[],Long>`	`getStoreSequenceId()` Returns completed sequence id per store.
`Size`	`getUncompressedStoreFileSize()` Returns the uncompressed size of the storefiles
`long`	`getWriteRequestCount()` Returns the number of write requests made to region

- Method Detail
  - getRegionName
```
byte[] getRegionName()
```
    Returns the region name
  - getStoreCount
```
int getStoreCount()
```
    Returns the number of stores
  - getStoreFileCount
```
int getStoreFileCount()
```
    Returns the number of storefiles
  - getStoreFileSize
```
Size getStoreFileSize()
```
    Returns the total size of the storefiles
  - getMemStoreSize
```
Size getMemStoreSize()
```
    Returns the memstore size
  - getReadRequestCount
```
long getReadRequestCount()
```
    Returns the number of read requests made to region
  - getWriteRequestCount
```
long getWriteRequestCount()
```
    Returns the number of write requests made to region
  - getRequestCount
```
default long getRequestCount()
```
    Returns the number of write requests and read requests made to region
  - getNameAsString
```
default String getNameAsString()
```
    Returns the region name as a string
  - getFilteredReadRequestCount
```
long getFilteredReadRequestCount()
```
    Returns the number of filtered read requests made to region
  - getStoreFileIndexSize
```
Size getStoreFileIndexSize()
```
    TODO: why we pass the same value to different counters? Currently, the value from getStoreFileIndexSize() is same with getStoreFileRootLevelIndexSize() see HRegionServer#createRegionLoad.
    
    Returns:
    
    The current total size of root-level indexes for the region
  - getStoreFileRootLevelIndexSize
```
Size getStoreFileRootLevelIndexSize()
```
    Returns The current total size of root-level indexes for the region
  - getStoreFileUncompressedDataIndexSize
```
Size getStoreFileUncompressedDataIndexSize()
```
    Returns The total size of all index blocks, not just the root level
  - getBloomFilterSize
```
Size getBloomFilterSize()
```
    Returns The total size of all Bloom filter blocks, not just loaded into the block cache
  - getCompactingCellCount
```
long getCompactingCellCount()
```
    Returns the total number of cells in current compaction
  - getCompactedCellCount
```
long getCompactedCellCount()
```
    Returns the number of already compacted kvs in current compaction
  - getCompletedSequenceId
```
long getCompletedSequenceId()
```
    This does not really belong inside RegionLoad but its being done in the name of expediency.
    
    Returns:
    
    the completed sequence Id for the region
  - getStoreSequenceId
```
Map<byte[],Long> getStoreSequenceId()
```
    Returns completed sequence id per store.
  - getUncompressedStoreFileSize
```
Size getUncompressedStoreFileSize()
```
    Returns the uncompressed size of the storefiles
  - getDataLocality
```
float getDataLocality()
```
    Returns the data locality of region in the regionserver.
  - getLastMajorCompactionTimestamp
```
long getLastMajorCompactionTimestamp()
```
    Returns the timestamp of the oldest hfile for any store of this region.
  - getStoreRefCount
```
int getStoreRefCount()
```
    Returns the reference count for the stores of this region
  - getMaxCompactedStoreFileRefCount
```
int getMaxCompactedStoreFileRefCount()
```
    Returns the max reference count for any store file among all compacted stores files of this region
  - getDataLocalityForSsd
```
float getDataLocalityForSsd()
```
    Different from dataLocality,this metric's numerator only include the data stored on ssd
    
    Returns:
    
    the data locality for ssd of region in the regionserver
  - getBlocksLocalWeight
```
long getBlocksLocalWeight()
```
    Returns the data at local weight of this region in the regionserver
  - getBlocksLocalWithSsdWeight
```
long getBlocksLocalWithSsdWeight()
```
    Different from blocksLocalWeight,this metric's numerator only include the data stored on ssd
    
    Returns:
    
    the data at local with ssd weight of this region in the regionserver
  - getBlocksTotalWeight
```
long getBlocksTotalWeight()
```
    Returns the block total weight of this region
  - getCompactionState
```
CompactionState getCompactionState()
```
    Returns the compaction state of this region

Interface RegionMetrics

Method Summary

Method Detail

getRegionName

getStoreCount

getStoreFileCount

getStoreFileSize

getMemStoreSize

getReadRequestCount

getWriteRequestCount

getRequestCount

getNameAsString

getFilteredReadRequestCount

getStoreFileIndexSize

getStoreFileRootLevelIndexSize

getStoreFileUncompressedDataIndexSize

getBloomFilterSize

getCompactingCellCount

getCompactedCellCount

getCompletedSequenceId

getStoreSequenceId

getUncompressedStoreFileSize

getDataLocality

getLastMajorCompactionTimestamp

getStoreRefCount

getMaxCompactedStoreFileRefCount

getDataLocalityForSsd

getBlocksLocalWeight

getBlocksLocalWithSsdWeight

getBlocksTotalWeight

getCompactionState