HBASE-30242 Add Region server level HFile Compression Metrics

Author: Umeshkumar9414

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

@@ -233,6 +233,8 @@ public interface MetricsRegionServerSource extends BaseSource, JvmPauseMonitorSo
   String MEMSTORE_OFFHEAP_SIZE_DESC = "Off-heap Size of the memstore";
   String STOREFILE_SIZE = "storeFileSize";
   String STOREFILE_SIZE_GROWTH_RATE = "storeFileSizeGrowthRate";
+  String STOREFILE_UNCOMPRESSED_SIZE = "storeFileUncompressedSize";
+  String STOREFILE_COMPRESSION_RATIO = "storeFileCompressionRatio";
   String MAX_STORE_FILE_AGE = "maxStoreFileAge";
   String MIN_STORE_FILE_AGE = "minStoreFileAge";
   String AVG_STORE_FILE_AGE = "avgStoreFileAge";
@@ -244,6 +246,10 @@ public interface MetricsRegionServerSource extends BaseSource, JvmPauseMonitorSo
   String STOREFILE_SIZE_DESC = "Size of storefiles being served.";
   String STOREFILE_SIZE_GROWTH_RATE_DESC =
     "Bytes per second by which the size of storefiles being served grows.";
+  String STOREFILE_UNCOMPRESSED_SIZE_DESC = "Total uncompressed size of storefiles being served.";
+  String STOREFILE_COMPRESSION_RATIO_DESC =
+    "Compression ratio of storefiles (compressed/uncompressed). Lower values indicate better"
+      + " compression. Returns 1.0 when there is no data.";
   String TOTAL_REQUEST_COUNT = "totalRequestCount";
   String TOTAL_REQUEST_COUNT_DESC =
     "Total number of requests this RegionServer has answered; increments the count once for "

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

@@ -519,6 +519,10 @@ private MetricsRecordBuilder addGaugesToMetricsRecordBuilder(MetricsRecordBuilde
       .addGauge(Interns.info(MEMSTORE_OFFHEAP_SIZE, MEMSTORE_OFFHEAP_SIZE_DESC),
         rsWrap.getOffHeapMemStoreSize())
       .addGauge(Interns.info(STOREFILE_SIZE, STOREFILE_SIZE_DESC), rsWrap.getStoreFileSize())
+      .addGauge(Interns.info(STOREFILE_UNCOMPRESSED_SIZE, STOREFILE_UNCOMPRESSED_SIZE_DESC),
+        rsWrap.getStoreFileUncompressedSize())
+      .addGauge(Interns.info(STOREFILE_COMPRESSION_RATIO, STOREFILE_COMPRESSION_RATIO_DESC),
+        rsWrap.getStoreFileCompressionRatio())
       .addGauge(Interns.info(STOREFILE_SIZE_GROWTH_RATE, STOREFILE_SIZE_GROWTH_RATE_DESC),
         rsWrap.getStoreFileSizeGrowthRate())
       .addGauge(Interns.info(MAX_STORE_FILE_AGE, MAX_STORE_FILE_AGE_DESC),

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

@@ -116,6 +116,17 @@ public interface MetricsRegionServerWrapper {
    */
   long getStoreFileSize();
 
+  /**
+   * Get the total uncompressed size of the store files this region server is serving from.
+   */
+  long getStoreFileUncompressedSize();
+
+  /**
+   * Get the compression ratio of store files on this region server. This is the ratio of compressed
+   * on-disk size to uncompressed data size. Returns 1.0 when there is no data.
+   */
+  double getStoreFileCompressionRatio();
+
   /**
    * Get the growth rate of the store files this region server is serving from.
    */

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

@@ -533,6 +533,20 @@ public long getStoreFileSize() {
     return aggregate.storeFileSize;
   }
 
+  @Override
+  public long getStoreFileUncompressedSize() {
+    return aggregate.storeFileUncompressedSize;
+  }
+
+  @Override
+  public double getStoreFileCompressionRatio() {
+    long uncompressed = aggregate.storeFileUncompressedSize;
+    if (uncompressed == 0) {
+      return 1.0;
+    }
+    return (double) aggregate.storeFileSize / uncompressed;
+  }
+
   @Override
   public double getStoreFileSizeGrowthRate() {
     return aggregate.storeFileSizeGrowthRate;
@@ -783,6 +797,7 @@ private static final class RegionMetricAggregate {
     private long onHeapMemstoreSize = 0;
     private long offHeapMemstoreSize = 0;
     private long storeFileSize = 0;
+    private long storeFileUncompressedSize = 0;
     private double storeFileSizeGrowthRate = 0;
     private long maxStoreFileCount = 0;
     private long maxStoreFileAge = 0;
@@ -979,6 +994,7 @@ private StoreFileStats aggregateStores(List<HStore> stores) {
         onHeapMemstoreSize += store.getMemStoreSize().getHeapSize();
         offHeapMemstoreSize += store.getMemStoreSize().getOffHeapSize();
         storeFileSize += store.getStorefilesSize();
+        storeFileUncompressedSize += store.getStoreSizeUncompressed();
         maxStoreFileCount = Math.max(maxStoreFileCount, store.getStorefilesCount());
 
         maxStoreFileAge =

hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/MetricsRegionServerWrapperStub.java

@@ -87,6 +87,16 @@ public long getStoreFileSize() {
     return 1900;
   }
 
+  @Override
+  public long getStoreFileUncompressedSize() {
+    return 3800;
+  }
+
+  @Override
+  public double getStoreFileCompressionRatio() {
+    return 0.5;
+  }
+
   @Override
   public double getStoreFileSizeGrowthRate() {
     return 50.0;

hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/TestMetricsRegionServer.java

@@ -90,6 +90,8 @@ public void testWrapperSource() {
     HELPER.assertGauge("memstoreHeapSize", 500, serverSource);
     HELPER.assertGauge("memstoreOffHeapSize", 600, serverSource);
     HELPER.assertGauge("storeFileSize", 1900, serverSource);
+    HELPER.assertGauge("storeFileUncompressedSize", 3800, serverSource);
+    HELPER.assertGauge("storeFileCompressionRatio", 0.5, serverSource);
     HELPER.assertGauge("storeFileSizeGrowthRate", 50.0, serverSource);
     HELPER.assertCounter("totalRequestCount", 899, serverSource);
     HELPER.assertCounter("totalRowActionRequestCount",