blob: 563e4bf56bdfa89a45e31a068dbf0978c0657380 [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><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.quotas;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hadoop.conf.Configuration;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.slf4j.Logger;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.slf4j.LoggerFactory;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/*<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Internal class used to check and consume quota if exceed throttle quota is enabled. Exceed<a name="line.28"></a>
<span class="sourceLineNo">029</span> * throttle quota means, user can over consume user/namespace/table quota if region server has<a name="line.29"></a>
<span class="sourceLineNo">030</span> * additional available quota because other users don't consume at the same time.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * There are some limits when enable exceed throttle quota:<a name="line.32"></a>
<span class="sourceLineNo">033</span> * 1. Must set at least one read and one write region server throttle quota;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * 2. All region server throttle quotas must be in seconds time unit. Because once previous requests<a name="line.34"></a>
<span class="sourceLineNo">035</span> * exceed their quota and consume region server quota, quota in other time units may be refilled in<a name="line.35"></a>
<span class="sourceLineNo">036</span> * a long time, this may affect later requests.<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>@InterfaceAudience.Private<a name="line.38"></a>
<span class="sourceLineNo">039</span>@InterfaceStability.Evolving<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class ExceedOperationQuota extends DefaultOperationQuota {<a name="line.40"></a>
<span class="sourceLineNo">041</span> private static final Logger LOG = LoggerFactory.getLogger(ExceedOperationQuota.class);<a name="line.41"></a>
<span class="sourceLineNo">042</span> private QuotaLimiter regionServerLimiter;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> public ExceedOperationQuota(final Configuration conf, QuotaLimiter regionServerLimiter,<a name="line.44"></a>
<span class="sourceLineNo">045</span> final QuotaLimiter... limiters) {<a name="line.45"></a>
<span class="sourceLineNo">046</span> super(conf, limiters);<a name="line.46"></a>
<span class="sourceLineNo">047</span> this.regionServerLimiter = regionServerLimiter;<a name="line.47"></a>
<span class="sourceLineNo">048</span> }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> @Override<a name="line.50"></a>
<span class="sourceLineNo">051</span> public void checkQuota(int numWrites, int numReads, int numScans) throws RpcThrottlingException {<a name="line.51"></a>
<span class="sourceLineNo">052</span> if (regionServerLimiter.isBypass()) {<a name="line.52"></a>
<span class="sourceLineNo">053</span> // If region server limiter is bypass, which means no region server quota is set, check and<a name="line.53"></a>
<span class="sourceLineNo">054</span> // throttle by all other quotas. In this condition, exceed throttle quota will not work.<a name="line.54"></a>
<span class="sourceLineNo">055</span> LOG.warn("Exceed throttle quota is enabled but no region server quotas found");<a name="line.55"></a>
<span class="sourceLineNo">056</span> super.checkQuota(numWrites, numReads, numScans);<a name="line.56"></a>
<span class="sourceLineNo">057</span> } else {<a name="line.57"></a>
<span class="sourceLineNo">058</span> // 1. Update estimate quota which will be consumed<a name="line.58"></a>
<span class="sourceLineNo">059</span> updateEstimateConsumeQuota(numWrites, numReads, numScans);<a name="line.59"></a>
<span class="sourceLineNo">060</span> // 2. Check if region server limiter is enough. If not, throw RpcThrottlingException.<a name="line.60"></a>
<span class="sourceLineNo">061</span> regionServerLimiter.checkQuota(numWrites, writeConsumed, numReads + numScans, readConsumed,<a name="line.61"></a>
<span class="sourceLineNo">062</span> writeCapacityUnitConsumed, readCapacityUnitConsumed);<a name="line.62"></a>
<span class="sourceLineNo">063</span> // 3. Check if other limiters are enough. If not, exceed other limiters because region server<a name="line.63"></a>
<span class="sourceLineNo">064</span> // limiter is enough.<a name="line.64"></a>
<span class="sourceLineNo">065</span> boolean exceed = false;<a name="line.65"></a>
<span class="sourceLineNo">066</span> try {<a name="line.66"></a>
<span class="sourceLineNo">067</span> super.checkQuota(numWrites, numReads, numScans);<a name="line.67"></a>
<span class="sourceLineNo">068</span> } catch (RpcThrottlingException e) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> exceed = true;<a name="line.69"></a>
<span class="sourceLineNo">070</span> if (LOG.isDebugEnabled()) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> LOG.debug("Read/Write requests num exceeds quota: writes:{} reads:{} scan:{}, "<a name="line.71"></a>
<span class="sourceLineNo">072</span> + "try use region server quota",<a name="line.72"></a>
<span class="sourceLineNo">073</span> numWrites, numReads, numScans);<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span> // 4. Region server limiter is enough and grab estimated consume quota.<a name="line.76"></a>
<span class="sourceLineNo">077</span> readAvailable = Math.max(readAvailable, regionServerLimiter.getReadAvailable());<a name="line.77"></a>
<span class="sourceLineNo">078</span> regionServerLimiter.grabQuota(numWrites, writeConsumed, numReads + numScans, readConsumed,<a name="line.78"></a>
<span class="sourceLineNo">079</span> writeCapacityUnitConsumed, writeCapacityUnitConsumed);<a name="line.79"></a>
<span class="sourceLineNo">080</span> if (exceed) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> // 5. Other quota limiter is exceeded and has not been grabbed (because throw<a name="line.81"></a>
<span class="sourceLineNo">082</span> // RpcThrottlingException in Step 3), so grab it.<a name="line.82"></a>
<span class="sourceLineNo">083</span> for (final QuotaLimiter limiter : limiters) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> limiter.grabQuota(numWrites, writeConsumed, numReads + numScans, readConsumed,<a name="line.84"></a>
<span class="sourceLineNo">085</span> writeCapacityUnitConsumed, writeCapacityUnitConsumed);<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> @Override<a name="line.91"></a>
<span class="sourceLineNo">092</span> public void close() {<a name="line.92"></a>
<span class="sourceLineNo">093</span> super.close();<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (writeDiff != 0) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> regionServerLimiter.consumeWrite(writeDiff, writeCapacityUnitDiff);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (readDiff != 0) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> regionServerLimiter.consumeRead(readDiff, readCapacityUnitDiff);<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span>}<a name="line.101"></a>
</pre>
</div>
</body>
</html>