blob: 2742845d661bc563cbc70fa774686d88a067379a [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.assertFalse;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.junit.Assert.assertTrue;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import static org.mockito.ArgumentMatchers.any;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import static org.mockito.Mockito.doAnswer;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import static org.mockito.Mockito.mock;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import static org.mockito.Mockito.when;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.io.IOException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.Arrays;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.List;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.concurrent.BlockingDeque;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.concurrent.LinkedBlockingDeque;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.conf.Configuration;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.HBaseTestingUtil;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.HConstants;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.TableName;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.ipc.HBaseRpcController;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.testclassification.MediumTests;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.junit.After;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.junit.Before;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.junit.ClassRule;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.junit.Test;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.junit.experimental.categories.Category;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.junit.runner.RunWith;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.junit.runners.Parameterized;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.mockito.Mockito;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.mockito.invocation.InvocationOnMock;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.mockito.stubbing.Answer;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.apache.hbase.thirdparty.com.google.protobuf.RpcController;<a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.apache.hbase.thirdparty.com.google.protobuf.ServiceException;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.shaded.protobuf.RequestConverter;<a name="line.55"></a>
<span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Action;<a name="line.56"></a>
<span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.MultiRequest;<a name="line.57"></a>
<span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.RegionAction;<a name="line.58"></a>
<span class="sourceLineNo">059</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>/**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Tests logging of large batch commands via Multi. Tests are fast, but uses a mini-cluster (to test<a name="line.62"></a>
<span class="sourceLineNo">063</span> * via "Multi" commands) so classified as MediumTests<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span>@RunWith(Parameterized.class)<a name="line.65"></a>
<span class="sourceLineNo">066</span>@Category(MediumTests.class)<a name="line.66"></a>
<span class="sourceLineNo">067</span>public class TestMultiLogThreshold {<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> @ClassRule<a name="line.69"></a>
<span class="sourceLineNo">070</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.70"></a>
<span class="sourceLineNo">071</span> HBaseClassTestRule.forClass(TestMultiLogThreshold.class);<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> private static final TableName NAME = TableName.valueOf("tableName");<a name="line.73"></a>
<span class="sourceLineNo">074</span> private static final byte[] TEST_FAM = Bytes.toBytes("fam");<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> private HBaseTestingUtil util;<a name="line.76"></a>
<span class="sourceLineNo">077</span> private Configuration conf;<a name="line.77"></a>
<span class="sourceLineNo">078</span> private int threshold;<a name="line.78"></a>
<span class="sourceLineNo">079</span> private HRegionServer rs;<a name="line.79"></a>
<span class="sourceLineNo">080</span> private RSRpcServices services;<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> private org.apache.logging.log4j.core.Appender appender;<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> @Parameterized.Parameter<a name="line.84"></a>
<span class="sourceLineNo">085</span> public static boolean rejectLargeBatchOp;<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> @Parameterized.Parameters<a name="line.87"></a>
<span class="sourceLineNo">088</span> public static List&lt;Object[]&gt; params() {<a name="line.88"></a>
<span class="sourceLineNo">089</span> return Arrays.asList(new Object[] { false }, new Object[] { true });<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> private final class LevelAndMessage {<a name="line.92"></a>
<span class="sourceLineNo">093</span> final org.apache.logging.log4j.Level level;<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> final String msg;<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> public LevelAndMessage(org.apache.logging.log4j.Level level, String msg) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> this.level = level;<a name="line.98"></a>
<span class="sourceLineNo">099</span> this.msg = msg;<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>
<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> // log4j2 will reuse the LogEvent so we need to copy the level and message out.<a name="line.104"></a>
<span class="sourceLineNo">105</span> private BlockingDeque&lt;LevelAndMessage&gt; logs = new LinkedBlockingDeque&lt;&gt;();<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> @Before<a name="line.107"></a>
<span class="sourceLineNo">108</span> public void setupTest() throws Exception {<a name="line.108"></a>
<span class="sourceLineNo">109</span> util = new HBaseTestingUtil();<a name="line.109"></a>
<span class="sourceLineNo">110</span> conf = util.getConfiguration();<a name="line.110"></a>
<span class="sourceLineNo">111</span> threshold =<a name="line.111"></a>
<span class="sourceLineNo">112</span> conf.getInt(HConstants.BATCH_ROWS_THRESHOLD_NAME, HConstants.BATCH_ROWS_THRESHOLD_DEFAULT);<a name="line.112"></a>
<span class="sourceLineNo">113</span> conf.setBoolean("hbase.rpc.rows.size.threshold.reject", rejectLargeBatchOp);<a name="line.113"></a>
<span class="sourceLineNo">114</span> util.startMiniCluster();<a name="line.114"></a>
<span class="sourceLineNo">115</span> util.createTable(NAME, TEST_FAM);<a name="line.115"></a>
<span class="sourceLineNo">116</span> rs = util.getRSForFirstRegionInTable(NAME);<a name="line.116"></a>
<span class="sourceLineNo">117</span> appender = mock(org.apache.logging.log4j.core.Appender.class);<a name="line.117"></a>
<span class="sourceLineNo">118</span> when(appender.getName()).thenReturn("mockAppender");<a name="line.118"></a>
<span class="sourceLineNo">119</span> when(appender.isStarted()).thenReturn(true);<a name="line.119"></a>
<span class="sourceLineNo">120</span> doAnswer(new Answer&lt;Void&gt;() {<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> @Override<a name="line.122"></a>
<span class="sourceLineNo">123</span> public Void answer(InvocationOnMock invocation) throws Throwable {<a name="line.123"></a>
<span class="sourceLineNo">124</span> org.apache.logging.log4j.core.LogEvent logEvent =<a name="line.124"></a>
<span class="sourceLineNo">125</span> invocation.getArgument(0, org.apache.logging.log4j.core.LogEvent.class);<a name="line.125"></a>
<span class="sourceLineNo">126</span> logs.add(<a name="line.126"></a>
<span class="sourceLineNo">127</span> new LevelAndMessage(logEvent.getLevel(), logEvent.getMessage().getFormattedMessage()));<a name="line.127"></a>
<span class="sourceLineNo">128</span> return null;<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> }).when(appender).append(any(org.apache.logging.log4j.core.LogEvent.class));<a name="line.130"></a>
<span class="sourceLineNo">131</span> ((org.apache.logging.log4j.core.Logger) org.apache.logging.log4j.LogManager<a name="line.131"></a>
<span class="sourceLineNo">132</span> .getLogger(RSRpcServices.class)).addAppender(appender);<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> @After<a name="line.135"></a>
<span class="sourceLineNo">136</span> public void tearDown() throws Exception {<a name="line.136"></a>
<span class="sourceLineNo">137</span> ((org.apache.logging.log4j.core.Logger) org.apache.logging.log4j.LogManager<a name="line.137"></a>
<span class="sourceLineNo">138</span> .getLogger(RSRpcServices.class)).removeAppender(appender);<a name="line.138"></a>
<span class="sourceLineNo">139</span> util.shutdownMiniCluster();<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> private enum ActionType {<a name="line.142"></a>
<span class="sourceLineNo">143</span> REGION_ACTIONS,<a name="line.143"></a>
<span class="sourceLineNo">144</span> ACTIONS<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<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> * Sends a multi request with a certain amount of rows, will populate Multi command with either<a name="line.148"></a>
<span class="sourceLineNo">149</span> * "rows" number of RegionActions with one Action each or one RegionAction with "rows" number of<a name="line.149"></a>
<span class="sourceLineNo">150</span> * Actions<a name="line.150"></a>
<span class="sourceLineNo">151</span> */<a name="line.151"></a>
<span class="sourceLineNo">152</span> private void sendMultiRequest(int rows, ActionType actionType)<a name="line.152"></a>
<span class="sourceLineNo">153</span> throws ServiceException, IOException {<a name="line.153"></a>
<span class="sourceLineNo">154</span> RpcController rpcc = Mockito.mock(HBaseRpcController.class);<a name="line.154"></a>
<span class="sourceLineNo">155</span> MultiRequest.Builder builder = MultiRequest.newBuilder();<a name="line.155"></a>
<span class="sourceLineNo">156</span> int numRAs = 1;<a name="line.156"></a>
<span class="sourceLineNo">157</span> int numAs = 1;<a name="line.157"></a>
<span class="sourceLineNo">158</span> switch (actionType) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> case REGION_ACTIONS:<a name="line.159"></a>
<span class="sourceLineNo">160</span> numRAs = rows;<a name="line.160"></a>
<span class="sourceLineNo">161</span> break;<a name="line.161"></a>
<span class="sourceLineNo">162</span> case ACTIONS:<a name="line.162"></a>
<span class="sourceLineNo">163</span> numAs = rows;<a name="line.163"></a>
<span class="sourceLineNo">164</span> break;<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span> for (int i = 0; i &lt; numRAs; i++) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> RegionAction.Builder rab = RegionAction.newBuilder();<a name="line.167"></a>
<span class="sourceLineNo">168</span> rab.setRegion(RequestConverter.buildRegionSpecifier(<a name="line.168"></a>
<span class="sourceLineNo">169</span> HBaseProtos.RegionSpecifier.RegionSpecifierType.REGION_NAME,<a name="line.169"></a>
<span class="sourceLineNo">170</span> Bytes.toBytes("someStuff" + i)));<a name="line.170"></a>
<span class="sourceLineNo">171</span> for (int j = 0; j &lt; numAs; j++) {<a name="line.171"></a>
<span class="sourceLineNo">172</span> Action.Builder ab = Action.newBuilder();<a name="line.172"></a>
<span class="sourceLineNo">173</span> rab.addAction(ab.build());<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> builder.addRegionAction(rab.build());<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span> services = new RSRpcServices(rs);<a name="line.177"></a>
<span class="sourceLineNo">178</span> services.multi(rpcc, builder.build());<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> private void assertLogBatchWarnings(boolean expected) {<a name="line.181"></a>
<span class="sourceLineNo">182</span> boolean actual = false;<a name="line.182"></a>
<span class="sourceLineNo">183</span> for (LevelAndMessage event : logs) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> if (<a name="line.184"></a>
<span class="sourceLineNo">185</span> event.level == org.apache.logging.log4j.Level.WARN<a name="line.185"></a>
<span class="sourceLineNo">186</span> &amp;&amp; event.msg.contains("Large batch operation detected")<a name="line.186"></a>
<span class="sourceLineNo">187</span> ) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> actual = true;<a name="line.188"></a>
<span class="sourceLineNo">189</span> break;<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> logs.clear();<a name="line.192"></a>
<span class="sourceLineNo">193</span> assertEquals(expected, actual);<a name="line.193"></a>
<span class="sourceLineNo">194</span> }<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span> @Test<a name="line.196"></a>
<span class="sourceLineNo">197</span> public void testMultiLogThresholdRegionActions() throws ServiceException, IOException {<a name="line.197"></a>
<span class="sourceLineNo">198</span> try {<a name="line.198"></a>
<span class="sourceLineNo">199</span> sendMultiRequest(threshold + 1, ActionType.REGION_ACTIONS);<a name="line.199"></a>
<span class="sourceLineNo">200</span> assertFalse(rejectLargeBatchOp);<a name="line.200"></a>
<span class="sourceLineNo">201</span> } catch (ServiceException e) {<a name="line.201"></a>
<span class="sourceLineNo">202</span> assertTrue(rejectLargeBatchOp);<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span> assertLogBatchWarnings(true);<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span> sendMultiRequest(threshold, ActionType.REGION_ACTIONS);<a name="line.206"></a>
<span class="sourceLineNo">207</span> assertLogBatchWarnings(false);<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> try {<a name="line.209"></a>
<span class="sourceLineNo">210</span> sendMultiRequest(threshold + 1, ActionType.ACTIONS);<a name="line.210"></a>
<span class="sourceLineNo">211</span> assertFalse(rejectLargeBatchOp);<a name="line.211"></a>
<span class="sourceLineNo">212</span> } catch (ServiceException e) {<a name="line.212"></a>
<span class="sourceLineNo">213</span> assertTrue(rejectLargeBatchOp);<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span> assertLogBatchWarnings(true);<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span> sendMultiRequest(threshold, ActionType.ACTIONS);<a name="line.217"></a>
<span class="sourceLineNo">218</span> assertLogBatchWarnings(false);<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span>}<a name="line.220"></a>
</pre>
</div>
</body>
</html>