This is an automated email from the ASF dual-hosted git repository.
vjasani pushed a commit to branch branch-2
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/branch-2 by this push:
new 236555d3ef9 HBASE-29626: Refactor server side scan metrics for Coproc
hooks (#7348)
236555d3ef9 is described below
commit 236555d3ef9a30d4065ace915431170e40a13c29
Author: sanjeet006py <[email protected]>
AuthorDate: Sat Oct 4 03:38:31 2025 +0530
HBASE-29626: Refactor server side scan metrics for Coproc hooks (#7348)
Signed-off-by: Viraj Jasani <[email protected]>
---
.../org/apache/hadoop/hbase/io/hfile/HFile.java | 4 ++--
.../java/org/apache/hadoop/hbase/ipc/RpcCall.java | 4 ----
.../org/apache/hadoop/hbase/ipc/RpcServer.java | 6 ++---
.../org/apache/hadoop/hbase/ipc/ServerCall.java | 11 ---------
.../ThreadLocalServerSideScanMetrics.java | 23 ++++++++++++++++++-
.../hadoop/hbase/regionserver/RSRpcServices.java | 12 +++++-----
.../hbase/regionserver/RegionScannerImpl.java | 26 ----------------------
.../hbase/namequeues/TestNamedQueueRecorder.java | 10 ---------
.../hadoop/hbase/namequeues/TestRpcLogDetails.java | 10 ---------
.../store/region/TestRegionProcedureStore.java | 10 ---------
10 files changed, 34 insertions(+), 82 deletions(-)
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/HFile.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/HFile.java
index a99eac4085e..7080a865aa6 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/HFile.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/HFile.java
@@ -40,7 +40,7 @@ import org.apache.hadoop.hbase.io.MetricsIO;
import org.apache.hadoop.hbase.io.compress.Compression;
import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;
import org.apache.hadoop.hbase.io.hfile.ReaderContext.ReaderType;
-import org.apache.hadoop.hbase.ipc.RpcServer;
+import org.apache.hadoop.hbase.monitoring.ThreadLocalServerSideScanMetrics;
import org.apache.hadoop.hbase.regionserver.CellSink;
import org.apache.hadoop.hbase.regionserver.ShipperListener;
import org.apache.hadoop.hbase.regionserver.TimeRangeTracker;
@@ -190,7 +190,7 @@ public final class HFile {
}
public static final void updateReadLatency(long latencyMillis, boolean
pread, boolean tooSlow) {
- RpcServer.getCurrentCall().ifPresent(call ->
call.updateFsReadTime(latencyMillis));
+ ThreadLocalServerSideScanMetrics.addFsReadTime(latencyMillis);
if (pread) {
MetricsIO.getInstance().updateFsPreadTime(latencyMillis);
} else {
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/RpcCall.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/RpcCall.java
index 2d06aa7c47a..260d6e1a980 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/RpcCall.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/RpcCall.java
@@ -132,8 +132,4 @@ public interface RpcCall extends RpcCallContext {
/** Returns A short string format of this call without possibly lengthy
params */
String toShortString();
-
- void updateFsReadTime(long latencyMillis);
-
- long getFsReadTime();
}
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/RpcServer.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/RpcServer.java
index bba1e66b1f9..fc6d9ea7611 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/RpcServer.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/RpcServer.java
@@ -44,6 +44,7 @@ import org.apache.hadoop.hbase.conf.ConfigurationObserver;
import org.apache.hadoop.hbase.io.ByteBuffAllocator;
import org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler;
import org.apache.hadoop.hbase.monitoring.TaskMonitor;
+import org.apache.hadoop.hbase.monitoring.ThreadLocalServerSideScanMetrics;
import org.apache.hadoop.hbase.namequeues.NamedQueueRecorder;
import org.apache.hadoop.hbase.namequeues.RpcLogDetails;
import org.apache.hadoop.hbase.regionserver.RSRpcServices;
@@ -447,19 +448,18 @@ public abstract class RpcServer implements
RpcServerInterface, ConfigurationObse
int processingTime = (int) (endTime - startTime);
int qTime = (int) (startTime - receiveTime);
int totalTime = (int) (endTime - receiveTime);
+ long fsReadTime =
ThreadLocalServerSideScanMetrics.getFsReadTimeCounter().get();
if (LOG.isTraceEnabled()) {
LOG.trace(
"{}, response: {}, receiveTime: {}, queueTime: {}, processingTime:
{}, "
+ "totalTime: {}, fsReadTime: {}",
CurCall.get().toString(), TextFormat.shortDebugString(result),
- CurCall.get().getReceiveTime(), qTime, processingTime, totalTime,
- CurCall.get().getFsReadTime());
+ CurCall.get().getReceiveTime(), qTime, processingTime, totalTime,
fsReadTime);
}
// Use the raw request call size for now.
long requestSize = call.getSize();
long responseSize = result.getSerializedSize();
long responseBlockSize = call.getBlockBytesScanned();
- long fsReadTime = call.getFsReadTime();
if (call.isClientCellBlockSupported()) {
// Include the payload size in HBaseRpcController
responseSize += call.getResponseCellSize();
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/ServerCall.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/ServerCall.java
index db181d6d6f3..8702980a10d 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/ServerCall.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/ServerCall.java
@@ -102,7 +102,6 @@ public abstract class ServerCall<T extends
ServerRpcConnection> implements RpcCa
private long responseCellSize = 0;
private long responseBlockSize = 0;
- private long fsReadTimeMillis = 0;
// cumulative size of serialized exceptions
private long exceptionSize = 0;
private final boolean retryImmediatelySupported;
@@ -610,14 +609,4 @@ public abstract class ServerCall<T extends
ServerRpcConnection> implements RpcCa
public synchronized RpcCallback getCallBack() {
return this.rpcCallback;
}
-
- @Override
- public void updateFsReadTime(long latencyMillis) {
- fsReadTimeMillis += latencyMillis;
- }
-
- @Override
- public long getFsReadTime() {
- return fsReadTimeMillis;
- }
}
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/monitoring/ThreadLocalServerSideScanMetrics.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/monitoring/ThreadLocalServerSideScanMetrics.java
index 8c9ec24e866..e14761ab6e1 100644
---
a/hbase-server/src/main/java/org/apache/hadoop/hbase/monitoring/ThreadLocalServerSideScanMetrics.java
+++
b/hbase-server/src/main/java/org/apache/hadoop/hbase/monitoring/ThreadLocalServerSideScanMetrics.java
@@ -18,10 +18,12 @@
package org.apache.hadoop.hbase.monitoring;
import java.util.concurrent.atomic.AtomicLong;
+import org.apache.hadoop.hbase.HBaseInterfaceAudience;
import org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics;
import org.apache.hadoop.hbase.regionserver.RegionScanner;
import org.apache.hadoop.hbase.regionserver.ScannerContext;
import org.apache.yetus.audience.InterfaceAudience;
+import org.apache.yetus.audience.InterfaceStability;
/**
* Thread-local storage for server-side scan metrics that captures performance
data separately for
@@ -61,7 +63,8 @@ import org.apache.yetus.audience.InterfaceAudience;
* @see RegionScanner
* @see org.apache.hadoop.hbase.regionserver.handler.ParallelSeekHandler
*/
[email protected]
[email protected](HBaseInterfaceAudience.PHOENIX)
[email protected]
public final class ThreadLocalServerSideScanMetrics {
private ThreadLocalServerSideScanMetrics() {
}
@@ -81,6 +84,9 @@ public final class ThreadLocalServerSideScanMetrics {
private static final ThreadLocal<AtomicLong> BLOCK_READ_OPS_COUNT =
ThreadLocal.withInitial(() -> new AtomicLong(0));
+ private static final ThreadLocal<AtomicLong> FS_READ_TIME =
+ ThreadLocal.withInitial(() -> new AtomicLong(0));
+
public static void setScanMetricsEnabled(boolean enable) {
IS_SCAN_METRICS_ENABLED.set(enable);
}
@@ -101,6 +107,10 @@ public final class ThreadLocalServerSideScanMetrics {
return BLOCK_READ_OPS_COUNT.get().addAndGet(count);
}
+ public static long addFsReadTime(long time) {
+ return FS_READ_TIME.get().addAndGet(time);
+ }
+
public static boolean isScanMetricsEnabled() {
return IS_SCAN_METRICS_ENABLED.get();
}
@@ -121,6 +131,10 @@ public final class ThreadLocalServerSideScanMetrics {
return BLOCK_READ_OPS_COUNT.get();
}
+ public static AtomicLong getFsReadTimeCounter() {
+ return FS_READ_TIME.get();
+ }
+
public static long getBytesReadFromFsAndReset() {
return getBytesReadFromFsCounter().getAndSet(0);
}
@@ -137,11 +151,16 @@ public final class ThreadLocalServerSideScanMetrics {
return getBlockReadOpsCountCounter().getAndSet(0);
}
+ public static long getFsReadTimeAndReset() {
+ return getFsReadTimeCounter().getAndSet(0);
+ }
+
public static void reset() {
getBytesReadFromFsAndReset();
getBytesReadFromBlockCacheAndReset();
getBytesReadFromMemstoreAndReset();
getBlockReadOpsCountAndReset();
+ getFsReadTimeAndReset();
}
public static void populateServerSideScanMetrics(ServerSideScanMetrics
metrics) {
@@ -156,5 +175,7 @@ public final class ThreadLocalServerSideScanMetrics {
getBytesReadFromMemstoreCounter().get());
metrics.addToCounter(ServerSideScanMetrics.BLOCK_READ_OPS_COUNT_METRIC_NAME,
getBlockReadOpsCountCounter().get());
+ metrics.addToCounter(ServerSideScanMetrics.FS_READ_TIME_METRIC_NAME,
+ getFsReadTimeCounter().get());
}
}
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RSRpcServices.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RSRpcServices.java
index 7bad1d99bad..e246da4bd83 100644
---
a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RSRpcServices.java
+++
b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RSRpcServices.java
@@ -112,6 +112,7 @@ import org.apache.hadoop.hbase.ipc.ServerRpcController;
import org.apache.hadoop.hbase.log.HBaseMarkers;
import org.apache.hadoop.hbase.master.HMaster;
import org.apache.hadoop.hbase.master.MasterRpcServices;
+import org.apache.hadoop.hbase.monitoring.ThreadLocalServerSideScanMetrics;
import org.apache.hadoop.hbase.namequeues.NamedQueuePayload;
import org.apache.hadoop.hbase.namequeues.NamedQueueRecorder;
import org.apache.hadoop.hbase.namequeues.RpcLogDetails;
@@ -3570,10 +3571,6 @@ public class RSRpcServices implements
HBaseRPCErrorHandler, AdminService.Blockin
// from block size progress before writing into the response
scanMetrics.setCounter(ServerSideScanMetrics.BLOCK_BYTES_SCANNED_KEY_METRIC_NAME,
scannerContext.getBlockSizeProgress());
- if (rpcCall != null) {
-
scanMetrics.setCounter(ServerSideScanMetrics.FS_READ_TIME_METRIC_NAME,
- rpcCall.getFsReadTime());
- }
}
}
} finally {
@@ -3639,6 +3636,11 @@ public class RSRpcServices implements
HBaseRPCErrorHandler, AdminService.Blockin
}
throw new ServiceException(e);
}
+ boolean trackMetrics = request.hasTrackScanMetrics() &&
request.getTrackScanMetrics();
+ ThreadLocalServerSideScanMetrics.setScanMetricsEnabled(trackMetrics);
+ if (trackMetrics) {
+ ThreadLocalServerSideScanMetrics.reset();
+ }
requestCount.increment();
rpcScanRequestCount.increment();
RegionScannerContext rsx;
@@ -3709,7 +3711,6 @@ public class RSRpcServices implements
HBaseRPCErrorHandler, AdminService.Blockin
boolean scannerClosed = false;
try {
List<Result> results = new ArrayList<>(Math.min(rows, 512));
- boolean trackMetrics = request.hasTrackScanMetrics() &&
request.getTrackScanMetrics();
ServerSideScanMetrics scanMetrics = trackMetrics ? new
ServerSideScanMetrics() : null;
if (rows > 0) {
boolean done = false;
@@ -3791,6 +3792,7 @@ public class RSRpcServices implements
HBaseRPCErrorHandler, AdminService.Blockin
scanMetrics.addToCounter(ServerSideScanMetrics.RPC_SCAN_QUEUE_WAIT_TIME_METRIC_NAME,
rpcQueueWaitTime);
}
+
ThreadLocalServerSideScanMetrics.populateServerSideScanMetrics(scanMetrics);
Map<String, Long> metrics = scanMetrics.getMetricsMap();
ScanMetrics.Builder metricBuilder = ScanMetrics.newBuilder();
NameInt64Pair.Builder pairBuilder = NameInt64Pair.newBuilder();
diff --git
a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RegionScannerImpl.java
b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RegionScannerImpl.java
index 98127f1f5c9..4d1332351a8 100644
---
a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RegionScannerImpl.java
+++
b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/RegionScannerImpl.java
@@ -45,7 +45,6 @@ import
org.apache.hadoop.hbase.ipc.CallerDisconnectedException;
import org.apache.hadoop.hbase.ipc.RpcCall;
import org.apache.hadoop.hbase.ipc.RpcCallback;
import org.apache.hadoop.hbase.ipc.RpcServer;
-import org.apache.hadoop.hbase.monitoring.ThreadLocalServerSideScanMetrics;
import org.apache.hadoop.hbase.regionserver.Region.Operation;
import org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope;
import org.apache.hadoop.hbase.regionserver.ScannerContext.NextState;
@@ -96,8 +95,6 @@ public class RegionScannerImpl implements RegionScanner,
Shipper, RpcCallback {
private RegionServerServices rsServices;
- private ServerSideScanMetrics scannerInitMetrics = null;
-
@Override
public RegionInfo getRegionInfo() {
return region.getRegionInfo();
@@ -148,16 +145,7 @@ public class RegionScannerImpl implements RegionScanner,
Shipper, RpcCallback {
} finally {
region.smallestReadPointCalcLock.unlock(ReadPointCalculationLock.LockType.RECORDING_LOCK);
}
- boolean isScanMetricsEnabled = scan.isScanMetricsEnabled();
-
ThreadLocalServerSideScanMetrics.setScanMetricsEnabled(isScanMetricsEnabled);
- if (isScanMetricsEnabled) {
- this.scannerInitMetrics = new ServerSideScanMetrics();
- ThreadLocalServerSideScanMetrics.reset();
- }
initializeScanners(scan, additionalScanners);
- if (isScanMetricsEnabled) {
-
ThreadLocalServerSideScanMetrics.populateServerSideScanMetrics(scannerInitMetrics);
- }
}
public ScannerContext getContext() {
@@ -290,16 +278,6 @@ public class RegionScannerImpl implements RegionScanner,
Shipper, RpcCallback {
throw new UnknownScannerException("Scanner was closed");
}
boolean moreValues = false;
- boolean isScanMetricsEnabled = scannerContext.isTrackingMetrics();
-
ThreadLocalServerSideScanMetrics.setScanMetricsEnabled(isScanMetricsEnabled);
- if (isScanMetricsEnabled) {
- ThreadLocalServerSideScanMetrics.reset();
- ServerSideScanMetrics scanMetrics = scannerContext.getMetrics();
- if (scannerInitMetrics != null) {
- scannerInitMetrics.getMetricsMap().forEach(scanMetrics::addToCounter);
- scannerInitMetrics = null;
- }
- }
if (outResults.isEmpty()) {
// Usually outResults is empty. This is true when next is called
// to handle scan or get operation.
@@ -309,10 +287,6 @@ public class RegionScannerImpl implements RegionScanner,
Shipper, RpcCallback {
moreValues = nextInternal(tmpList, scannerContext);
outResults.addAll(tmpList);
}
- if (isScanMetricsEnabled) {
- ServerSideScanMetrics scanMetrics = scannerContext.getMetrics();
-
ThreadLocalServerSideScanMetrics.populateServerSideScanMetrics(scanMetrics);
- }
region.addReadRequestsCount(1);
if (region.getMetrics() != null) {
region.getMetrics().updateReadRequestCount();
diff --git
a/hbase-server/src/test/java/org/apache/hadoop/hbase/namequeues/TestNamedQueueRecorder.java
b/hbase-server/src/test/java/org/apache/hadoop/hbase/namequeues/TestNamedQueueRecorder.java
index f4cccebde03..b08d4db191f 100644
---
a/hbase-server/src/test/java/org/apache/hadoop/hbase/namequeues/TestNamedQueueRecorder.java
+++
b/hbase-server/src/test/java/org/apache/hadoop/hbase/namequeues/TestNamedQueueRecorder.java
@@ -919,16 +919,6 @@ public class TestNamedQueueRecorder {
@Override
public void incrementResponseExceptionSize(long exceptionSize) {
}
-
- @Override
- public void updateFsReadTime(long latencyMillis) {
-
- }
-
- @Override
- public long getFsReadTime() {
- return 0;
- }
};
return rpcCall;
}
diff --git
a/hbase-server/src/test/java/org/apache/hadoop/hbase/namequeues/TestRpcLogDetails.java
b/hbase-server/src/test/java/org/apache/hadoop/hbase/namequeues/TestRpcLogDetails.java
index 1de0a0d31a3..bed9dea55c6 100644
---
a/hbase-server/src/test/java/org/apache/hadoop/hbase/namequeues/TestRpcLogDetails.java
+++
b/hbase-server/src/test/java/org/apache/hadoop/hbase/namequeues/TestRpcLogDetails.java
@@ -264,16 +264,6 @@ public class TestRpcLogDetails {
@Override
public void incrementResponseExceptionSize(long exceptionSize) {
}
-
- @Override
- public void updateFsReadTime(long latencyMillis) {
-
- }
-
- @Override
- public long getFsReadTime() {
- return 0;
- }
};
return rpcCall;
}
diff --git
a/hbase-server/src/test/java/org/apache/hadoop/hbase/procedure2/store/region/TestRegionProcedureStore.java
b/hbase-server/src/test/java/org/apache/hadoop/hbase/procedure2/store/region/TestRegionProcedureStore.java
index fdd5c7d5cf9..cd86d3424d3 100644
---
a/hbase-server/src/test/java/org/apache/hadoop/hbase/procedure2/store/region/TestRegionProcedureStore.java
+++
b/hbase-server/src/test/java/org/apache/hadoop/hbase/procedure2/store/region/TestRegionProcedureStore.java
@@ -326,16 +326,6 @@ public class TestRegionProcedureStore extends
RegionProcedureStoreTestBase {
@Override
public void incrementResponseExceptionSize(long exceptionSize) {
}
-
- @Override
- public void updateFsReadTime(long latencyMillis) {
-
- }
-
- @Override
- public long getFsReadTime() {
- return 0;
- }
};
}
}
