Google Git
Sign in
apache / hbase-site / edc9f41ac5957af2e574b6068b2bdf77baaf06cd / . / devapidocs / src-html / org / apache / hadoop / hbase / client / AsyncRpcRetryingCaller.html
blob: ac7705683608dd8d5a67a0643601926c81f7ab76 [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.client;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.apache.hadoop.hbase.client.ConnectionUtils.resetController;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.apache.hadoop.hbase.client.ConnectionUtils.translateException;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Optional;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.OptionalLong;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.concurrent.CompletableFuture;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.concurrent.TimeUnit;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.function.Consumer;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.function.Supplier;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.HBaseServerException;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.NotServingRegionException;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.TableName;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.TableNotEnabledException;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.TableNotFoundException;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.client.backoff.HBaseServerExceptionPauseManager;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.exceptions.ScannerResetException;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.ipc.HBaseRpcController;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.util.FutureUtils;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.slf4j.Logger;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.slf4j.LoggerFactory;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hbase.thirdparty.io.netty.util.Timer;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>@InterfaceAudience.Private<a name="line.49"></a>
<span class="sourceLineNo">050</span>public abstract class AsyncRpcRetryingCaller&lt;T&gt; {<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private static final Logger LOG = LoggerFactory.getLogger(AsyncRpcRetryingCaller.class);<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> private final Timer retryTimer;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> private final int priority;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> private final long startNs;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> private int tries = 1;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> private final int maxAttempts;<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> private final int startLogErrorsCnt;<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> private final List&lt;RetriesExhaustedException.ThrowableWithExtraContext&gt; exceptions;<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> private final long rpcTimeoutNs;<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> protected final long operationTimeoutNs;<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> protected final AsyncConnectionImpl conn;<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> protected final CompletableFuture&lt;T&gt; future;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> protected final HBaseRpcController controller;<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> private final HBaseServerExceptionPauseManager pauseManager;<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> public AsyncRpcRetryingCaller(Timer retryTimer, AsyncConnectionImpl conn, int priority,<a name="line.80"></a>
<span class="sourceLineNo">081</span> long pauseNs, long pauseNsForServerOverloaded, int maxAttempts, long operationTimeoutNs,<a name="line.81"></a>
<span class="sourceLineNo">082</span> long rpcTimeoutNs, int startLogErrorsCnt, Map&lt;String, byte[]&gt; requestAttributes) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> this.retryTimer = retryTimer;<a name="line.83"></a>
<span class="sourceLineNo">084</span> this.conn = conn;<a name="line.84"></a>
<span class="sourceLineNo">085</span> this.priority = priority;<a name="line.85"></a>
<span class="sourceLineNo">086</span> this.maxAttempts = maxAttempts;<a name="line.86"></a>
<span class="sourceLineNo">087</span> this.operationTimeoutNs = operationTimeoutNs;<a name="line.87"></a>
<span class="sourceLineNo">088</span> this.rpcTimeoutNs = rpcTimeoutNs;<a name="line.88"></a>
<span class="sourceLineNo">089</span> this.startLogErrorsCnt = startLogErrorsCnt;<a name="line.89"></a>
<span class="sourceLineNo">090</span> this.future = new CompletableFuture&lt;&gt;();<a name="line.90"></a>
<span class="sourceLineNo">091</span> this.controller = conn.rpcControllerFactory.newController();<a name="line.91"></a>
<span class="sourceLineNo">092</span> this.controller.setPriority(priority);<a name="line.92"></a>
<span class="sourceLineNo">093</span> this.controller.setRequestAttributes(requestAttributes);<a name="line.93"></a>
<span class="sourceLineNo">094</span> this.exceptions = new ArrayList&lt;&gt;();<a name="line.94"></a>
<span class="sourceLineNo">095</span> this.startNs = System.nanoTime();<a name="line.95"></a>
<span class="sourceLineNo">096</span> this.pauseManager =<a name="line.96"></a>
<span class="sourceLineNo">097</span> new HBaseServerExceptionPauseManager(pauseNs, pauseNsForServerOverloaded, operationTimeoutNs);<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> private long elapsedMs() {<a name="line.100"></a>
<span class="sourceLineNo">101</span> return TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNs);<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> protected final long remainingTimeNs() {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return pauseManager.remainingTimeNs(startNs);<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> protected final void completeExceptionally() {<a name="line.108"></a>
<span class="sourceLineNo">109</span> future.completeExceptionally(new RetriesExhaustedException(tries - 1, exceptions));<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> protected final void resetCallTimeout() {<a name="line.112"></a>
<span class="sourceLineNo">113</span> long callTimeoutNs;<a name="line.113"></a>
<span class="sourceLineNo">114</span> if (operationTimeoutNs &gt; 0) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> callTimeoutNs = remainingTimeNs();<a name="line.115"></a>
<span class="sourceLineNo">116</span> if (callTimeoutNs &lt;= 0) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> completeExceptionally();<a name="line.117"></a>
<span class="sourceLineNo">118</span> return;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> callTimeoutNs = Math.min(callTimeoutNs, rpcTimeoutNs);<a name="line.120"></a>
<span class="sourceLineNo">121</span> } else {<a name="line.121"></a>
<span class="sourceLineNo">122</span> callTimeoutNs = rpcTimeoutNs;<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> resetController(controller, callTimeoutNs, priority, getTableName().orElse(null));<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> private void tryScheduleRetry(Throwable error) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> OptionalLong maybePauseNsToUse = pauseManager.getPauseNsFromException(error, tries, startNs);<a name="line.128"></a>
<span class="sourceLineNo">129</span> if (!maybePauseNsToUse.isPresent()) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> completeExceptionally();<a name="line.130"></a>
<span class="sourceLineNo">131</span> return;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span> long delayNs = maybePauseNsToUse.getAsLong();<a name="line.133"></a>
<span class="sourceLineNo">134</span> tries++;<a name="line.134"></a>
<span class="sourceLineNo">135</span> if (HBaseServerException.isServerOverloaded(error)) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> Optional&lt;MetricsConnection&gt; metrics = conn.getConnectionMetrics();<a name="line.136"></a>
<span class="sourceLineNo">137</span> metrics.ifPresent(m -&gt; m.incrementServerOverloadedBackoffTime(delayNs, TimeUnit.NANOSECONDS));<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span> retryTimer.newTimeout(t -&gt; doCall(), delayNs, TimeUnit.NANOSECONDS);<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> protected Optional&lt;TableName&gt; getTableName() {<a name="line.142"></a>
<span class="sourceLineNo">143</span> return Optional.empty();<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> // Sub classes can override this method to change the error type, to control the retry logic.<a name="line.146"></a>
<span class="sourceLineNo">147</span> // For example, during rolling upgrading, if we call this newly added method, we will get a<a name="line.147"></a>
<span class="sourceLineNo">148</span> // UnsupportedOperationException(wrapped by a DNRIOE), and sometimes we may want to fallback to<a name="line.148"></a>
<span class="sourceLineNo">149</span> // use the old method first, so the sub class could change the exception type to something not a<a name="line.149"></a>
<span class="sourceLineNo">150</span> // DNRIOE, so we will schedule a retry, and the next time the sub class could use old method to<a name="line.150"></a>
<span class="sourceLineNo">151</span> // make the rpc call.<a name="line.151"></a>
<span class="sourceLineNo">152</span> protected Throwable preProcessError(Throwable error) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> return error;<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> protected final void onError(Throwable t, Supplier&lt;String&gt; errMsg,<a name="line.156"></a>
<span class="sourceLineNo">157</span> Consumer&lt;Throwable&gt; updateCachedLocation) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> if (future.isDone()) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> // Give up if the future is already done, this is possible if user has already canceled the<a name="line.159"></a>
<span class="sourceLineNo">160</span> // future. And for timeline consistent read, we will also cancel some requests if we have<a name="line.160"></a>
<span class="sourceLineNo">161</span> // already get one of the responses.<a name="line.161"></a>
<span class="sourceLineNo">162</span> LOG.debug("The future is already done, canceled={}, give up retrying", future.isCancelled());<a name="line.162"></a>
<span class="sourceLineNo">163</span> return;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span> Throwable error = preProcessError(translateException(t));<a name="line.165"></a>
<span class="sourceLineNo">166</span> // We use this retrying caller to open a scanner, as it is idempotent, but we may throw<a name="line.166"></a>
<span class="sourceLineNo">167</span> // ScannerResetException, which is a DoNotRetryIOException when opening a scanner as now we will<a name="line.167"></a>
<span class="sourceLineNo">168</span> // also fetch data when opening a scanner. The intention here is that if we hit a<a name="line.168"></a>
<span class="sourceLineNo">169</span> // ScannerResetException when scanning then we should try to open a new scanner, instead of<a name="line.169"></a>
<span class="sourceLineNo">170</span> // retrying on the old one, so it is declared as a DoNotRetryIOException. But here we are<a name="line.170"></a>
<span class="sourceLineNo">171</span> // exactly trying to open a new scanner, so we should retry on ScannerResetException.<a name="line.171"></a>
<span class="sourceLineNo">172</span> if (error instanceof DoNotRetryIOException &amp;&amp; !(error instanceof ScannerResetException)) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> future.completeExceptionally(error);<a name="line.173"></a>
<span class="sourceLineNo">174</span> return;<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span> if (tries &gt; startLogErrorsCnt) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> LOG.warn(errMsg.get() + ", tries = " + tries + ", maxAttempts = " + maxAttempts<a name="line.177"></a>
<span class="sourceLineNo">178</span> + ", timeout = " + TimeUnit.NANOSECONDS.toMillis(operationTimeoutNs)<a name="line.178"></a>
<span class="sourceLineNo">179</span> + " ms, time elapsed = " + elapsedMs() + " ms", error);<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span> updateCachedLocation.accept(error);<a name="line.181"></a>
<span class="sourceLineNo">182</span> RetriesExhaustedException.ThrowableWithExtraContext qt =<a name="line.182"></a>
<span class="sourceLineNo">183</span> new RetriesExhaustedException.ThrowableWithExtraContext(error,<a name="line.183"></a>
<span class="sourceLineNo">184</span> EnvironmentEdgeManager.currentTime(), "");<a name="line.184"></a>
<span class="sourceLineNo">185</span> exceptions.add(qt);<a name="line.185"></a>
<span class="sourceLineNo">186</span> if (tries &gt;= maxAttempts) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> completeExceptionally();<a name="line.187"></a>
<span class="sourceLineNo">188</span> return;<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span> // check whether the table has been disabled, notice that the check will introduce a request to<a name="line.190"></a>
<span class="sourceLineNo">191</span> // meta, so here we only check for disabled for some specific exception types.<a name="line.191"></a>
<span class="sourceLineNo">192</span> if (error instanceof NotServingRegionException || error instanceof RegionOfflineException) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> Optional&lt;TableName&gt; tableName = getTableName();<a name="line.193"></a>
<span class="sourceLineNo">194</span> if (tableName.isPresent()) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> FutureUtils.addListener(conn.getAdmin().isTableDisabled(tableName.get()), (disabled, e) -&gt; {<a name="line.195"></a>
<span class="sourceLineNo">196</span> if (e != null) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> if (e instanceof TableNotFoundException) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> future.completeExceptionally(e);<a name="line.198"></a>
<span class="sourceLineNo">199</span> } else {<a name="line.199"></a>
<span class="sourceLineNo">200</span> // failed to test whether the table is disabled, not a big deal, continue retrying<a name="line.200"></a>
<span class="sourceLineNo">201</span> tryScheduleRetry(error);<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span> return;<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span> if (disabled) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> future.completeExceptionally(new TableNotEnabledException(tableName.get()));<a name="line.206"></a>
<span class="sourceLineNo">207</span> } else {<a name="line.207"></a>
<span class="sourceLineNo">208</span> tryScheduleRetry(error);<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>
<span class="sourceLineNo">211</span> } else {<a name="line.211"></a>
<span class="sourceLineNo">212</span> tryScheduleRetry(error);<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> } else {<a name="line.214"></a>
<span class="sourceLineNo">215</span> tryScheduleRetry(error);<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span> }<a name="line.217"></a>
<span class="sourceLineNo">218</span><a name="line.218"></a>
<span class="sourceLineNo">219</span> protected abstract void doCall();<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> CompletableFuture&lt;T&gt; call() {<a name="line.221"></a>
<span class="sourceLineNo">222</span> doCall();<a name="line.222"></a>
<span class="sourceLineNo">223</span> return future;<a name="line.223"></a>
<span class="sourceLineNo">224</span> }<a name="line.224"></a>
<span class="sourceLineNo">225</span>}<a name="line.225"></a>
</pre>
</div>
</body>
</html>