Google Git
Sign in
apache / hbase-site / f815b613f85fa10e80af017d1f88aaa9d343dd85 / . / testdevapidocs / src-html / org / apache / hadoop / hbase / regionserver / TestScannerTimeoutHandling.RegionServerWithScanTimeout.html
blob: 6528103d5c1a766f42c82629d508447f473bd9bc [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.regionserver;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.junit.Assert.assertEquals;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.junit.Assert.assertTrue;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.TimeUnit;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.locks.Lock;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.locks.ReentrantLock;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.conf.Configuration;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.CompatibilityFactory;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HBaseTestingUtil;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.HConstants;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.SingleProcessHBaseCluster;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.TableName;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.client.ConnectionFactory;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.client.Put;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.client.ResultScanner;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.client.RetriesExhaustedException;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.Table;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.exceptions.ScannerResetException;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.exceptions.TimeoutIOException;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.ipc.CallTimeoutException;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.test.MetricsAssertHelper;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.testclassification.MediumTests;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.testclassification.RegionServerTests;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.junit.AfterClass;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.junit.BeforeClass;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.junit.ClassRule;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.junit.Rule;<a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.junit.Test;<a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.junit.experimental.categories.Category;<a name="line.53"></a>
<span class="sourceLineNo">054</span>import org.junit.rules.TestName;<a name="line.54"></a>
<span class="sourceLineNo">055</span>import org.slf4j.Logger;<a name="line.55"></a>
<span class="sourceLineNo">056</span>import org.slf4j.LoggerFactory;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>import org.apache.hbase.thirdparty.com.google.protobuf.RpcController;<a name="line.58"></a>
<span class="sourceLineNo">059</span>import org.apache.hbase.thirdparty.com.google.protobuf.ServiceException;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span>@Category({ RegionServerTests.class, MediumTests.class })<a name="line.63"></a>
<span class="sourceLineNo">064</span>public class TestScannerTimeoutHandling {<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> private static final Logger LOG = LoggerFactory.getLogger(TestScannerTimeoutHandling.class);<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> @ClassRule<a name="line.68"></a>
<span class="sourceLineNo">069</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.69"></a>
<span class="sourceLineNo">070</span> HBaseClassTestRule.forClass(TestScannerTimeoutHandling.class);<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> private static final HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();<a name="line.72"></a>
<span class="sourceLineNo">073</span> private static final MetricsAssertHelper METRICS_ASSERT =<a name="line.73"></a>
<span class="sourceLineNo">074</span> CompatibilityFactory.getInstance(MetricsAssertHelper.class);<a name="line.74"></a>
<span class="sourceLineNo">075</span> private static final int TIMEOUT = 3000;<a name="line.75"></a>
<span class="sourceLineNo">076</span> private static final TableName TABLE_NAME = TableName.valueOf("foo");<a name="line.76"></a>
<span class="sourceLineNo">077</span> private static Connection CONN;<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> @Rule<a name="line.79"></a>
<span class="sourceLineNo">080</span> public TestName name = new TestName();<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> @BeforeClass<a name="line.82"></a>
<span class="sourceLineNo">083</span> public static void setUpBeforeClass() throws Exception {<a name="line.83"></a>
<span class="sourceLineNo">084</span> Configuration conf = TEST_UTIL.getConfiguration();<a name="line.84"></a>
<span class="sourceLineNo">085</span> // Don't report so often so easier to see other rpcs<a name="line.85"></a>
<span class="sourceLineNo">086</span> conf.setInt("hbase.regionserver.msginterval", 3 * 10000);<a name="line.86"></a>
<span class="sourceLineNo">087</span> conf.setInt(HConstants.HBASE_RPC_TIMEOUT_KEY, TIMEOUT);<a name="line.87"></a>
<span class="sourceLineNo">088</span> // conf.setInt(HConstants.HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD, TIMEOUT);<a name="line.88"></a>
<span class="sourceLineNo">089</span> conf.setStrings(HConstants.REGION_SERVER_IMPL, RegionServerWithScanTimeout.class.getName());<a name="line.89"></a>
<span class="sourceLineNo">090</span> conf.setInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 0);<a name="line.90"></a>
<span class="sourceLineNo">091</span> TEST_UTIL.startMiniCluster(1);<a name="line.91"></a>
<span class="sourceLineNo">092</span> TEST_UTIL.createTable(TABLE_NAME, "0");<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> CONN = ConnectionFactory.createConnection(conf);<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> @AfterClass<a name="line.97"></a>
<span class="sourceLineNo">098</span> public static void tearDownAfterClass() throws Exception {<a name="line.98"></a>
<span class="sourceLineNo">099</span> CONN.close();<a name="line.99"></a>
<span class="sourceLineNo">100</span> TEST_UTIL.shutdownMiniCluster();<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> /**<a name="line.103"></a>
<span class="sourceLineNo">104</span> * If a client's timeout would be exceeded before scan results are ready, there is no point<a name="line.104"></a>
<span class="sourceLineNo">105</span> * returning results to the client. Worse, for openScanner calls, the client cannot close the<a name="line.105"></a>
<span class="sourceLineNo">106</span> * timed out scanner so this leaks scanners on the server. This test verifies that we properly<a name="line.106"></a>
<span class="sourceLineNo">107</span> * track and cleanup scanners when a client timeout is exceeded. This should be more rare when<a name="line.107"></a>
<span class="sourceLineNo">108</span> * heartbeats are enabled, since we try to return before timeout there. But it's still possible if<a name="line.108"></a>
<span class="sourceLineNo">109</span> * queueing eats up most of the timeout or the inner workings of the scan were slowed down enough<a name="line.109"></a>
<span class="sourceLineNo">110</span> * to still exceed the timeout despite the calculated heartbeat deadline.<a name="line.110"></a>
<span class="sourceLineNo">111</span> */<a name="line.111"></a>
<span class="sourceLineNo">112</span> @Test<a name="line.112"></a>
<span class="sourceLineNo">113</span> public void testExceededClientDeadline() throws Exception {<a name="line.113"></a>
<span class="sourceLineNo">114</span> Table table = CONN.getTable(TABLE_NAME);<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> // put some rows so that our scanner doesn't complete on the first rpc.<a name="line.116"></a>
<span class="sourceLineNo">117</span> // this would prematurely close the scanner before the timeout handling has a chance to<a name="line.117"></a>
<span class="sourceLineNo">118</span> for (int i = 0; i &lt; 10; i++) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> table.put(new Put(Bytes.toBytes(i)).addColumn(new byte[] { '0' }, new byte[] { '0' },<a name="line.119"></a>
<span class="sourceLineNo">120</span> new byte[] { '0' }));<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> try {<a name="line.123"></a>
<span class="sourceLineNo">124</span> ResultScanner scanner = table.getScanner(new Scan().setCaching(1).setMaxResultSize(1));<a name="line.124"></a>
<span class="sourceLineNo">125</span> scanner.next();<a name="line.125"></a>
<span class="sourceLineNo">126</span> } catch (RetriesExhaustedException e) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> assertTrue(e.getCause() instanceof CallTimeoutException);<a name="line.127"></a>
<span class="sourceLineNo">128</span> } finally {<a name="line.128"></a>
<span class="sourceLineNo">129</span> // ensure the scan has finished on the server side<a name="line.129"></a>
<span class="sourceLineNo">130</span> RSRpcServicesWithScanTimeout.lock.tryLock(60, TimeUnit.SECONDS);<a name="line.130"></a>
<span class="sourceLineNo">131</span> // there should be 0 running scanners, meaning the scanner was properly closed on the server<a name="line.131"></a>
<span class="sourceLineNo">132</span> assertEquals(0, RSRpcServicesWithScanTimeout.scannerCount);<a name="line.132"></a>
<span class="sourceLineNo">133</span> // we should have caught the expected exception<a name="line.133"></a>
<span class="sourceLineNo">134</span> assertTrue(RSRpcServicesWithScanTimeout.caughtTimeoutException);<a name="line.134"></a>
<span class="sourceLineNo">135</span> // we should have incremented the callTimedOut metric<a name="line.135"></a>
<span class="sourceLineNo">136</span> METRICS_ASSERT.assertCounterGt("exceptions.callTimedOut", 0, TEST_UTIL.getHBaseCluster()<a name="line.136"></a>
<span class="sourceLineNo">137</span> .getRegionServer(0).getRpcServer().getMetrics().getMetricsSource());<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> private static class RegionServerWithScanTimeout<a name="line.141"></a>
<span class="sourceLineNo">142</span> extends SingleProcessHBaseCluster.MiniHBaseClusterRegionServer {<a name="line.142"></a>
<span class="sourceLineNo">143</span> public RegionServerWithScanTimeout(Configuration conf)<a name="line.143"></a>
<span class="sourceLineNo">144</span> throws IOException, InterruptedException {<a name="line.144"></a>
<span class="sourceLineNo">145</span> super(conf);<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> @Override<a name="line.148"></a>
<span class="sourceLineNo">149</span> protected RSRpcServices createRpcServices() throws IOException {<a name="line.149"></a>
<span class="sourceLineNo">150</span> return new RSRpcServicesWithScanTimeout(this);<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> private static class RSRpcServicesWithScanTimeout extends RSRpcServices {<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> private static boolean caughtTimeoutException = false;<a name="line.156"></a>
<span class="sourceLineNo">157</span> private static int scannerCount = -1;<a name="line.157"></a>
<span class="sourceLineNo">158</span> private static final Lock lock = new ReentrantLock();<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> public RSRpcServicesWithScanTimeout(HRegionServer rs) throws IOException {<a name="line.160"></a>
<span class="sourceLineNo">161</span> super(rs);<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> @Override<a name="line.164"></a>
<span class="sourceLineNo">165</span> public ClientProtos.ScanResponse scan(final RpcController controller,<a name="line.165"></a>
<span class="sourceLineNo">166</span> final ClientProtos.ScanRequest request) throws ServiceException {<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> String regionName = Bytes.toString(request.getRegion().getValue().toByteArray());<a name="line.168"></a>
<span class="sourceLineNo">169</span> if (regionName.contains(TABLE_NAME.getNameAsString())) {<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> // if the client's timeout is exceeded, it may either retry or attempt to close<a name="line.171"></a>
<span class="sourceLineNo">172</span> // the scanner. we don't want to allow either until we've verified the server handling.<a name="line.172"></a>
<span class="sourceLineNo">173</span> // so only allow 1 request at a time to our test table<a name="line.173"></a>
<span class="sourceLineNo">174</span> try {<a name="line.174"></a>
<span class="sourceLineNo">175</span> if (!lock.tryLock(60, TimeUnit.SECONDS)) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> throw new ServiceException("Failed to get lock");<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span> } catch (InterruptedException e) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> throw new ServiceException(e);<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> try {<a name="line.182"></a>
<span class="sourceLineNo">183</span> LOG.info("SLEEPING");<a name="line.183"></a>
<span class="sourceLineNo">184</span> Thread.sleep(TIMEOUT * 2);<a name="line.184"></a>
<span class="sourceLineNo">185</span> } catch (Exception e) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> try {<a name="line.188"></a>
<span class="sourceLineNo">189</span> return super.scan(controller, request);<a name="line.189"></a>
<span class="sourceLineNo">190</span> } catch (ServiceException e) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> if (<a name="line.191"></a>
<span class="sourceLineNo">192</span> e.getCause() instanceof ScannerResetException<a name="line.192"></a>
<span class="sourceLineNo">193</span> &amp;&amp; e.getCause().getCause() instanceof TimeoutIOException<a name="line.193"></a>
<span class="sourceLineNo">194</span> ) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> LOG.info("caught EXPECTED exception in scan after sleep", e);<a name="line.195"></a>
<span class="sourceLineNo">196</span> caughtTimeoutException = true;<a name="line.196"></a>
<span class="sourceLineNo">197</span> } else {<a name="line.197"></a>
<span class="sourceLineNo">198</span> LOG.warn("caught UNEXPECTED exception in scan after sleep", e);<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span> } finally {<a name="line.200"></a>
<span class="sourceLineNo">201</span> scannerCount = getScannersCount();<a name="line.201"></a>
<span class="sourceLineNo">202</span> lock.unlock();<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span> return super.scan(controller, request);<a name="line.206"></a>
<span class="sourceLineNo">207</span><a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span>}<a name="line.210"></a>
</pre>
</div>
</body>
</html>