blob: 3f23014e98e373b02fe40f3e53d019956d5afcda [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.client, class: ClientPushbackTestBase">
<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.client;</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.client.MetricsConnection.CLIENT_SIDE_METRICS_ENABLED_KEY;</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.assertNotEquals;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.junit.Assert.assertNotNull;</span>
<span class="source-line-no">024</span><span id="line-24">import static org.junit.Assert.assertTrue;</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.concurrent.CountDownLatch;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.atomic.AtomicLong;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.HBaseTestingUtil;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.ServerName;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.client.backoff.ClientBackoffPolicy;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.client.backoff.ExponentialClientBackoffPolicy;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.client.backoff.ServerStatistics;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.regionserver.HRegionServer;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.regionserver.Region;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">042</span><span id="line-42">import org.junit.AfterClass;</span>
<span class="source-line-no">043</span><span id="line-43">import org.junit.BeforeClass;</span>
<span class="source-line-no">044</span><span id="line-44">import org.junit.Test;</span>
<span class="source-line-no">045</span><span id="line-45">import org.slf4j.Logger;</span>
<span class="source-line-no">046</span><span id="line-46">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48">/**</span>
<span class="source-line-no">049</span><span id="line-49"> * Test that we can actually send and use region metrics to slowdown client writes</span>
<span class="source-line-no">050</span><span id="line-50"> */</span>
<span class="source-line-no">051</span><span id="line-51">public abstract class ClientPushbackTestBase {</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> private static final Logger LOG = LoggerFactory.getLogger(ClientPushbackTestBase.class);</span>
<span class="source-line-no">054</span><span id="line-54"> protected static final HBaseTestingUtil UTIL = new HBaseTestingUtil();</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> protected static final TableName tableName = TableName.valueOf("client-pushback");</span>
<span class="source-line-no">057</span><span id="line-57"> private static final byte[] family = Bytes.toBytes("f");</span>
<span class="source-line-no">058</span><span id="line-58"> private static final byte[] qualifier = Bytes.toBytes("q");</span>
<span class="source-line-no">059</span><span id="line-59"> private static final long flushSizeBytes = 512;</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> @BeforeClass</span>
<span class="source-line-no">062</span><span id="line-62"> public static void setupCluster() throws Exception {</span>
<span class="source-line-no">063</span><span id="line-63"> Configuration conf = UTIL.getConfiguration();</span>
<span class="source-line-no">064</span><span id="line-64"> // enable backpressure</span>
<span class="source-line-no">065</span><span id="line-65"> conf.setBoolean(HConstants.ENABLE_CLIENT_BACKPRESSURE, true);</span>
<span class="source-line-no">066</span><span id="line-66"> // use the exponential backoff policy</span>
<span class="source-line-no">067</span><span id="line-67"> conf.setClass(ClientBackoffPolicy.BACKOFF_POLICY_CLASS, ExponentialClientBackoffPolicy.class,</span>
<span class="source-line-no">068</span><span id="line-68"> ClientBackoffPolicy.class);</span>
<span class="source-line-no">069</span><span id="line-69"> // turn the memstore size way down so we don't need to write a lot to see changes in memstore</span>
<span class="source-line-no">070</span><span id="line-70"> // load</span>
<span class="source-line-no">071</span><span id="line-71"> conf.setLong(HConstants.HREGION_MEMSTORE_FLUSH_SIZE, flushSizeBytes);</span>
<span class="source-line-no">072</span><span id="line-72"> // ensure we block the flushes when we are double that flushsize</span>
<span class="source-line-no">073</span><span id="line-73"> conf.setLong(HConstants.HREGION_MEMSTORE_BLOCK_MULTIPLIER,</span>
<span class="source-line-no">074</span><span id="line-74"> HConstants.DEFAULT_HREGION_MEMSTORE_BLOCK_MULTIPLIER);</span>
<span class="source-line-no">075</span><span id="line-75"> conf.setBoolean(CLIENT_SIDE_METRICS_ENABLED_KEY, true);</span>
<span class="source-line-no">076</span><span id="line-76"> UTIL.startMiniCluster(1);</span>
<span class="source-line-no">077</span><span id="line-77"> UTIL.createTable(tableName, family);</span>
<span class="source-line-no">078</span><span id="line-78"> }</span>
<span class="source-line-no">079</span><span id="line-79"></span>
<span class="source-line-no">080</span><span id="line-80"> @AfterClass</span>
<span class="source-line-no">081</span><span id="line-81"> public static void cleanupCluster() throws Exception {</span>
<span class="source-line-no">082</span><span id="line-82"> UTIL.shutdownMiniCluster();</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> protected abstract ClientBackoffPolicy getBackoffPolicy() throws IOException;</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> protected abstract ServerStatisticTracker getStatisticsTracker() throws IOException;</span>
<span class="source-line-no">088</span><span id="line-88"></span>
<span class="source-line-no">089</span><span id="line-89"> protected abstract MetricsConnection getConnectionMetrics() throws IOException;</span>
<span class="source-line-no">090</span><span id="line-90"></span>
<span class="source-line-no">091</span><span id="line-91"> protected abstract void mutate(Put put) throws IOException;</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> protected abstract void mutate(Put put, AtomicLong endTime, CountDownLatch latch)</span>
<span class="source-line-no">094</span><span id="line-94"> throws IOException;</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> protected abstract void mutateRow(RowMutations mutations) throws IOException;</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> @Test</span>
<span class="source-line-no">099</span><span id="line-99"> public void testClientTracksServerPushback() throws Exception {</span>
<span class="source-line-no">100</span><span id="line-100"> HRegionServer rs = UTIL.getHBaseCluster().getRegionServer(0);</span>
<span class="source-line-no">101</span><span id="line-101"> Region region = rs.getRegions(tableName).get(0);</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> LOG.debug("Writing some data to " + tableName);</span>
<span class="source-line-no">104</span><span id="line-104"> // write some data</span>
<span class="source-line-no">105</span><span id="line-105"> Put p = new Put(Bytes.toBytes("row"));</span>
<span class="source-line-no">106</span><span id="line-106"> p.addColumn(family, qualifier, Bytes.toBytes("value1"));</span>
<span class="source-line-no">107</span><span id="line-107"> mutate(p);</span>
<span class="source-line-no">108</span><span id="line-108"></span>
<span class="source-line-no">109</span><span id="line-109"> // get the current load on RS. Hopefully memstore isn't flushed since we wrote the the data</span>
<span class="source-line-no">110</span><span id="line-110"> int load = (int) ((region.getMemStoreHeapSize() * 100) / flushSizeBytes);</span>
<span class="source-line-no">111</span><span id="line-111"> LOG.debug("Done writing some data to " + tableName);</span>
<span class="source-line-no">112</span><span id="line-112"></span>
<span class="source-line-no">113</span><span id="line-113"> // get the stats for the region hosting our table</span>
<span class="source-line-no">114</span><span id="line-114"> ClientBackoffPolicy backoffPolicy = getBackoffPolicy();</span>
<span class="source-line-no">115</span><span id="line-115"> assertTrue("Backoff policy is not correctly configured",</span>
<span class="source-line-no">116</span><span id="line-116"> backoffPolicy instanceof ExponentialClientBackoffPolicy);</span>
<span class="source-line-no">117</span><span id="line-117"></span>
<span class="source-line-no">118</span><span id="line-118"> ServerStatisticTracker stats = getStatisticsTracker();</span>
<span class="source-line-no">119</span><span id="line-119"> assertNotNull("No stats configured for the client!", stats);</span>
<span class="source-line-no">120</span><span id="line-120"> // get the names so we can query the stats</span>
<span class="source-line-no">121</span><span id="line-121"> ServerName server = rs.getServerName();</span>
<span class="source-line-no">122</span><span id="line-122"> byte[] regionName = region.getRegionInfo().getRegionName();</span>
<span class="source-line-no">123</span><span id="line-123"></span>
<span class="source-line-no">124</span><span id="line-124"> // check to see we found some load on the memstore</span>
<span class="source-line-no">125</span><span id="line-125"> ServerStatistics serverStats = stats.getStats(server);</span>
<span class="source-line-no">126</span><span id="line-126"> ServerStatistics.RegionStatistics regionStats = serverStats.getStatsForRegion(regionName);</span>
<span class="source-line-no">127</span><span id="line-127"> assertEquals("We did not find some load on the memstore", load,</span>
<span class="source-line-no">128</span><span id="line-128"> regionStats.getMemStoreLoadPercent());</span>
<span class="source-line-no">129</span><span id="line-129"> // check that the load reported produces a nonzero delay</span>
<span class="source-line-no">130</span><span id="line-130"> long backoffTime = backoffPolicy.getBackoffTime(server, regionName, serverStats);</span>
<span class="source-line-no">131</span><span id="line-131"> assertNotEquals("Reported load does not produce a backoff", 0, backoffTime);</span>
<span class="source-line-no">132</span><span id="line-132"> LOG.debug("Backoff calculated for " + region.getRegionInfo().getRegionNameAsString() + " @ "</span>
<span class="source-line-no">133</span><span id="line-133"> + server + " is " + backoffTime);</span>
<span class="source-line-no">134</span><span id="line-134"></span>
<span class="source-line-no">135</span><span id="line-135"> CountDownLatch latch = new CountDownLatch(1);</span>
<span class="source-line-no">136</span><span id="line-136"> AtomicLong endTime = new AtomicLong();</span>
<span class="source-line-no">137</span><span id="line-137"> long startTime = EnvironmentEdgeManager.currentTime();</span>
<span class="source-line-no">138</span><span id="line-138"> mutate(p, endTime, latch);</span>
<span class="source-line-no">139</span><span id="line-139"> // Currently the ExponentialClientBackoffPolicy under these test conditions</span>
<span class="source-line-no">140</span><span id="line-140"> // produces a backoffTime of 151 milliseconds. This is long enough so the</span>
<span class="source-line-no">141</span><span id="line-141"> // wait and related checks below are reasonable. Revisit if the backoff</span>
<span class="source-line-no">142</span><span id="line-142"> // time reported by above debug logging has significantly deviated.</span>
<span class="source-line-no">143</span><span id="line-143"> MetricsConnection metrics = getConnectionMetrics();</span>
<span class="source-line-no">144</span><span id="line-144"> String name = server.getServerName() + "," + Bytes.toStringBinary(regionName);</span>
<span class="source-line-no">145</span><span id="line-145"> MetricsConnection.RegionStats rsStats = metrics.getServerStats().get(server).get(regionName);</span>
<span class="source-line-no">146</span><span id="line-146"> assertEquals(name, rsStats.name);</span>
<span class="source-line-no">147</span><span id="line-147"> assertEquals(rsStats.heapOccupancyHist.getSnapshot().getMean(),</span>
<span class="source-line-no">148</span><span id="line-148"> (double) regionStats.getHeapOccupancyPercent(), 0.1);</span>
<span class="source-line-no">149</span><span id="line-149"> assertEquals(rsStats.memstoreLoadHist.getSnapshot().getMean(),</span>
<span class="source-line-no">150</span><span id="line-150"> (double) regionStats.getMemStoreLoadPercent(), 0.1);</span>
<span class="source-line-no">151</span><span id="line-151"></span>
<span class="source-line-no">152</span><span id="line-152"> MetricsConnection.RunnerStats runnerStats = metrics.getRunnerStats();</span>
<span class="source-line-no">153</span><span id="line-153"></span>
<span class="source-line-no">154</span><span id="line-154"> assertEquals(1, runnerStats.delayRunners.getCount());</span>
<span class="source-line-no">155</span><span id="line-155"> assertEquals(1, runnerStats.normalRunners.getCount());</span>
<span class="source-line-no">156</span><span id="line-156"> assertEquals("", runnerStats.delayIntevalHist.getSnapshot().getMean(), (double) backoffTime,</span>
<span class="source-line-no">157</span><span id="line-157"> 0.1);</span>
<span class="source-line-no">158</span><span id="line-158"></span>
<span class="source-line-no">159</span><span id="line-159"> latch.await(backoffTime * 2, TimeUnit.MILLISECONDS);</span>
<span class="source-line-no">160</span><span id="line-160"> assertNotEquals("AsyncProcess did not submit the work time", 0, endTime.get());</span>
<span class="source-line-no">161</span><span id="line-161"> assertTrue("AsyncProcess did not delay long enough", endTime.get() - startTime &gt;= backoffTime);</span>
<span class="source-line-no">162</span><span id="line-162"> }</span>
<span class="source-line-no">163</span><span id="line-163"></span>
<span class="source-line-no">164</span><span id="line-164"> @Test</span>
<span class="source-line-no">165</span><span id="line-165"> public void testMutateRowStats() throws IOException {</span>
<span class="source-line-no">166</span><span id="line-166"> HRegionServer rs = UTIL.getHBaseCluster().getRegionServer(0);</span>
<span class="source-line-no">167</span><span id="line-167"> Region region = rs.getRegions(tableName).get(0);</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> RowMutations mutations = new RowMutations(Bytes.toBytes("row"));</span>
<span class="source-line-no">170</span><span id="line-170"> Put p = new Put(Bytes.toBytes("row"));</span>
<span class="source-line-no">171</span><span id="line-171"> p.addColumn(family, qualifier, Bytes.toBytes("value2"));</span>
<span class="source-line-no">172</span><span id="line-172"> mutations.add(p);</span>
<span class="source-line-no">173</span><span id="line-173"> mutateRow(mutations);</span>
<span class="source-line-no">174</span><span id="line-174"></span>
<span class="source-line-no">175</span><span id="line-175"> ServerStatisticTracker stats = getStatisticsTracker();</span>
<span class="source-line-no">176</span><span id="line-176"> assertNotNull("No stats configured for the client!", stats);</span>
<span class="source-line-no">177</span><span id="line-177"> // get the names so we can query the stats</span>
<span class="source-line-no">178</span><span id="line-178"> ServerName server = rs.getServerName();</span>
<span class="source-line-no">179</span><span id="line-179"> byte[] regionName = region.getRegionInfo().getRegionName();</span>
<span class="source-line-no">180</span><span id="line-180"></span>
<span class="source-line-no">181</span><span id="line-181"> // check to see we found some load on the memstore</span>
<span class="source-line-no">182</span><span id="line-182"> ServerStatistics serverStats = stats.getStats(server);</span>
<span class="source-line-no">183</span><span id="line-183"> ServerStatistics.RegionStatistics regionStats = serverStats.getStatsForRegion(regionName);</span>
<span class="source-line-no">184</span><span id="line-184"></span>
<span class="source-line-no">185</span><span id="line-185"> assertNotNull(regionStats);</span>
<span class="source-line-no">186</span><span id="line-186"> assertTrue(regionStats.getMemStoreLoadPercent() &gt; 0);</span>
<span class="source-line-no">187</span><span id="line-187"> }</span>
<span class="source-line-no">188</span><span id="line-188">}</span>
</pre>
</div>
</main>
</body>
</html>