HBASE-22459 Expose store reader reference count (#248)

Author: apurtell

hbase-client/src/main/java/org/apache/hadoop/hbase/RegionLoad.java

@@ -358,6 +358,13 @@ public long getLastMajorCompactionTs() {
     return metrics.getLastMajorCompactionTimestamp();
   }
 
+  /**
+   * @return the reference count for the stores of this region
+   */
+  public int getStoreRefCount() {
+    return metrics.getStoreRefCount();
+  }
+
   /**
    * @see java.lang.Object#toString()
    */
@@ -366,6 +373,7 @@ public String toString() {
     StringBuilder sb = Strings.appendKeyValue(new StringBuilder(), "numberOfStores",
         this.getStores());
     Strings.appendKeyValue(sb, "numberOfStorefiles", this.getStorefiles());
+    Strings.appendKeyValue(sb, "storeRefCount", this.getStoreRefCount());
     Strings.appendKeyValue(sb, "storefileUncompressedSizeMB",
         this.getStoreUncompressedSizeMB());
     Strings.appendKeyValue(sb, "lastMajorCompactionTimestamp",

hbase-client/src/main/java/org/apache/hadoop/hbase/RegionMetrics.java

@@ -144,4 +144,8 @@ default String getNameAsString() {
    */
   long getLastMajorCompactionTimestamp();
 
+  /**
+   * @return the reference count for the stores of this region
+   */
+  int getStoreRefCount();
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/RegionMetricsBuilder.java

@@ -64,6 +64,7 @@ public static RegionMetrics toRegionMetrics(ClusterStatusProtos.RegionLoad regio
           Size.Unit.KILOBYTE))
         .setStoreCount(regionLoadPB.getStores())
         .setStoreFileCount(regionLoadPB.getStorefiles())
+        .setStoreRefCount(regionLoadPB.getStoreRefCount())
         .setStoreFileSize(new Size(regionLoadPB.getStorefileSizeMB(), Size.Unit.MEGABYTE))
         .setStoreSequenceIds(regionLoadPB.getStoreCompleteSequenceIdList().stream()
           .collect(Collectors.toMap(
@@ -109,6 +110,7 @@ public static ClusterStatusProtos.RegionLoad toRegionLoad(RegionMetrics regionMe
           .get(Size.Unit.KILOBYTE))
         .setStores(regionMetrics.getStoreCount())
         .setStorefiles(regionMetrics.getStoreCount())
+        .setStoreRefCount(regionMetrics.getStoreRefCount())
         .setStorefileSizeMB((int) regionMetrics.getStoreFileSize().get(Size.Unit.MEGABYTE))
         .addAllStoreCompleteSequenceId(toStoreSequenceId(regionMetrics.getStoreSequenceId()))
         .setStoreUncompressedSizeMB(
@@ -123,6 +125,7 @@ public static RegionMetricsBuilder newBuilder(byte[] name) {
   private final byte[] name;
   private int storeCount;
   private int storeFileCount;
+  private int storeRefCount;
   private long compactingCellCount;
   private long compactedCellCount;
   private Size storeFileSize = Size.ZERO;
@@ -151,6 +154,10 @@ public RegionMetricsBuilder setStoreFileCount(int value) {
     this.storeFileCount = value;
     return this;
   }
+  public RegionMetricsBuilder setStoreRefCount(int value) {
+    this.storeRefCount = value;
+    return this;
+  }
   public RegionMetricsBuilder setCompactingCellCount(long value) {
     this.compactingCellCount = value;
     return this;
@@ -220,6 +227,7 @@ public RegionMetrics build() {
     return new RegionMetricsImpl(name,
         storeCount,
         storeFileCount,
+        storeRefCount,
         compactingCellCount,
         compactedCellCount,
         storeFileSize,
@@ -242,6 +250,7 @@ private static class RegionMetricsImpl implements RegionMetrics {
     private final byte[] name;
     private final int storeCount;
     private final int storeFileCount;
+    private final int storeRefCount;
     private final long compactingCellCount;
     private final long compactedCellCount;
     private final Size storeFileSize;
@@ -261,6 +270,7 @@ private static class RegionMetricsImpl implements RegionMetrics {
     RegionMetricsImpl(byte[] name,
         int storeCount,
         int storeFileCount,
+        int storeRefCount,
         final long compactingCellCount,
         long compactedCellCount,
         Size storeFileSize,
@@ -280,6 +290,7 @@ private static class RegionMetricsImpl implements RegionMetrics {
       this.name = Preconditions.checkNotNull(name);
       this.storeCount = storeCount;
       this.storeFileCount = storeFileCount;
+      this.storeRefCount = storeRefCount;
       this.compactingCellCount = compactingCellCount;
       this.compactedCellCount = compactedCellCount;
       this.storeFileSize = Preconditions.checkNotNull(storeFileSize);
@@ -313,6 +324,11 @@ public int getStoreFileCount() {
       return storeFileCount;
     }
 
+    @Override
+    public int getStoreRefCount() {
+      return storeRefCount;
+    }
+
     @Override
     public Size getStoreFileSize() {
       return storeFileSize;
@@ -399,6 +415,8 @@ public String toString() {
           this.getStoreCount());
       Strings.appendKeyValue(sb, "storeFileCount",
           this.getStoreFileCount());
+      Strings.appendKeyValue(sb, "storeRefCount",
+        this.getStoreRefCount());
       Strings.appendKeyValue(sb, "uncompressedStoreFileSize",
           this.getUncompressedStoreFileSize());
       Strings.appendKeyValue(sb, "lastMajorCompactionTimestamp",

hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSource.java

@@ -231,6 +231,8 @@ public interface MetricsRegionServerSource extends BaseSource, JvmPauseMonitorSo
   String WALFILE_SIZE_DESC = "Size of all WAL Files";
   String STOREFILE_COUNT = "storeFileCount";
   String STOREFILE_COUNT_DESC = "Number of Store Files";
+  String STORE_REF_COUNT = "storeRefCount";
+  String STORE_REF_COUNT_DESC = "Store reference count";
   String MEMSTORE_SIZE = "memStoreSize";
   String MEMSTORE_SIZE_DESC = "Size of the memstore";
   String STOREFILE_SIZE = "storeFileSize";

hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionWrapper.java

@@ -152,4 +152,9 @@ public interface MetricsRegionWrapper {
    * Get the replica id of this region.
    */
   int getReplicaId();
+
+  /**
+   * @return the number of references active on the store
+   */
+  long getStoreRefCount();
 }

hbase-hadoop2-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionSourceImpl.java

@@ -213,6 +213,10 @@ void snapshot(MetricsRecordBuilder mrb, boolean ignored) {
               regionNamePrefix + MetricsRegionServerSource.STOREFILE_COUNT,
               MetricsRegionServerSource.STOREFILE_COUNT_DESC),
           this.regionWrapper.getNumStoreFiles());
+      mrb.addGauge(Interns.info(
+              regionNamePrefix + MetricsRegionServerSource.STORE_REF_COUNT,
+              MetricsRegionServerSource.STORE_REF_COUNT),
+          this.regionWrapper.getStoreRefCount());
       mrb.addGauge(Interns.info(
               regionNamePrefix + MetricsRegionServerSource.MEMSTORE_SIZE,
               MetricsRegionServerSource.MEMSTORE_SIZE_DESC),

hbase-hadoop2-compat/src/test/java/org/apache/hadoop/hbase/regionserver/TestMetricsRegionSourceImpl.java

@@ -94,6 +94,11 @@ public long getNumStoreFiles() {
       return 0;
     }
 
+    @Override
+    public long getStoreRefCount() {
+      return 0;
+    }
+
     @Override
     public long getMemStoreSize() {
       return 0;

hbase-protocol-shaded/src/main/protobuf/ClusterStatus.proto

@@ -143,6 +143,12 @@ message RegionLoad {
 
   /** the current total filtered read requests made to region */
   optional uint64 filtered_read_requests_count = 19;
+
+  /** master defines cp_requests_count = 20, the current total coprocessor
+      requests made to region */
+
+  /** the number of references active on the store */
+  optional int32 store_ref_count = 21 [default = 0];
 }
 
 /* Server-level protobufs */

hbase-protocol/src/main/protobuf/ClusterStatus.proto

@@ -139,6 +139,12 @@ message RegionLoad {
 
   /** the current total filtered read requests made to region */
   optional uint64 filtered_read_requests_count = 19;
+
+  /** master defines cp_requests_count = 20, the current total coprocessor
+      requests made to region */
+
+  /** the number of references active on the store */
+  optional int32 store_ref_count = 21 [default = 0];
 }
 
 /* Server-level protobufs */

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HStore.java

@@ -2668,4 +2668,10 @@ private void clearCompactedfiles(List<HStoreFile> filesToRemove) throws IOExcept
   public int getCurrentParallelPutCount() {
     return currentParallelPutCount.get();
   }
+
+  public int getStoreRefCount() {
+    return this.storeEngine.getStoreFileManager().getStorefiles().stream()
+      .filter(sf -> sf.getReader() != null).filter(HStoreFile::isHFile)
+      .mapToInt(HStoreFile::getRefCount).sum();
+  }
 }