HBASE-22459 Expose store reader reference count

apurtell · apurtell · commit ad1eafa36650 · 2019-05-22T17:45:41.000-07:00
diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/RegionLoad.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/RegionLoad.java
@@ -363,6 +363,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()
    */
@@ -371,6 +378,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",
diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/RegionMetrics.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/RegionMetrics.java
@@ -150,4 +150,8 @@ default String getNameAsString() {
    */
   long getLastMajorCompactionTimestamp();
 
+  /**
+   * @return the reference count for the stores of this region
+   */
+  int getStoreRefCount();
 }
diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/RegionMetricsBuilder.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/RegionMetricsBuilder.java
@@ -65,6 +65,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(
@@ -111,6 +112,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(
@@ -125,6 +127,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;
@@ -154,6 +157,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;
@@ -227,6 +234,7 @@ public RegionMetrics build() {
     return new RegionMetricsImpl(name,
         storeCount,
         storeFileCount,
+        storeRefCount,
         compactingCellCount,
         compactedCellCount,
         storeFileSize,
@@ -250,6 +258,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;
@@ -270,6 +279,7 @@ private static class RegionMetricsImpl implements RegionMetrics {
     RegionMetricsImpl(byte[] name,
         int storeCount,
         int storeFileCount,
+        int storeRefCount,
         final long compactingCellCount,
         long compactedCellCount,
         Size storeFileSize,
@@ -290,6 +300,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);
@@ -324,6 +335,11 @@ public int getStoreFileCount() {
       return storeFileCount;
     }
 
+    @Override
+    public int getStoreRefCount() {
+      return storeRefCount;
+    }
+
     @Override
     public Size getStoreFileSize() {
       return storeFileSize;
@@ -415,6 +431,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",
diff --git a/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionServerSource.java b/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";
diff --git a/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionWrapper.java b/hbase-hadoop-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionWrapper.java
@@ -159,4 +159,9 @@ public interface MetricsRegionWrapper {
    * Get the replica id of this region.
    */
   int getReplicaId();
+
+  /**
+   * @return the number of references active on the store
+   */
+  long getStoreRefCount();
 }
diff --git a/hbase-hadoop2-compat/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionSourceImpl.java b/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),
diff --git a/hbase-hadoop2-compat/src/test/java/org/apache/hadoop/hbase/regionserver/TestMetricsRegionSourceImpl.java b/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;
diff --git a/hbase-protocol-shaded/src/main/protobuf/ClusterStatus.proto b/hbase-protocol-shaded/src/main/protobuf/ClusterStatus.proto
@@ -146,6 +146,9 @@ message RegionLoad {
 
   /** the current total coprocessor requests made to region */
   optional uint64 cp_requests_count = 20;
+
+  /** the number of references active on the store */
+  optional int32 store_ref_count = 21 [default = 0];
 }
 
 /* Server-level protobufs */
diff --git a/hbase-protocol/src/main/protobuf/ClusterStatus.proto b/hbase-protocol/src/main/protobuf/ClusterStatus.proto
@@ -142,6 +142,9 @@ message RegionLoad {
 
   /** the current total coprocessor requests made to region */
   optional uint64 cp_requests_count = 20;
+
+  /** the number of references active on the store */
+  optional int32 store_ref_count = 21 [default = 0];
 }
 
 /* Server-level protobufs */
diff --git a/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/StorageClusterStatusResource.java b/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/StorageClusterStatusResource.java
@@ -87,7 +87,7 @@ public Response get(final @Context UriInfo uriInfo) {
         node.setRequests(load.getRequestCount());
         for (RegionMetrics region: load.getRegionMetrics().values()) {
           node.addRegion(region.getRegionName(), region.getStoreCount(),
-            region.getStoreFileCount(),
+            region.getStoreFileCount(), region.getStoreRefCount(),
             (int) region.getStoreFileSize().get(Size.Unit.MEGABYTE),
             (int) region.getMemStoreSize().get(Size.Unit.MEGABYTE),
             (long) region.getStoreFileIndexSize().get(Size.Unit.KILOBYTE),
diff --git a/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/model/StorageClusterStatusModel.java b/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/model/StorageClusterStatusModel.java
@@ -116,6 +116,7 @@ public static class Region implements Serializable {
       private byte[] name;
       private int stores;
       private int storefiles;
+      private int storeRefCount;
       private int storefileSizeMB;
       private int memstoreSizeMB;
       private long storefileIndexSizeKB;
@@ -151,14 +152,15 @@ public Region(byte[] name) {
        * @param memstoreSizeMB total size of memstore, in MB
        * @param storefileIndexSizeKB total size of store file indexes, in KB
        */
-      public Region(byte[] name, int stores, int storefiles,
+      public Region(byte[] name, int stores, int storefiles,  int storeRefCount,
           int storefileSizeMB, int memstoreSizeMB, long storefileIndexSizeKB,
           long readRequestsCount, long cpRequestsCount, long writeRequestsCount,
           int rootIndexSizeKB, int totalStaticIndexSizeKB, int totalStaticBloomSizeKB,
           long totalCompactingKVs, long currentCompactedKVs) {
         this.name = name;
         this.stores = stores;
         this.storefiles = storefiles;
+        this.storeRefCount = storeRefCount;
         this.storefileSizeMB = storefileSizeMB;
         this.memstoreSizeMB = memstoreSizeMB;
         this.storefileIndexSizeKB = storefileIndexSizeKB;
@@ -196,6 +198,14 @@ public int getStorefiles() {
         return storefiles;
       }
 
+      /**
+       * @return the number of references active on the store
+       */
+      @XmlAttribute
+      public int getStoreRefCount() {
+        return storeRefCount;
+      }
+
       /**
        * @return the total size of store files, in MB
        */
@@ -399,12 +409,12 @@ public void setStorefileIndexSizeKB(long storefileIndexSizeKB) {
      * Add a region name to the list
      * @param name the region name
      */
-    public void addRegion(byte[] name, int stores, int storefiles,
+    public void addRegion(byte[] name, int stores, int storefiles, int storeRefCount,
         int storefileSizeMB, int memstoreSizeMB, long storefileIndexSizeKB,
         long readRequestsCount, long cpRequestsCount, long writeRequestsCount,
         int rootIndexSizeKB, int totalStaticIndexSizeKB, int totalStaticBloomSizeKB,
         long totalCompactingKVs, long currentCompactedKVs) {
-      regions.add(new Region(name, stores, storefiles, storefileSizeMB,
+      regions.add(new Region(name, stores, storefiles, storeRefCount, storefileSizeMB,
         memstoreSizeMB, storefileIndexSizeKB, readRequestsCount, cpRequestsCount,
         writeRequestsCount, rootIndexSizeKB, totalStaticIndexSizeKB,
         totalStaticBloomSizeKB, totalCompactingKVs, currentCompactedKVs));
@@ -800,6 +810,7 @@ public ProtobufMessageHandler getObjectFromMessage(byte[] message)
           region.getName().toByteArray(),
           region.getStores(),
           region.getStorefiles(),
+          region.getStoreRefCount(),
           region.getStorefileSizeMB(),
           region.getMemStoreSizeMB(),
           region.getStorefileIndexSizeKB(),
diff --git a/hbase-rest/src/main/protobuf/StorageClusterStatusMessage.proto b/hbase-rest/src/main/protobuf/StorageClusterStatusMessage.proto
@@ -33,6 +33,7 @@ message StorageClusterStatus {
     optional int64 totalCompactingKVs = 12;
     optional int64 currentCompactedKVs = 13;
     optional int64 cpRequestsCount = 14;
+    optional int32 storeRefCount = 15;
   }
   message Node {
     required string name = 1;    // name:port
diff --git a/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/model/TestStorageClusterStatusModel.java b/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/model/TestStorageClusterStatusModel.java
@@ -88,9 +88,9 @@ protected StorageClusterStatusModel buildTestModel() {
     model.setRequests(0);
     model.setAverageLoad(1.0);
     model.addLiveNode("test1", 1245219839331L, 128, 1024)
-      .addRegion(Bytes.toBytes("hbase:root,,0"), 1, 1, 0, 0, 0, 1, 1, 2, 1, 1, 1, 1, 1);
+      .addRegion(Bytes.toBytes("hbase:root,,0"), 1, 1, 0, 0, 0, 0, 1, 1, 2, 1, 1, 1, 1, 1);
     model.addLiveNode("test2", 1245239331198L, 512, 1024)
-      .addRegion(Bytes.toBytes(TableName.META_TABLE_NAME+",,1246000043724"),1, 1, 0, 0, 0,
+      .addRegion(Bytes.toBytes(TableName.META_TABLE_NAME+",,1246000043724"),1, 1, 0, 0, 0, 0,
           1, 1, 2, 1, 1, 1, 1, 1);
     return model;
   }
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HStore.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HStore.java
@@ -2139,6 +2139,15 @@ private LongStream getStoreFileAgeStream() {
         .map(t -> EnvironmentEdgeManager.currentTime() - t);
   }
 
+  @Override
+  public int getStoreRefCount() {
+    return this.storeEngine.getStoreFileManager().getStorefiles().stream()
+      .filter(sf -> { return sf.getReader() != null; })
+      .filter(HStoreFile::isHFile)
+      .mapToInt(sf -> sf.getRefCount())
+      .sum();
+  }
+
   @Override
   public OptionalLong getMaxStoreFileAge() {
     return getStoreFileAgeStream().max();
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionWrapperImpl.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/MetricsRegionWrapperImpl.java
@@ -48,6 +48,7 @@ public class MetricsRegionWrapperImpl implements MetricsRegionWrapper, Closeable
   private ScheduledExecutorService executor;
   private Runnable runnable;
   private long numStoreFiles;
+  private long storeRefCount;
   private long memstoreSize;
   private long storeFileSize;
   private long maxStoreFileAge;
@@ -119,6 +120,11 @@ public long getStoreFileSize() {
     return storeFileSize;
   }
 
+  @Override
+  public long getStoreRefCount() {
+    return storeRefCount;
+  }
+
   @Override
   public long getReadRequestCount() {
     return this.region.getReadRequestsCount();
@@ -226,6 +232,7 @@ public class HRegionMetricsWrapperRunnable implements Runnable {
     @Override
     public void run() {
       long tempNumStoreFiles = 0;
+      int tempStoreRefCount = 0;
       long tempMemstoreSize = 0;
       long tempStoreFileSize = 0;
       long tempMaxStoreFileAge = 0;
@@ -239,6 +246,7 @@ public void run() {
       if (region.stores != null) {
         for (Store store : region.stores.values()) {
           tempNumStoreFiles += store.getStorefilesCount();
+          tempStoreRefCount += store.getStoreRefCount();
           tempMemstoreSize += store.getMemStoreSize().getDataSize();
           tempStoreFileSize += store.getStorefilesSize();
           OptionalLong storeMaxStoreFileAge = store.getMaxStoreFileAge();
@@ -265,6 +273,7 @@ public void run() {
       }
 
       numStoreFiles = tempNumStoreFiles;
+      storeRefCount = tempStoreRefCount;
       memstoreSize = tempMemstoreSize;
       storeFileSize = tempStoreFileSize;
       maxStoreFileAge = tempMaxStoreFileAge;
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/Store.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/Store.java
@@ -126,6 +126,11 @@ public interface Store {
    */
   int getStorefilesCount();
 
+  /**
+   * @return Reference count over store
+   */
+  int getStoreRefCount();
+
   /**
    * @return Count of compacted store files
    */
diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/MetricsRegionWrapperStub.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/MetricsRegionWrapperStub.java
@@ -60,6 +60,11 @@ public long getNumStoreFiles() {
     return 102;
   }
 
+  @Override
+  public long getStoreRefCount() {
+    return 0;
+  }
+
   @Override
   public long getMemStoreSize() {
     return 103;

Original file line number	Diff line number	Diff line change
`@@ -150,4 +150,8 @@ default String getNameAsString() {`
`150`	`150`	`*/`
`151`	`151`	`long getLastMajorCompactionTimestamp();`
`152`	`152`
	`153`	`+ /**`
	`154`	`+ * @return the reference count for the stores of this region`
	`155`	`+ */`
	`156`	`+ int getStoreRefCount();`
`153`	`157`	`}`
Original file line number	Diff line number	Diff line change
`@@ -146,6 +146,9 @@ message RegionLoad {`
`146`	`146`
`147`	`147`	`/** the current total coprocessor requests made to region */`
`148`	`148`	`optional uint64 cp_requests_count = 20;`
	`149`	`+`
	`150`	`+ /** the number of references active on the store */`
	`151`	`+ optional int32 store_ref_count = 21 [default = 0];`
`149`	`152`	`}`
`150`	`153`
`151`	`154`	`/* Server-level protobufs */`
Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,9 @@ message RegionLoad {`
`142`	`142`
`143`	`143`	`/** the current total coprocessor requests made to region */`
`144`	`144`	`optional uint64 cp_requests_count = 20;`
	`145`	`+`
	`146`	`+ /** the number of references active on the store */`
	`147`	`+ optional int32 store_ref_count = 21 [default = 0];`
`145`	`148`	`}`
`146`	`149`
`147`	`150`	`/* Server-level protobufs */`