blob: 211d0855283cdb201d5d886d43dcc747e71b2b9f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver, class: TestScannerHeartbeatMessages">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import static org.apache.hadoop.hbase.regionserver.RSRpcServices.DEFAULT_REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.junit.Assert.assertEquals;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.junit.Assert.assertTrue;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.junit.Assert.fail;</span>
<span class="source-line-no">024</span><span id="line-24">import static org.mockito.Mockito.when;</span>
<span class="source-line-no">025</span><span id="line-25"></span>
<span class="source-line-no">026</span><span id="line-26">import java.io.IOException;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.ArrayList;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.List;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.Callable;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.commons.lang3.exception.ExceptionUtils;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.CellComparator;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.CellComparatorImpl;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.CellUtil;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.ExtendedCell;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.HBaseTestingUtil;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.HTestConst;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.KeyValue;</span>
<span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.hbase.client.AdvancedScanResultConsumer;</span>
<span class="source-line-no">046</span><span id="line-46">import org.apache.hadoop.hbase.client.AsyncConnection;</span>
<span class="source-line-no">047</span><span id="line-47">import org.apache.hadoop.hbase.client.AsyncTable;</span>
<span class="source-line-no">048</span><span id="line-48">import org.apache.hadoop.hbase.client.ConnectionFactory;</span>
<span class="source-line-no">049</span><span id="line-49">import org.apache.hadoop.hbase.client.Put;</span>
<span class="source-line-no">050</span><span id="line-50">import org.apache.hadoop.hbase.client.RegionInfo;</span>
<span class="source-line-no">051</span><span id="line-51">import org.apache.hadoop.hbase.client.Result;</span>
<span class="source-line-no">052</span><span id="line-52">import org.apache.hadoop.hbase.client.ResultScanner;</span>
<span class="source-line-no">053</span><span id="line-53">import org.apache.hadoop.hbase.client.Scan;</span>
<span class="source-line-no">054</span><span id="line-54">import org.apache.hadoop.hbase.client.ScanPerNextResultScanner;</span>
<span class="source-line-no">055</span><span id="line-55">import org.apache.hadoop.hbase.client.Table;</span>
<span class="source-line-no">056</span><span id="line-56">import org.apache.hadoop.hbase.client.TableDescriptor;</span>
<span class="source-line-no">057</span><span id="line-57">import org.apache.hadoop.hbase.filter.Filter;</span>
<span class="source-line-no">058</span><span id="line-58">import org.apache.hadoop.hbase.filter.FilterBase;</span>
<span class="source-line-no">059</span><span id="line-59">import org.apache.hadoop.hbase.ipc.HBaseRpcController;</span>
<span class="source-line-no">060</span><span id="line-60">import org.apache.hadoop.hbase.ipc.RpcCall;</span>
<span class="source-line-no">061</span><span id="line-61">import org.apache.hadoop.hbase.testclassification.LargeTests;</span>
<span class="source-line-no">062</span><span id="line-62">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">063</span><span id="line-63">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">064</span><span id="line-64">import org.apache.hadoop.hbase.util.Threads;</span>
<span class="source-line-no">065</span><span id="line-65">import org.apache.hadoop.hbase.wal.WAL;</span>
<span class="source-line-no">066</span><span id="line-66">import org.junit.After;</span>
<span class="source-line-no">067</span><span id="line-67">import org.junit.AfterClass;</span>
<span class="source-line-no">068</span><span id="line-68">import org.junit.Before;</span>
<span class="source-line-no">069</span><span id="line-69">import org.junit.BeforeClass;</span>
<span class="source-line-no">070</span><span id="line-70">import org.junit.ClassRule;</span>
<span class="source-line-no">071</span><span id="line-71">import org.junit.Test;</span>
<span class="source-line-no">072</span><span id="line-72">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">073</span><span id="line-73">import org.mockito.Mockito;</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75">import org.apache.hbase.thirdparty.com.google.common.io.Closeables;</span>
<span class="source-line-no">076</span><span id="line-76">import org.apache.hbase.thirdparty.com.google.protobuf.RpcController;</span>
<span class="source-line-no">077</span><span id="line-77">import org.apache.hbase.thirdparty.com.google.protobuf.ServiceException;</span>
<span class="source-line-no">078</span><span id="line-78"></span>
<span class="source-line-no">079</span><span id="line-79">import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest;</span>
<span class="source-line-no">080</span><span id="line-80">import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanResponse;</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82">/**</span>
<span class="source-line-no">083</span><span id="line-83"> * Here we test to make sure that scans return the expected Results when the server is sending the</span>
<span class="source-line-no">084</span><span id="line-84"> * Client heartbeat messages. Heartbeat messages are essentially keep-alive messages (they prevent</span>
<span class="source-line-no">085</span><span id="line-85"> * the scanner on the client side from timing out). A heartbeat message is sent from the server to</span>
<span class="source-line-no">086</span><span id="line-86"> * the client when the server has exceeded the time limit during the processing of the scan. When</span>
<span class="source-line-no">087</span><span id="line-87"> * the time limit is reached, the server will return to the Client whatever Results it has</span>
<span class="source-line-no">088</span><span id="line-88"> * accumulated (potentially empty).</span>
<span class="source-line-no">089</span><span id="line-89"> */</span>
<span class="source-line-no">090</span><span id="line-90">@Category(LargeTests.class)</span>
<span class="source-line-no">091</span><span id="line-91">public class TestScannerHeartbeatMessages {</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> @ClassRule</span>
<span class="source-line-no">094</span><span id="line-94"> public static final HBaseClassTestRule CLASS_RULE =</span>
<span class="source-line-no">095</span><span id="line-95"> HBaseClassTestRule.forClass(TestScannerHeartbeatMessages.class);</span>
<span class="source-line-no">096</span><span id="line-96"></span>
<span class="source-line-no">097</span><span id="line-97"> private final static HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> private static AsyncConnection CONN;</span>
<span class="source-line-no">100</span><span id="line-100"></span>
<span class="source-line-no">101</span><span id="line-101"> /**</span>
<span class="source-line-no">102</span><span id="line-102"> * Table configuration</span>
<span class="source-line-no">103</span><span id="line-103"> */</span>
<span class="source-line-no">104</span><span id="line-104"> private static TableName TABLE_NAME = TableName.valueOf("testScannerHeartbeatMessagesTable");</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> private static int NUM_ROWS = 5;</span>
<span class="source-line-no">107</span><span id="line-107"> private static byte[] ROW = Bytes.toBytes("testRow");</span>
<span class="source-line-no">108</span><span id="line-108"> private static byte[][] ROWS = HTestConst.makeNAscii(ROW, NUM_ROWS);</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> private static int NUM_FAMILIES = 4;</span>
<span class="source-line-no">111</span><span id="line-111"> private static byte[] FAMILY = Bytes.toBytes("testFamily");</span>
<span class="source-line-no">112</span><span id="line-112"> private static byte[][] FAMILIES = HTestConst.makeNAscii(FAMILY, NUM_FAMILIES);</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> private static int NUM_QUALIFIERS = 3;</span>
<span class="source-line-no">115</span><span id="line-115"> private static byte[] QUALIFIER = Bytes.toBytes("testQualifier");</span>
<span class="source-line-no">116</span><span id="line-116"> private static byte[][] QUALIFIERS = HTestConst.makeNAscii(QUALIFIER, NUM_QUALIFIERS);</span>
<span class="source-line-no">117</span><span id="line-117"></span>
<span class="source-line-no">118</span><span id="line-118"> private static int VALUE_SIZE = 128;</span>
<span class="source-line-no">119</span><span id="line-119"> private static byte[] VALUE = Bytes.createMaxByteArray(VALUE_SIZE);</span>
<span class="source-line-no">120</span><span id="line-120"></span>
<span class="source-line-no">121</span><span id="line-121"> // The time limit should be based on the rpc timeout at client, or the client will regards</span>
<span class="source-line-no">122</span><span id="line-122"> // the request as timeout before server return a heartbeat.</span>
<span class="source-line-no">123</span><span id="line-123"> private static int SERVER_TIMEOUT = 60000;</span>
<span class="source-line-no">124</span><span id="line-124"></span>
<span class="source-line-no">125</span><span id="line-125"> // Time, in milliseconds, that the client will wait for a response from the server before timing</span>
<span class="source-line-no">126</span><span id="line-126"> // out. This value is used server side to determine when it is necessary to send a heartbeat</span>
<span class="source-line-no">127</span><span id="line-127"> // message to the client. Time limit will be 500 ms.</span>
<span class="source-line-no">128</span><span id="line-128"> private static int CLIENT_TIMEOUT = 1000;</span>
<span class="source-line-no">129</span><span id="line-129"></span>
<span class="source-line-no">130</span><span id="line-130"> // In this test, we sleep after reading each row. So we should make sure after we get some number</span>
<span class="source-line-no">131</span><span id="line-131"> // of rows and sleep same times we must reach time limit, and do not timeout after next sleeping.</span>
<span class="source-line-no">132</span><span id="line-132"> private static int DEFAULT_ROW_SLEEP_TIME = 300;</span>
<span class="source-line-no">133</span><span id="line-133"></span>
<span class="source-line-no">134</span><span id="line-134"> // Similar with row sleep time.</span>
<span class="source-line-no">135</span><span id="line-135"> private static int DEFAULT_CF_SLEEP_TIME = 300;</span>
<span class="source-line-no">136</span><span id="line-136"></span>
<span class="source-line-no">137</span><span id="line-137"> @BeforeClass</span>
<span class="source-line-no">138</span><span id="line-138"> public static void setUpBeforeClass() throws Exception {</span>
<span class="source-line-no">139</span><span id="line-139"> Configuration conf = TEST_UTIL.getConfiguration();</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> conf.setStrings(HConstants.REGION_IMPL, HeartbeatHRegion.class.getName());</span>
<span class="source-line-no">142</span><span id="line-142"> conf.setStrings(HConstants.REGION_SERVER_IMPL, HeartbeatHRegionServer.class.getName());</span>
<span class="source-line-no">143</span><span id="line-143"> conf.setInt(HConstants.HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD, SERVER_TIMEOUT);</span>
<span class="source-line-no">144</span><span id="line-144"> conf.setInt(HConstants.HBASE_RPC_TIMEOUT_KEY, SERVER_TIMEOUT);</span>
<span class="source-line-no">145</span><span id="line-145"> conf.setInt(HConstants.HBASE_CLIENT_PAUSE, 1);</span>
<span class="source-line-no">146</span><span id="line-146"></span>
<span class="source-line-no">147</span><span id="line-147"> // Check the timeout condition after every cell</span>
<span class="source-line-no">148</span><span id="line-148"> conf.setLong(StoreScanner.HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK, 1);</span>
<span class="source-line-no">149</span><span id="line-149"> TEST_UTIL.startMiniCluster(1);</span>
<span class="source-line-no">150</span><span id="line-150"></span>
<span class="source-line-no">151</span><span id="line-151"> createTestTable(TABLE_NAME, ROWS, FAMILIES, QUALIFIERS, VALUE);</span>
<span class="source-line-no">152</span><span id="line-152"></span>
<span class="source-line-no">153</span><span id="line-153"> Configuration newConf = new Configuration(conf);</span>
<span class="source-line-no">154</span><span id="line-154"> newConf.setInt(HConstants.HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD, CLIENT_TIMEOUT);</span>
<span class="source-line-no">155</span><span id="line-155"> newConf.setInt(HConstants.HBASE_RPC_TIMEOUT_KEY, CLIENT_TIMEOUT);</span>
<span class="source-line-no">156</span><span id="line-156"> CONN = ConnectionFactory.createAsyncConnection(newConf).get();</span>
<span class="source-line-no">157</span><span id="line-157"> }</span>
<span class="source-line-no">158</span><span id="line-158"></span>
<span class="source-line-no">159</span><span id="line-159"> @Test</span>
<span class="source-line-no">160</span><span id="line-160"> public void testTimeLimitAccountsForQueueTime() throws IOException, InterruptedException {</span>
<span class="source-line-no">161</span><span id="line-161"> HRegionServer rs = TEST_UTIL.getMiniHBaseCluster().getRegionServer(0);</span>
<span class="source-line-no">162</span><span id="line-162"> RSRpcServices services = new RSRpcServices(rs);</span>
<span class="source-line-no">163</span><span id="line-163"> RpcCall mockRpcCall = Mockito.mock(RpcCall.class);</span>
<span class="source-line-no">164</span><span id="line-164"> // first return 180 (minimal queuing), then 120 (more queueing), then 101 (heavy queueing)</span>
<span class="source-line-no">165</span><span id="line-165"> // finally, 25 is fatal levels of queueing -- exceeding timeout</span>
<span class="source-line-no">166</span><span id="line-166"> when(mockRpcCall.getReceiveTime()).thenReturn(180L, 120L, 101L, 25L);</span>
<span class="source-line-no">167</span><span id="line-167"></span>
<span class="source-line-no">168</span><span id="line-168"> // assume timeout of 100ms</span>
<span class="source-line-no">169</span><span id="line-169"> HBaseRpcController mockController = Mockito.mock(HBaseRpcController.class);</span>
<span class="source-line-no">170</span><span id="line-170"> when(mockController.getCallTimeout()).thenReturn(100);</span>
<span class="source-line-no">171</span><span id="line-171"></span>
<span class="source-line-no">172</span><span id="line-172"> // current time is 100, which we'll subtract from 90 and 50 to generate some time deltas</span>
<span class="source-line-no">173</span><span id="line-173"> EnvironmentEdgeManager.injectEdge(() -&gt; 200L);</span>
<span class="source-line-no">174</span><span id="line-174"></span>
<span class="source-line-no">175</span><span id="line-175"> try {</span>
<span class="source-line-no">176</span><span id="line-176"> // we queued for 20ms, leaving 80ms of timeout, which we divide by 2</span>
<span class="source-line-no">177</span><span id="line-177"> assertEquals(200 + (100 - 20) / 2, services.getTimeLimit(mockRpcCall, mockController, true));</span>
<span class="source-line-no">178</span><span id="line-178"> // we queued for 80ms, leaving 20ms of timeout, which we divide by 2</span>
<span class="source-line-no">179</span><span id="line-179"> assertEquals(200 + (100 - 80) / 2, services.getTimeLimit(mockRpcCall, mockController, true));</span>
<span class="source-line-no">180</span><span id="line-180"> // we queued for 99ms of 100ms timeout, leaving only 1ms. we fall back to default minimum</span>
<span class="source-line-no">181</span><span id="line-181"> assertEquals(200 + DEFAULT_REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA,</span>
<span class="source-line-no">182</span><span id="line-182"> services.getTimeLimit(mockRpcCall, mockController, true));</span>
<span class="source-line-no">183</span><span id="line-183"> // lastly, we queue for 175ms of 100ms timeout. this should be very rare since we drop</span>
<span class="source-line-no">184</span><span id="line-184"> // timed out calls in the queue. in this case we still fallback on default minimum for now.</span>
<span class="source-line-no">185</span><span id="line-185"> assertEquals(200 + DEFAULT_REGION_SERVER_RPC_MINIMUM_SCAN_TIME_LIMIT_DELTA,</span>
<span class="source-line-no">186</span><span id="line-186"> services.getTimeLimit(mockRpcCall, mockController, true));</span>
<span class="source-line-no">187</span><span id="line-187"> } finally {</span>
<span class="source-line-no">188</span><span id="line-188"> EnvironmentEdgeManager.reset();</span>
<span class="source-line-no">189</span><span id="line-189"> }</span>
<span class="source-line-no">190</span><span id="line-190"></span>
<span class="source-line-no">191</span><span id="line-191"> }</span>
<span class="source-line-no">192</span><span id="line-192"></span>
<span class="source-line-no">193</span><span id="line-193"> static void createTestTable(TableName name, byte[][] rows, byte[][] families, byte[][] qualifiers,</span>
<span class="source-line-no">194</span><span id="line-194"> byte[] cellValue) throws IOException {</span>
<span class="source-line-no">195</span><span id="line-195"> Table ht = TEST_UTIL.createTable(name, families);</span>
<span class="source-line-no">196</span><span id="line-196"> List&lt;Put&gt; puts = createPuts(rows, families, qualifiers, cellValue);</span>
<span class="source-line-no">197</span><span id="line-197"> ht.put(puts);</span>
<span class="source-line-no">198</span><span id="line-198"> }</span>
<span class="source-line-no">199</span><span id="line-199"></span>
<span class="source-line-no">200</span><span id="line-200"> /**</span>
<span class="source-line-no">201</span><span id="line-201"> * Make puts to put the input value into each combination of row, family, and qualifier</span>
<span class="source-line-no">202</span><span id="line-202"> */</span>
<span class="source-line-no">203</span><span id="line-203"> static ArrayList&lt;Put&gt; createPuts(byte[][] rows, byte[][] families, byte[][] qualifiers,</span>
<span class="source-line-no">204</span><span id="line-204"> byte[] value) throws IOException {</span>
<span class="source-line-no">205</span><span id="line-205"> Put put;</span>
<span class="source-line-no">206</span><span id="line-206"> ArrayList&lt;Put&gt; puts = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">207</span><span id="line-207"></span>
<span class="source-line-no">208</span><span id="line-208"> for (int row = 0; row &lt; rows.length; row++) {</span>
<span class="source-line-no">209</span><span id="line-209"> put = new Put(rows[row]);</span>
<span class="source-line-no">210</span><span id="line-210"> for (int fam = 0; fam &lt; families.length; fam++) {</span>
<span class="source-line-no">211</span><span id="line-211"> for (int qual = 0; qual &lt; qualifiers.length; qual++) {</span>
<span class="source-line-no">212</span><span id="line-212"> KeyValue kv = new KeyValue(rows[row], families[fam], qualifiers[qual], qual, value);</span>
<span class="source-line-no">213</span><span id="line-213"> put.add(kv);</span>
<span class="source-line-no">214</span><span id="line-214"> }</span>
<span class="source-line-no">215</span><span id="line-215"> }</span>
<span class="source-line-no">216</span><span id="line-216"> puts.add(put);</span>
<span class="source-line-no">217</span><span id="line-217"> }</span>
<span class="source-line-no">218</span><span id="line-218"></span>
<span class="source-line-no">219</span><span id="line-219"> return puts;</span>
<span class="source-line-no">220</span><span id="line-220"> }</span>
<span class="source-line-no">221</span><span id="line-221"></span>
<span class="source-line-no">222</span><span id="line-222"> @AfterClass</span>
<span class="source-line-no">223</span><span id="line-223"> public static void tearDownAfterClass() throws Exception {</span>
<span class="source-line-no">224</span><span id="line-224"> Closeables.close(CONN, true);</span>
<span class="source-line-no">225</span><span id="line-225"> TEST_UTIL.shutdownMiniCluster();</span>
<span class="source-line-no">226</span><span id="line-226"> }</span>
<span class="source-line-no">227</span><span id="line-227"></span>
<span class="source-line-no">228</span><span id="line-228"> @Before</span>
<span class="source-line-no">229</span><span id="line-229"> public void setupBeforeTest() throws Exception {</span>
<span class="source-line-no">230</span><span id="line-230"> disableSleeping();</span>
<span class="source-line-no">231</span><span id="line-231"> }</span>
<span class="source-line-no">232</span><span id="line-232"></span>
<span class="source-line-no">233</span><span id="line-233"> @After</span>
<span class="source-line-no">234</span><span id="line-234"> public void teardownAfterTest() throws Exception {</span>
<span class="source-line-no">235</span><span id="line-235"> disableSleeping();</span>
<span class="source-line-no">236</span><span id="line-236"> }</span>
<span class="source-line-no">237</span><span id="line-237"></span>
<span class="source-line-no">238</span><span id="line-238"> /**</span>
<span class="source-line-no">239</span><span id="line-239"> * Run the test callable when heartbeats are enabled/disabled. We expect all tests to only pass</span>
<span class="source-line-no">240</span><span id="line-240"> * when heartbeat messages are enabled (otherwise the test is pointless). When heartbeats are</span>
<span class="source-line-no">241</span><span id="line-241"> * disabled, the test should throw an exception.</span>
<span class="source-line-no">242</span><span id="line-242"> */</span>
<span class="source-line-no">243</span><span id="line-243"> private void testImportanceOfHeartbeats(Callable&lt;Void&gt; testCallable) throws InterruptedException {</span>
<span class="source-line-no">244</span><span id="line-244"> HeartbeatRPCServices.heartbeatsEnabled = true;</span>
<span class="source-line-no">245</span><span id="line-245"></span>
<span class="source-line-no">246</span><span id="line-246"> try {</span>
<span class="source-line-no">247</span><span id="line-247"> testCallable.call();</span>
<span class="source-line-no">248</span><span id="line-248"> } catch (Exception e) {</span>
<span class="source-line-no">249</span><span id="line-249"> fail("Heartbeat messages are enabled, exceptions should NOT be thrown. Exception trace:"</span>
<span class="source-line-no">250</span><span id="line-250"> + ExceptionUtils.getStackTrace(e));</span>
<span class="source-line-no">251</span><span id="line-251"> }</span>
<span class="source-line-no">252</span><span id="line-252"></span>
<span class="source-line-no">253</span><span id="line-253"> HeartbeatRPCServices.heartbeatsEnabled = false;</span>
<span class="source-line-no">254</span><span id="line-254"> try {</span>
<span class="source-line-no">255</span><span id="line-255"> testCallable.call();</span>
<span class="source-line-no">256</span><span id="line-256"> } catch (Exception e) {</span>
<span class="source-line-no">257</span><span id="line-257"> return;</span>
<span class="source-line-no">258</span><span id="line-258"> } finally {</span>
<span class="source-line-no">259</span><span id="line-259"> HeartbeatRPCServices.heartbeatsEnabled = true;</span>
<span class="source-line-no">260</span><span id="line-260"> }</span>
<span class="source-line-no">261</span><span id="line-261"> fail("Heartbeats messages are disabled, an exception should be thrown. If an exception "</span>
<span class="source-line-no">262</span><span id="line-262"> + " is not thrown, the test case is not testing the importance of heartbeat messages");</span>
<span class="source-line-no">263</span><span id="line-263"> }</span>
<span class="source-line-no">264</span><span id="line-264"></span>
<span class="source-line-no">265</span><span id="line-265"> /**</span>
<span class="source-line-no">266</span><span id="line-266"> * Test the case that the time limit for the scan is reached after each full row of cells is</span>
<span class="source-line-no">267</span><span id="line-267"> * fetched.</span>
<span class="source-line-no">268</span><span id="line-268"> */</span>
<span class="source-line-no">269</span><span id="line-269"> @Test</span>
<span class="source-line-no">270</span><span id="line-270"> public void testHeartbeatBetweenRows() throws Exception {</span>
<span class="source-line-no">271</span><span id="line-271"> testImportanceOfHeartbeats(new Callable&lt;Void&gt;() {</span>
<span class="source-line-no">272</span><span id="line-272"></span>
<span class="source-line-no">273</span><span id="line-273"> @Override</span>
<span class="source-line-no">274</span><span id="line-274"> public Void call() throws Exception {</span>
<span class="source-line-no">275</span><span id="line-275"> // Configure the scan so that it can read the entire table in a single RPC. We want to test</span>
<span class="source-line-no">276</span><span id="line-276"> // the case where a scan stops on the server side due to a time limit</span>
<span class="source-line-no">277</span><span id="line-277"> Scan scan = new Scan();</span>
<span class="source-line-no">278</span><span id="line-278"> scan.setMaxResultSize(Long.MAX_VALUE);</span>
<span class="source-line-no">279</span><span id="line-279"> scan.setCaching(Integer.MAX_VALUE);</span>
<span class="source-line-no">280</span><span id="line-280"></span>
<span class="source-line-no">281</span><span id="line-281"> testEquivalenceOfScanWithHeartbeats(scan, DEFAULT_ROW_SLEEP_TIME, -1, false);</span>
<span class="source-line-no">282</span><span id="line-282"> return null;</span>
<span class="source-line-no">283</span><span id="line-283"> }</span>
<span class="source-line-no">284</span><span id="line-284"> });</span>
<span class="source-line-no">285</span><span id="line-285"> }</span>
<span class="source-line-no">286</span><span id="line-286"></span>
<span class="source-line-no">287</span><span id="line-287"> /**</span>
<span class="source-line-no">288</span><span id="line-288"> * Test the case that the time limit for scans is reached in between column families</span>
<span class="source-line-no">289</span><span id="line-289"> */</span>
<span class="source-line-no">290</span><span id="line-290"> @Test</span>
<span class="source-line-no">291</span><span id="line-291"> public void testHeartbeatBetweenColumnFamilies() throws Exception {</span>
<span class="source-line-no">292</span><span id="line-292"> testImportanceOfHeartbeats(new Callable&lt;Void&gt;() {</span>
<span class="source-line-no">293</span><span id="line-293"> @Override</span>
<span class="source-line-no">294</span><span id="line-294"> public Void call() throws Exception {</span>
<span class="source-line-no">295</span><span id="line-295"> // Configure the scan so that it can read the entire table in a single RPC. We want to test</span>
<span class="source-line-no">296</span><span id="line-296"> // the case where a scan stops on the server side due to a time limit</span>
<span class="source-line-no">297</span><span id="line-297"> Scan baseScan = new Scan();</span>
<span class="source-line-no">298</span><span id="line-298"> baseScan.setMaxResultSize(Long.MAX_VALUE);</span>
<span class="source-line-no">299</span><span id="line-299"> baseScan.setCaching(Integer.MAX_VALUE);</span>
<span class="source-line-no">300</span><span id="line-300"></span>
<span class="source-line-no">301</span><span id="line-301"> // Copy the scan before each test. When a scan object is used by a scanner, some of its</span>
<span class="source-line-no">302</span><span id="line-302"> // fields may be changed such as start row</span>
<span class="source-line-no">303</span><span id="line-303"> Scan scanCopy = new Scan(baseScan);</span>
<span class="source-line-no">304</span><span id="line-304"> testEquivalenceOfScanWithHeartbeats(scanCopy, -1, DEFAULT_CF_SLEEP_TIME, false);</span>
<span class="source-line-no">305</span><span id="line-305"> scanCopy = new Scan(baseScan);</span>
<span class="source-line-no">306</span><span id="line-306"> testEquivalenceOfScanWithHeartbeats(scanCopy, -1, DEFAULT_CF_SLEEP_TIME, true);</span>
<span class="source-line-no">307</span><span id="line-307"> return null;</span>
<span class="source-line-no">308</span><span id="line-308"> }</span>
<span class="source-line-no">309</span><span id="line-309"> });</span>
<span class="source-line-no">310</span><span id="line-310"> }</span>
<span class="source-line-no">311</span><span id="line-311"></span>
<span class="source-line-no">312</span><span id="line-312"> public static class SparseCellFilter extends FilterBase {</span>
<span class="source-line-no">313</span><span id="line-313"></span>
<span class="source-line-no">314</span><span id="line-314"> @Override</span>
<span class="source-line-no">315</span><span id="line-315"> public ReturnCode filterCell(final Cell v) throws IOException {</span>
<span class="source-line-no">316</span><span id="line-316"> try {</span>
<span class="source-line-no">317</span><span id="line-317"> Thread.sleep(CLIENT_TIMEOUT / 2 + 100);</span>
<span class="source-line-no">318</span><span id="line-318"> } catch (InterruptedException e) {</span>
<span class="source-line-no">319</span><span id="line-319"> Thread.currentThread().interrupt();</span>
<span class="source-line-no">320</span><span id="line-320"> }</span>
<span class="source-line-no">321</span><span id="line-321"> return Bytes.equals(CellUtil.cloneRow(v), ROWS[NUM_ROWS - 1])</span>
<span class="source-line-no">322</span><span id="line-322"> ? ReturnCode.INCLUDE</span>
<span class="source-line-no">323</span><span id="line-323"> : ReturnCode.SKIP;</span>
<span class="source-line-no">324</span><span id="line-324"> }</span>
<span class="source-line-no">325</span><span id="line-325"></span>
<span class="source-line-no">326</span><span id="line-326"> public static Filter parseFrom(final byte[] pbBytes) {</span>
<span class="source-line-no">327</span><span id="line-327"> return new SparseCellFilter();</span>
<span class="source-line-no">328</span><span id="line-328"> }</span>
<span class="source-line-no">329</span><span id="line-329"> }</span>
<span class="source-line-no">330</span><span id="line-330"></span>
<span class="source-line-no">331</span><span id="line-331"> public static class SparseRowFilter extends FilterBase {</span>
<span class="source-line-no">332</span><span id="line-332"></span>
<span class="source-line-no">333</span><span id="line-333"> @Override</span>
<span class="source-line-no">334</span><span id="line-334"> public boolean filterRowKey(Cell cell) throws IOException {</span>
<span class="source-line-no">335</span><span id="line-335"> try {</span>
<span class="source-line-no">336</span><span id="line-336"> Thread.sleep(CLIENT_TIMEOUT / 2 - 100);</span>
<span class="source-line-no">337</span><span id="line-337"> } catch (InterruptedException e) {</span>
<span class="source-line-no">338</span><span id="line-338"> Thread.currentThread().interrupt();</span>
<span class="source-line-no">339</span><span id="line-339"> }</span>
<span class="source-line-no">340</span><span id="line-340"> return !Bytes.equals(CellUtil.cloneRow(cell), ROWS[NUM_ROWS - 1]);</span>
<span class="source-line-no">341</span><span id="line-341"> }</span>
<span class="source-line-no">342</span><span id="line-342"></span>
<span class="source-line-no">343</span><span id="line-343"> public static Filter parseFrom(final byte[] pbBytes) {</span>
<span class="source-line-no">344</span><span id="line-344"> return new SparseRowFilter();</span>
<span class="source-line-no">345</span><span id="line-345"> }</span>
<span class="source-line-no">346</span><span id="line-346"> }</span>
<span class="source-line-no">347</span><span id="line-347"></span>
<span class="source-line-no">348</span><span id="line-348"> /**</span>
<span class="source-line-no">349</span><span id="line-349"> * Test the case that there is a filter which filters most of cells</span>
<span class="source-line-no">350</span><span id="line-350"> */</span>
<span class="source-line-no">351</span><span id="line-351"> @Test</span>
<span class="source-line-no">352</span><span id="line-352"> public void testHeartbeatWithSparseCellFilter() throws Exception {</span>
<span class="source-line-no">353</span><span id="line-353"> testImportanceOfHeartbeats(new Callable&lt;Void&gt;() {</span>
<span class="source-line-no">354</span><span id="line-354"> @Override</span>
<span class="source-line-no">355</span><span id="line-355"> public Void call() throws Exception {</span>
<span class="source-line-no">356</span><span id="line-356"> Scan scan = new Scan();</span>
<span class="source-line-no">357</span><span id="line-357"> scan.setMaxResultSize(Long.MAX_VALUE);</span>
<span class="source-line-no">358</span><span id="line-358"> scan.setCaching(Integer.MAX_VALUE);</span>
<span class="source-line-no">359</span><span id="line-359"> scan.setFilter(new SparseCellFilter());</span>
<span class="source-line-no">360</span><span id="line-360"> try (ScanPerNextResultScanner scanner =</span>
<span class="source-line-no">361</span><span id="line-361"> new ScanPerNextResultScanner(CONN.getTable(TABLE_NAME), scan)) {</span>
<span class="source-line-no">362</span><span id="line-362"> int num = 0;</span>
<span class="source-line-no">363</span><span id="line-363"> while (scanner.next() != null) {</span>
<span class="source-line-no">364</span><span id="line-364"> num++;</span>
<span class="source-line-no">365</span><span id="line-365"> }</span>
<span class="source-line-no">366</span><span id="line-366"> assertEquals(1, num);</span>
<span class="source-line-no">367</span><span id="line-367"> }</span>
<span class="source-line-no">368</span><span id="line-368"></span>
<span class="source-line-no">369</span><span id="line-369"> scan = new Scan();</span>
<span class="source-line-no">370</span><span id="line-370"> scan.setMaxResultSize(Long.MAX_VALUE);</span>
<span class="source-line-no">371</span><span id="line-371"> scan.setCaching(Integer.MAX_VALUE);</span>
<span class="source-line-no">372</span><span id="line-372"> scan.setFilter(new SparseCellFilter());</span>
<span class="source-line-no">373</span><span id="line-373"> scan.setAllowPartialResults(true);</span>
<span class="source-line-no">374</span><span id="line-374"> try (ScanPerNextResultScanner scanner =</span>
<span class="source-line-no">375</span><span id="line-375"> new ScanPerNextResultScanner(CONN.getTable(TABLE_NAME), scan)) {</span>
<span class="source-line-no">376</span><span id="line-376"> int num = 0;</span>
<span class="source-line-no">377</span><span id="line-377"> while (scanner.next() != null) {</span>
<span class="source-line-no">378</span><span id="line-378"> num++;</span>
<span class="source-line-no">379</span><span id="line-379"> }</span>
<span class="source-line-no">380</span><span id="line-380"> assertEquals(NUM_FAMILIES * NUM_QUALIFIERS, num);</span>
<span class="source-line-no">381</span><span id="line-381"> }</span>
<span class="source-line-no">382</span><span id="line-382"></span>
<span class="source-line-no">383</span><span id="line-383"> return null;</span>
<span class="source-line-no">384</span><span id="line-384"> }</span>
<span class="source-line-no">385</span><span id="line-385"> });</span>
<span class="source-line-no">386</span><span id="line-386"> }</span>
<span class="source-line-no">387</span><span id="line-387"></span>
<span class="source-line-no">388</span><span id="line-388"> /**</span>
<span class="source-line-no">389</span><span id="line-389"> * Test the case that there is a filter which filters most of rows</span>
<span class="source-line-no">390</span><span id="line-390"> */</span>
<span class="source-line-no">391</span><span id="line-391"> @Test</span>
<span class="source-line-no">392</span><span id="line-392"> public void testHeartbeatWithSparseRowFilter() throws Exception {</span>
<span class="source-line-no">393</span><span id="line-393"> testImportanceOfHeartbeats(new Callable&lt;Void&gt;() {</span>
<span class="source-line-no">394</span><span id="line-394"> @Override</span>
<span class="source-line-no">395</span><span id="line-395"> public Void call() throws Exception {</span>
<span class="source-line-no">396</span><span id="line-396"> Scan scan = new Scan();</span>
<span class="source-line-no">397</span><span id="line-397"> scan.setMaxResultSize(Long.MAX_VALUE);</span>
<span class="source-line-no">398</span><span id="line-398"> scan.setCaching(Integer.MAX_VALUE);</span>
<span class="source-line-no">399</span><span id="line-399"> scan.setFilter(new SparseRowFilter());</span>
<span class="source-line-no">400</span><span id="line-400"> try (ScanPerNextResultScanner scanner =</span>
<span class="source-line-no">401</span><span id="line-401"> new ScanPerNextResultScanner(CONN.getTable(TABLE_NAME), scan)) {</span>
<span class="source-line-no">402</span><span id="line-402"> int num = 0;</span>
<span class="source-line-no">403</span><span id="line-403"> while (scanner.next() != null) {</span>
<span class="source-line-no">404</span><span id="line-404"> num++;</span>
<span class="source-line-no">405</span><span id="line-405"> }</span>
<span class="source-line-no">406</span><span id="line-406"> assertEquals(1, num);</span>
<span class="source-line-no">407</span><span id="line-407"> }</span>
<span class="source-line-no">408</span><span id="line-408"></span>
<span class="source-line-no">409</span><span id="line-409"> return null;</span>
<span class="source-line-no">410</span><span id="line-410"> }</span>
<span class="source-line-no">411</span><span id="line-411"> });</span>
<span class="source-line-no">412</span><span id="line-412"> }</span>
<span class="source-line-no">413</span><span id="line-413"></span>
<span class="source-line-no">414</span><span id="line-414"> /**</span>
<span class="source-line-no">415</span><span id="line-415"> * Test the equivalence of a scan versus the same scan executed when heartbeat messages are</span>
<span class="source-line-no">416</span><span id="line-416"> * necessary</span>
<span class="source-line-no">417</span><span id="line-417"> * @param scan The scan configuration being tested</span>
<span class="source-line-no">418</span><span id="line-418"> * @param rowSleepTime The time to sleep between fetches of row cells</span>
<span class="source-line-no">419</span><span id="line-419"> * @param cfSleepTime The time to sleep between fetches of column family cells</span>
<span class="source-line-no">420</span><span id="line-420"> * @param sleepBeforeCf set to true when column family sleeps should occur before the cells for</span>
<span class="source-line-no">421</span><span id="line-421"> * that column family are fetched</span>
<span class="source-line-no">422</span><span id="line-422"> */</span>
<span class="source-line-no">423</span><span id="line-423"> private void testEquivalenceOfScanWithHeartbeats(final Scan scan, int rowSleepTime,</span>
<span class="source-line-no">424</span><span id="line-424"> int cfSleepTime, boolean sleepBeforeCf) throws Exception {</span>
<span class="source-line-no">425</span><span id="line-425"> disableSleeping();</span>
<span class="source-line-no">426</span><span id="line-426"> AsyncTable&lt;AdvancedScanResultConsumer&gt; table = CONN.getTable(TABLE_NAME);</span>
<span class="source-line-no">427</span><span id="line-427"> final ResultScanner scanner = new ScanPerNextResultScanner(table, scan);</span>
<span class="source-line-no">428</span><span id="line-428"> final ResultScanner scannerWithHeartbeats = new ScanPerNextResultScanner(table, scan);</span>
<span class="source-line-no">429</span><span id="line-429"></span>
<span class="source-line-no">430</span><span id="line-430"> Result r1 = null;</span>
<span class="source-line-no">431</span><span id="line-431"> Result r2 = null;</span>
<span class="source-line-no">432</span><span id="line-432"></span>
<span class="source-line-no">433</span><span id="line-433"> while ((r1 = scanner.next()) != null) {</span>
<span class="source-line-no">434</span><span id="line-434"> // Enforce the specified sleep conditions during calls to the heartbeat scanner</span>
<span class="source-line-no">435</span><span id="line-435"> configureSleepTime(rowSleepTime, cfSleepTime, sleepBeforeCf);</span>
<span class="source-line-no">436</span><span id="line-436"> r2 = scannerWithHeartbeats.next();</span>
<span class="source-line-no">437</span><span id="line-437"> disableSleeping();</span>
<span class="source-line-no">438</span><span id="line-438"></span>
<span class="source-line-no">439</span><span id="line-439"> assertTrue(r2 != null);</span>
<span class="source-line-no">440</span><span id="line-440"> try {</span>
<span class="source-line-no">441</span><span id="line-441"> Result.compareResults(r1, r2);</span>
<span class="source-line-no">442</span><span id="line-442"> } catch (Exception e) {</span>
<span class="source-line-no">443</span><span id="line-443"> fail(e.getMessage());</span>
<span class="source-line-no">444</span><span id="line-444"> }</span>
<span class="source-line-no">445</span><span id="line-445"> }</span>
<span class="source-line-no">446</span><span id="line-446"></span>
<span class="source-line-no">447</span><span id="line-447"> assertTrue(scannerWithHeartbeats.next() == null);</span>
<span class="source-line-no">448</span><span id="line-448"> scanner.close();</span>
<span class="source-line-no">449</span><span id="line-449"> scannerWithHeartbeats.close();</span>
<span class="source-line-no">450</span><span id="line-450"> }</span>
<span class="source-line-no">451</span><span id="line-451"></span>
<span class="source-line-no">452</span><span id="line-452"> /**</span>
<span class="source-line-no">453</span><span id="line-453"> * Helper method for setting the time to sleep between rows and column families. If a sleep time</span>
<span class="source-line-no">454</span><span id="line-454"> * is negative then that sleep will be disabled</span>
<span class="source-line-no">455</span><span id="line-455"> */</span>
<span class="source-line-no">456</span><span id="line-456"> private static void configureSleepTime(int rowSleepTime, int cfSleepTime, boolean sleepBeforeCf) {</span>
<span class="source-line-no">457</span><span id="line-457"> HeartbeatHRegion.sleepBetweenRows = rowSleepTime &gt; 0;</span>
<span class="source-line-no">458</span><span id="line-458"> HeartbeatHRegion.rowSleepTime = rowSleepTime;</span>
<span class="source-line-no">459</span><span id="line-459"></span>
<span class="source-line-no">460</span><span id="line-460"> HeartbeatHRegion.sleepBetweenColumnFamilies = cfSleepTime &gt; 0;</span>
<span class="source-line-no">461</span><span id="line-461"> HeartbeatHRegion.columnFamilySleepTime = cfSleepTime;</span>
<span class="source-line-no">462</span><span id="line-462"> HeartbeatHRegion.sleepBeforeColumnFamily = sleepBeforeCf;</span>
<span class="source-line-no">463</span><span id="line-463"> }</span>
<span class="source-line-no">464</span><span id="line-464"></span>
<span class="source-line-no">465</span><span id="line-465"> /**</span>
<span class="source-line-no">466</span><span id="line-466"> * Disable the sleeping mechanism server side.</span>
<span class="source-line-no">467</span><span id="line-467"> */</span>
<span class="source-line-no">468</span><span id="line-468"> private static void disableSleeping() {</span>
<span class="source-line-no">469</span><span id="line-469"> HeartbeatHRegion.sleepBetweenRows = false;</span>
<span class="source-line-no">470</span><span id="line-470"> HeartbeatHRegion.sleepBetweenColumnFamilies = false;</span>
<span class="source-line-no">471</span><span id="line-471"> }</span>
<span class="source-line-no">472</span><span id="line-472"></span>
<span class="source-line-no">473</span><span id="line-473"> /**</span>
<span class="source-line-no">474</span><span id="line-474"> * Custom HRegionServer instance that instantiates {@link HeartbeatRPCServices} in place of</span>
<span class="source-line-no">475</span><span id="line-475"> * {@link RSRpcServices} to allow us to toggle support for heartbeat messages</span>
<span class="source-line-no">476</span><span id="line-476"> */</span>
<span class="source-line-no">477</span><span id="line-477"> private static class HeartbeatHRegionServer extends HRegionServer {</span>
<span class="source-line-no">478</span><span id="line-478"> public HeartbeatHRegionServer(Configuration conf) throws IOException, InterruptedException {</span>
<span class="source-line-no">479</span><span id="line-479"> super(conf);</span>
<span class="source-line-no">480</span><span id="line-480"> }</span>
<span class="source-line-no">481</span><span id="line-481"></span>
<span class="source-line-no">482</span><span id="line-482"> @Override</span>
<span class="source-line-no">483</span><span id="line-483"> protected RSRpcServices createRpcServices() throws IOException {</span>
<span class="source-line-no">484</span><span id="line-484"> return new HeartbeatRPCServices(this);</span>
<span class="source-line-no">485</span><span id="line-485"> }</span>
<span class="source-line-no">486</span><span id="line-486"> }</span>
<span class="source-line-no">487</span><span id="line-487"></span>
<span class="source-line-no">488</span><span id="line-488"> /**</span>
<span class="source-line-no">489</span><span id="line-489"> * Custom RSRpcServices instance that allows heartbeat support to be toggled</span>
<span class="source-line-no">490</span><span id="line-490"> */</span>
<span class="source-line-no">491</span><span id="line-491"> private static class HeartbeatRPCServices extends RSRpcServices {</span>
<span class="source-line-no">492</span><span id="line-492"> private static volatile boolean heartbeatsEnabled = true;</span>
<span class="source-line-no">493</span><span id="line-493"></span>
<span class="source-line-no">494</span><span id="line-494"> public HeartbeatRPCServices(HRegionServer rs) throws IOException {</span>
<span class="source-line-no">495</span><span id="line-495"> super(rs);</span>
<span class="source-line-no">496</span><span id="line-496"> }</span>
<span class="source-line-no">497</span><span id="line-497"></span>
<span class="source-line-no">498</span><span id="line-498"> @Override</span>
<span class="source-line-no">499</span><span id="line-499"> public ScanResponse scan(RpcController controller, ScanRequest request)</span>
<span class="source-line-no">500</span><span id="line-500"> throws ServiceException {</span>
<span class="source-line-no">501</span><span id="line-501"> ScanRequest.Builder builder = ScanRequest.newBuilder(request);</span>
<span class="source-line-no">502</span><span id="line-502"> builder.setClientHandlesHeartbeats(heartbeatsEnabled);</span>
<span class="source-line-no">503</span><span id="line-503"> return super.scan(controller, builder.build());</span>
<span class="source-line-no">504</span><span id="line-504"> }</span>
<span class="source-line-no">505</span><span id="line-505"> }</span>
<span class="source-line-no">506</span><span id="line-506"></span>
<span class="source-line-no">507</span><span id="line-507"> /**</span>
<span class="source-line-no">508</span><span id="line-508"> * Custom HRegion class that instantiates {@link RegionScanner}s with configurable sleep times</span>
<span class="source-line-no">509</span><span id="line-509"> * between fetches of row Results and/or column family cells. Useful for emulating an instance</span>
<span class="source-line-no">510</span><span id="line-510"> * where the server is taking a long time to process a client's scan request</span>
<span class="source-line-no">511</span><span id="line-511"> */</span>
<span class="source-line-no">512</span><span id="line-512"> private static class HeartbeatHRegion extends HRegion {</span>
<span class="source-line-no">513</span><span id="line-513"> // Row sleeps occur AFTER each row worth of cells is retrieved.</span>
<span class="source-line-no">514</span><span id="line-514"> private static volatile int rowSleepTime = DEFAULT_ROW_SLEEP_TIME;</span>
<span class="source-line-no">515</span><span id="line-515"> private static volatile boolean sleepBetweenRows = false;</span>
<span class="source-line-no">516</span><span id="line-516"></span>
<span class="source-line-no">517</span><span id="line-517"> // The sleep for column families can be initiated before or after we fetch the cells for the</span>
<span class="source-line-no">518</span><span id="line-518"> // column family. If the sleep occurs BEFORE then the time limits will be reached inside</span>
<span class="source-line-no">519</span><span id="line-519"> // StoreScanner while we are fetching individual cells. If the sleep occurs AFTER then the time</span>
<span class="source-line-no">520</span><span id="line-520"> // limit will be reached inside RegionScanner after all the cells for a column family have been</span>
<span class="source-line-no">521</span><span id="line-521"> // retrieved.</span>
<span class="source-line-no">522</span><span id="line-522"> private static volatile boolean sleepBeforeColumnFamily = false;</span>
<span class="source-line-no">523</span><span id="line-523"> private static volatile int columnFamilySleepTime = DEFAULT_CF_SLEEP_TIME;</span>
<span class="source-line-no">524</span><span id="line-524"> private static volatile boolean sleepBetweenColumnFamilies = false;</span>
<span class="source-line-no">525</span><span id="line-525"></span>
<span class="source-line-no">526</span><span id="line-526"> public HeartbeatHRegion(Path tableDir, WAL wal, FileSystem fs, Configuration confParam,</span>
<span class="source-line-no">527</span><span id="line-527"> RegionInfo regionInfo, TableDescriptor htd, RegionServerServices rsServices) {</span>
<span class="source-line-no">528</span><span id="line-528"> super(tableDir, wal, fs, confParam, regionInfo, htd, rsServices);</span>
<span class="source-line-no">529</span><span id="line-529"> }</span>
<span class="source-line-no">530</span><span id="line-530"></span>
<span class="source-line-no">531</span><span id="line-531"> public HeartbeatHRegion(HRegionFileSystem fs, WAL wal, Configuration confParam,</span>
<span class="source-line-no">532</span><span id="line-532"> TableDescriptor htd, RegionServerServices rsServices) {</span>
<span class="source-line-no">533</span><span id="line-533"> super(fs, wal, confParam, htd, rsServices);</span>
<span class="source-line-no">534</span><span id="line-534"> }</span>
<span class="source-line-no">535</span><span id="line-535"></span>
<span class="source-line-no">536</span><span id="line-536"> private static void columnFamilySleep() {</span>
<span class="source-line-no">537</span><span id="line-537"> if (sleepBetweenColumnFamilies) {</span>
<span class="source-line-no">538</span><span id="line-538"> Threads.sleepWithoutInterrupt(columnFamilySleepTime);</span>
<span class="source-line-no">539</span><span id="line-539"> }</span>
<span class="source-line-no">540</span><span id="line-540"> }</span>
<span class="source-line-no">541</span><span id="line-541"></span>
<span class="source-line-no">542</span><span id="line-542"> private static void rowSleep() {</span>
<span class="source-line-no">543</span><span id="line-543"> if (sleepBetweenRows) {</span>
<span class="source-line-no">544</span><span id="line-544"> Threads.sleepWithoutInterrupt(rowSleepTime);</span>
<span class="source-line-no">545</span><span id="line-545"> }</span>
<span class="source-line-no">546</span><span id="line-546"> }</span>
<span class="source-line-no">547</span><span id="line-547"></span>
<span class="source-line-no">548</span><span id="line-548"> // Instantiate the custom heartbeat region scanners</span>
<span class="source-line-no">549</span><span id="line-549"> @Override</span>
<span class="source-line-no">550</span><span id="line-550"> protected RegionScannerImpl instantiateRegionScanner(Scan scan,</span>
<span class="source-line-no">551</span><span id="line-551"> List&lt;KeyValueScanner&gt; additionalScanners, long nonceGroup, long nonce) throws IOException {</span>
<span class="source-line-no">552</span><span id="line-552"> if (scan.isReversed()) {</span>
<span class="source-line-no">553</span><span id="line-553"> if (scan.getFilter() != null) {</span>
<span class="source-line-no">554</span><span id="line-554"> scan.getFilter().setReversed(true);</span>
<span class="source-line-no">555</span><span id="line-555"> }</span>
<span class="source-line-no">556</span><span id="line-556"> return new HeartbeatReversedRegionScanner(scan, additionalScanners, this);</span>
<span class="source-line-no">557</span><span id="line-557"> }</span>
<span class="source-line-no">558</span><span id="line-558"> return new HeartbeatRegionScanner(scan, additionalScanners, this);</span>
<span class="source-line-no">559</span><span id="line-559"> }</span>
<span class="source-line-no">560</span><span id="line-560"> }</span>
<span class="source-line-no">561</span><span id="line-561"></span>
<span class="source-line-no">562</span><span id="line-562"> /**</span>
<span class="source-line-no">563</span><span id="line-563"> * Custom ReversedRegionScanner that can be configured to sleep between retrievals of row Results</span>
<span class="source-line-no">564</span><span id="line-564"> * and/or column family cells</span>
<span class="source-line-no">565</span><span id="line-565"> */</span>
<span class="source-line-no">566</span><span id="line-566"> private static class HeartbeatReversedRegionScanner extends ReversedRegionScannerImpl {</span>
<span class="source-line-no">567</span><span id="line-567"> HeartbeatReversedRegionScanner(Scan scan, List&lt;KeyValueScanner&gt; additionalScanners,</span>
<span class="source-line-no">568</span><span id="line-568"> HRegion region) throws IOException {</span>
<span class="source-line-no">569</span><span id="line-569"> super(scan, additionalScanners, region, HConstants.NO_NONCE, HConstants.NO_NONCE);</span>
<span class="source-line-no">570</span><span id="line-570"> }</span>
<span class="source-line-no">571</span><span id="line-571"></span>
<span class="source-line-no">572</span><span id="line-572"> @Override</span>
<span class="source-line-no">573</span><span id="line-573"> public boolean nextRaw(List&lt;? super ExtendedCell&gt; outResults, ScannerContext context)</span>
<span class="source-line-no">574</span><span id="line-574"> throws IOException {</span>
<span class="source-line-no">575</span><span id="line-575"> boolean moreRows = super.nextRaw(outResults, context);</span>
<span class="source-line-no">576</span><span id="line-576"> HeartbeatHRegion.rowSleep();</span>
<span class="source-line-no">577</span><span id="line-577"> return moreRows;</span>
<span class="source-line-no">578</span><span id="line-578"> }</span>
<span class="source-line-no">579</span><span id="line-579"></span>
<span class="source-line-no">580</span><span id="line-580"> @Override</span>
<span class="source-line-no">581</span><span id="line-581"> protected void initializeKVHeap(List&lt;KeyValueScanner&gt; scanners,</span>
<span class="source-line-no">582</span><span id="line-582"> List&lt;KeyValueScanner&gt; joinedScanners, HRegion region) throws IOException {</span>
<span class="source-line-no">583</span><span id="line-583"> this.storeHeap =</span>
<span class="source-line-no">584</span><span id="line-584"> new HeartbeatReversedKVHeap(scanners, (CellComparatorImpl) region.getCellComparator());</span>
<span class="source-line-no">585</span><span id="line-585"> if (!joinedScanners.isEmpty()) {</span>
<span class="source-line-no">586</span><span id="line-586"> this.joinedHeap = new HeartbeatReversedKVHeap(joinedScanners,</span>
<span class="source-line-no">587</span><span id="line-587"> (CellComparatorImpl) region.getCellComparator());</span>
<span class="source-line-no">588</span><span id="line-588"> }</span>
<span class="source-line-no">589</span><span id="line-589"> }</span>
<span class="source-line-no">590</span><span id="line-590"> }</span>
<span class="source-line-no">591</span><span id="line-591"></span>
<span class="source-line-no">592</span><span id="line-592"> /**</span>
<span class="source-line-no">593</span><span id="line-593"> * Custom RegionScanner that can be configured to sleep between retrievals of row Results and/or</span>
<span class="source-line-no">594</span><span id="line-594"> * column family cells</span>
<span class="source-line-no">595</span><span id="line-595"> */</span>
<span class="source-line-no">596</span><span id="line-596"> private static class HeartbeatRegionScanner extends RegionScannerImpl {</span>
<span class="source-line-no">597</span><span id="line-597"> HeartbeatRegionScanner(Scan scan, List&lt;KeyValueScanner&gt; additionalScanners, HRegion region)</span>
<span class="source-line-no">598</span><span id="line-598"> throws IOException {</span>
<span class="source-line-no">599</span><span id="line-599"> super(scan, additionalScanners, region, HConstants.NO_NONCE, HConstants.NO_NONCE);</span>
<span class="source-line-no">600</span><span id="line-600"> }</span>
<span class="source-line-no">601</span><span id="line-601"></span>
<span class="source-line-no">602</span><span id="line-602"> @Override</span>
<span class="source-line-no">603</span><span id="line-603"> public boolean nextRaw(List&lt;? super ExtendedCell&gt; outResults, ScannerContext context)</span>
<span class="source-line-no">604</span><span id="line-604"> throws IOException {</span>
<span class="source-line-no">605</span><span id="line-605"> boolean moreRows = super.nextRaw(outResults, context);</span>
<span class="source-line-no">606</span><span id="line-606"> HeartbeatHRegion.rowSleep();</span>
<span class="source-line-no">607</span><span id="line-607"> return moreRows;</span>
<span class="source-line-no">608</span><span id="line-608"> }</span>
<span class="source-line-no">609</span><span id="line-609"></span>
<span class="source-line-no">610</span><span id="line-610"> @Override</span>
<span class="source-line-no">611</span><span id="line-611"> protected void initializeKVHeap(List&lt;KeyValueScanner&gt; scanners,</span>
<span class="source-line-no">612</span><span id="line-612"> List&lt;KeyValueScanner&gt; joinedScanners, HRegion region) throws IOException {</span>
<span class="source-line-no">613</span><span id="line-613"> this.storeHeap = new HeartbeatKVHeap(scanners, region.getCellComparator());</span>
<span class="source-line-no">614</span><span id="line-614"> if (!joinedScanners.isEmpty()) {</span>
<span class="source-line-no">615</span><span id="line-615"> this.joinedHeap = new HeartbeatKVHeap(joinedScanners, region.getCellComparator());</span>
<span class="source-line-no">616</span><span id="line-616"> }</span>
<span class="source-line-no">617</span><span id="line-617"> }</span>
<span class="source-line-no">618</span><span id="line-618"> }</span>
<span class="source-line-no">619</span><span id="line-619"></span>
<span class="source-line-no">620</span><span id="line-620"> /**</span>
<span class="source-line-no">621</span><span id="line-621"> * Custom KV Heap that can be configured to sleep/wait in between retrievals of column family</span>
<span class="source-line-no">622</span><span id="line-622"> * cells. Useful for testing</span>
<span class="source-line-no">623</span><span id="line-623"> */</span>
<span class="source-line-no">624</span><span id="line-624"> private static final class HeartbeatKVHeap extends KeyValueHeap {</span>
<span class="source-line-no">625</span><span id="line-625"> public HeartbeatKVHeap(List&lt;? extends KeyValueScanner&gt; scanners, CellComparator comparator)</span>
<span class="source-line-no">626</span><span id="line-626"> throws IOException {</span>
<span class="source-line-no">627</span><span id="line-627"> super(scanners, comparator);</span>
<span class="source-line-no">628</span><span id="line-628"> }</span>
<span class="source-line-no">629</span><span id="line-629"></span>
<span class="source-line-no">630</span><span id="line-630"> HeartbeatKVHeap(List&lt;? extends KeyValueScanner&gt; scanners, KVScannerComparator comparator)</span>
<span class="source-line-no">631</span><span id="line-631"> throws IOException {</span>
<span class="source-line-no">632</span><span id="line-632"> super(scanners, comparator);</span>
<span class="source-line-no">633</span><span id="line-633"> }</span>
<span class="source-line-no">634</span><span id="line-634"></span>
<span class="source-line-no">635</span><span id="line-635"> @Override</span>
<span class="source-line-no">636</span><span id="line-636"> public boolean next(List&lt;? super ExtendedCell&gt; result, ScannerContext context)</span>
<span class="source-line-no">637</span><span id="line-637"> throws IOException {</span>
<span class="source-line-no">638</span><span id="line-638"> if (HeartbeatHRegion.sleepBeforeColumnFamily) HeartbeatHRegion.columnFamilySleep();</span>
<span class="source-line-no">639</span><span id="line-639"> boolean moreRows = super.next(result, context);</span>
<span class="source-line-no">640</span><span id="line-640"> if (!HeartbeatHRegion.sleepBeforeColumnFamily) HeartbeatHRegion.columnFamilySleep();</span>
<span class="source-line-no">641</span><span id="line-641"> return moreRows;</span>
<span class="source-line-no">642</span><span id="line-642"> }</span>
<span class="source-line-no">643</span><span id="line-643"> }</span>
<span class="source-line-no">644</span><span id="line-644"></span>
<span class="source-line-no">645</span><span id="line-645"> /**</span>
<span class="source-line-no">646</span><span id="line-646"> * Custom reversed KV Heap that can be configured to sleep in between retrievals of column family</span>
<span class="source-line-no">647</span><span id="line-647"> * cells.</span>
<span class="source-line-no">648</span><span id="line-648"> */</span>
<span class="source-line-no">649</span><span id="line-649"> private static final class HeartbeatReversedKVHeap extends ReversedKeyValueHeap {</span>
<span class="source-line-no">650</span><span id="line-650"> public HeartbeatReversedKVHeap(List&lt;? extends KeyValueScanner&gt; scanners,</span>
<span class="source-line-no">651</span><span id="line-651"> CellComparatorImpl comparator) throws IOException {</span>
<span class="source-line-no">652</span><span id="line-652"> super(scanners, comparator);</span>
<span class="source-line-no">653</span><span id="line-653"> }</span>
<span class="source-line-no">654</span><span id="line-654"></span>
<span class="source-line-no">655</span><span id="line-655"> @Override</span>
<span class="source-line-no">656</span><span id="line-656"> public boolean next(List&lt;? super ExtendedCell&gt; result, ScannerContext context)</span>
<span class="source-line-no">657</span><span id="line-657"> throws IOException {</span>
<span class="source-line-no">658</span><span id="line-658"> if (HeartbeatHRegion.sleepBeforeColumnFamily) HeartbeatHRegion.columnFamilySleep();</span>
<span class="source-line-no">659</span><span id="line-659"> boolean moreRows = super.next(result, context);</span>
<span class="source-line-no">660</span><span id="line-660"> if (!HeartbeatHRegion.sleepBeforeColumnFamily) HeartbeatHRegion.columnFamilySleep();</span>
<span class="source-line-no">661</span><span id="line-661"> return moreRows;</span>
<span class="source-line-no">662</span><span id="line-662"> }</span>
<span class="source-line-no">663</span><span id="line-663"> }</span>
<span class="source-line-no">664</span><span id="line-664">}</span>
</pre>
</div>
</main>
</body>
</html>