Google Git
Sign in
apache / hbase-site / 26f300aaca5ca67a15fefcd1e12c6e67a6d60d5b / . / devapidocs / src-html / org / apache / hadoop / hbase / util / LoadTestUtil.html
blob: c5f10213e0b93e9d4e08e80768b71c307632e702 [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.util, class: LoadTestUtil">
<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.util;</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 java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.Arrays;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.Locale;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.MasterNotRunningException;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.TableExistsException;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.Admin;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.client.Connection;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.client.ConnectionFactory;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.client.Durability;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.client.TableDescriptor;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.client.TableDescriptorBuilder;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.io.compress.Compression.Algorithm;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">039</span><span id="line-39">import org.slf4j.Logger;</span>
<span class="source-line-no">040</span><span id="line-40">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42">/**</span>
<span class="source-line-no">043</span><span id="line-43"> * This class was created by moving all load test related code from HFileTestUtil and</span>
<span class="source-line-no">044</span><span id="line-44"> * HBaseTestingUtil as part of refactoring for hbase-diagnostics module creation in HBASE-28432</span>
<span class="source-line-no">045</span><span id="line-45"> */</span>
<span class="source-line-no">046</span><span id="line-46">@InterfaceAudience.Private</span>
<span class="source-line-no">047</span><span id="line-47">public class LoadTestUtil {</span>
<span class="source-line-no">048</span><span id="line-48"> private static final Logger LOG = LoggerFactory.getLogger(LoadTestUtil.class);</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> public static final String OPT_DATA_BLOCK_ENCODING_USAGE = "Encoding algorithm (e.g. prefix "</span>
<span class="source-line-no">051</span><span id="line-51"> + "compression) to use for data blocks in the test column family, " + "one of "</span>
<span class="source-line-no">052</span><span id="line-52"> + Arrays.toString(DataBlockEncoding.values()) + ".";</span>
<span class="source-line-no">053</span><span id="line-53"> public static final String OPT_DATA_BLOCK_ENCODING =</span>
<span class="source-line-no">054</span><span id="line-54"> ColumnFamilyDescriptorBuilder.DATA_BLOCK_ENCODING.toLowerCase(Locale.ROOT);</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> /**</span>
<span class="source-line-no">057</span><span id="line-57"> * The default number of regions per regionserver when creating a pre-split table.</span>
<span class="source-line-no">058</span><span id="line-58"> */</span>
<span class="source-line-no">059</span><span id="line-59"> private static final int DEFAULT_REGIONS_PER_SERVER = 3;</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> /**</span>
<span class="source-line-no">062</span><span id="line-62"> * Creates a pre-split table for load testing. If the table already exists, logs a warning and</span>
<span class="source-line-no">063</span><span id="line-63"> * continues.</span>
<span class="source-line-no">064</span><span id="line-64"> * @return the number of regions the table was split into</span>
<span class="source-line-no">065</span><span id="line-65"> */</span>
<span class="source-line-no">066</span><span id="line-66"> public static int createPreSplitLoadTestTable(Configuration conf, TableName tableName,</span>
<span class="source-line-no">067</span><span id="line-67"> byte[] columnFamily, Algorithm compression, DataBlockEncoding dataBlockEncoding)</span>
<span class="source-line-no">068</span><span id="line-68"> throws IOException {</span>
<span class="source-line-no">069</span><span id="line-69"> return createPreSplitLoadTestTable(conf, tableName, columnFamily, compression,</span>
<span class="source-line-no">070</span><span id="line-70"> dataBlockEncoding, DEFAULT_REGIONS_PER_SERVER, 1, Durability.USE_DEFAULT);</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"></span>
<span class="source-line-no">073</span><span id="line-73"> /**</span>
<span class="source-line-no">074</span><span id="line-74"> * Creates a pre-split table for load testing. If the table already exists, logs a warning and</span>
<span class="source-line-no">075</span><span id="line-75"> * continues.</span>
<span class="source-line-no">076</span><span id="line-76"> * @return the number of regions the table was split into</span>
<span class="source-line-no">077</span><span id="line-77"> */</span>
<span class="source-line-no">078</span><span id="line-78"> public static int createPreSplitLoadTestTable(Configuration conf, TableName tableName,</span>
<span class="source-line-no">079</span><span id="line-79"> byte[] columnFamily, Algorithm compression, DataBlockEncoding dataBlockEncoding,</span>
<span class="source-line-no">080</span><span id="line-80"> int numRegionsPerServer, int regionReplication, Durability durability) throws IOException {</span>
<span class="source-line-no">081</span><span id="line-81"> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(tableName);</span>
<span class="source-line-no">082</span><span id="line-82"> builder.setDurability(durability);</span>
<span class="source-line-no">083</span><span id="line-83"> builder.setRegionReplication(regionReplication);</span>
<span class="source-line-no">084</span><span id="line-84"> ColumnFamilyDescriptorBuilder cfBuilder =</span>
<span class="source-line-no">085</span><span id="line-85"> ColumnFamilyDescriptorBuilder.newBuilder(columnFamily);</span>
<span class="source-line-no">086</span><span id="line-86"> cfBuilder.setDataBlockEncoding(dataBlockEncoding);</span>
<span class="source-line-no">087</span><span id="line-87"> cfBuilder.setCompressionType(compression);</span>
<span class="source-line-no">088</span><span id="line-88"> return createPreSplitLoadTestTable(conf, builder.build(), cfBuilder.build(),</span>
<span class="source-line-no">089</span><span id="line-89"> numRegionsPerServer);</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"></span>
<span class="source-line-no">092</span><span id="line-92"> /**</span>
<span class="source-line-no">093</span><span id="line-93"> * Creates a pre-split table for load testing. If the table already exists, logs a warning and</span>
<span class="source-line-no">094</span><span id="line-94"> * continues.</span>
<span class="source-line-no">095</span><span id="line-95"> * @return the number of regions the table was split into</span>
<span class="source-line-no">096</span><span id="line-96"> */</span>
<span class="source-line-no">097</span><span id="line-97"> public static int createPreSplitLoadTestTable(Configuration conf, TableName tableName,</span>
<span class="source-line-no">098</span><span id="line-98"> byte[][] columnFamilies, Algorithm compression, DataBlockEncoding dataBlockEncoding,</span>
<span class="source-line-no">099</span><span id="line-99"> int numRegionsPerServer, int regionReplication, Durability durability) throws IOException {</span>
<span class="source-line-no">100</span><span id="line-100"> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(tableName);</span>
<span class="source-line-no">101</span><span id="line-101"> builder.setDurability(durability);</span>
<span class="source-line-no">102</span><span id="line-102"> builder.setRegionReplication(regionReplication);</span>
<span class="source-line-no">103</span><span id="line-103"> ColumnFamilyDescriptor[] hcds = new ColumnFamilyDescriptor[columnFamilies.length];</span>
<span class="source-line-no">104</span><span id="line-104"> for (int i = 0; i &lt; columnFamilies.length; i++) {</span>
<span class="source-line-no">105</span><span id="line-105"> ColumnFamilyDescriptorBuilder cfBuilder =</span>
<span class="source-line-no">106</span><span id="line-106"> ColumnFamilyDescriptorBuilder.newBuilder(columnFamilies[i]);</span>
<span class="source-line-no">107</span><span id="line-107"> cfBuilder.setDataBlockEncoding(dataBlockEncoding);</span>
<span class="source-line-no">108</span><span id="line-108"> cfBuilder.setCompressionType(compression);</span>
<span class="source-line-no">109</span><span id="line-109"> hcds[i] = cfBuilder.build();</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"> return createPreSplitLoadTestTable(conf, builder.build(), hcds, numRegionsPerServer);</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> /**</span>
<span class="source-line-no">115</span><span id="line-115"> * Creates a pre-split table for load testing. If the table already exists, logs a warning and</span>
<span class="source-line-no">116</span><span id="line-116"> * continues.</span>
<span class="source-line-no">117</span><span id="line-117"> * @return the number of regions the table was split into</span>
<span class="source-line-no">118</span><span id="line-118"> */</span>
<span class="source-line-no">119</span><span id="line-119"> public static int createPreSplitLoadTestTable(Configuration conf, TableDescriptor desc,</span>
<span class="source-line-no">120</span><span id="line-120"> ColumnFamilyDescriptor hcd) throws IOException {</span>
<span class="source-line-no">121</span><span id="line-121"> return createPreSplitLoadTestTable(conf, desc, hcd, DEFAULT_REGIONS_PER_SERVER);</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"></span>
<span class="source-line-no">124</span><span id="line-124"> /**</span>
<span class="source-line-no">125</span><span id="line-125"> * Creates a pre-split table for load testing. If the table already exists, logs a warning and</span>
<span class="source-line-no">126</span><span id="line-126"> * continues.</span>
<span class="source-line-no">127</span><span id="line-127"> * @return the number of regions the table was split into</span>
<span class="source-line-no">128</span><span id="line-128"> */</span>
<span class="source-line-no">129</span><span id="line-129"> public static int createPreSplitLoadTestTable(Configuration conf, TableDescriptor desc,</span>
<span class="source-line-no">130</span><span id="line-130"> ColumnFamilyDescriptor hcd, int numRegionsPerServer) throws IOException {</span>
<span class="source-line-no">131</span><span id="line-131"> return createPreSplitLoadTestTable(conf, desc, new ColumnFamilyDescriptor[] { hcd },</span>
<span class="source-line-no">132</span><span id="line-132"> numRegionsPerServer);</span>
<span class="source-line-no">133</span><span id="line-133"> }</span>
<span class="source-line-no">134</span><span id="line-134"></span>
<span class="source-line-no">135</span><span id="line-135"> /**</span>
<span class="source-line-no">136</span><span id="line-136"> * Creates a pre-split table for load testing. If the table already exists, logs a warning and</span>
<span class="source-line-no">137</span><span id="line-137"> * continues.</span>
<span class="source-line-no">138</span><span id="line-138"> * @return the number of regions the table was split into</span>
<span class="source-line-no">139</span><span id="line-139"> */</span>
<span class="source-line-no">140</span><span id="line-140"> public static int createPreSplitLoadTestTable(Configuration conf, TableDescriptor desc,</span>
<span class="source-line-no">141</span><span id="line-141"> ColumnFamilyDescriptor[] hcds, int numRegionsPerServer) throws IOException {</span>
<span class="source-line-no">142</span><span id="line-142"> return createPreSplitLoadTestTable(conf, desc, hcds, new RegionSplitter.HexStringSplit(),</span>
<span class="source-line-no">143</span><span id="line-143"> numRegionsPerServer);</span>
<span class="source-line-no">144</span><span id="line-144"> }</span>
<span class="source-line-no">145</span><span id="line-145"></span>
<span class="source-line-no">146</span><span id="line-146"> /**</span>
<span class="source-line-no">147</span><span id="line-147"> * Creates a pre-split table for load testing. If the table already exists, logs a warning and</span>
<span class="source-line-no">148</span><span id="line-148"> * continues.</span>
<span class="source-line-no">149</span><span id="line-149"> * @return the number of regions the table was split into</span>
<span class="source-line-no">150</span><span id="line-150"> */</span>
<span class="source-line-no">151</span><span id="line-151"> public static int createPreSplitLoadTestTable(Configuration conf, TableDescriptor td,</span>
<span class="source-line-no">152</span><span id="line-152"> ColumnFamilyDescriptor[] cds, SplitAlgorithm splitter, int numRegionsPerServer)</span>
<span class="source-line-no">153</span><span id="line-153"> throws IOException {</span>
<span class="source-line-no">154</span><span id="line-154"> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(td);</span>
<span class="source-line-no">155</span><span id="line-155"> for (ColumnFamilyDescriptor cd : cds) {</span>
<span class="source-line-no">156</span><span id="line-156"> if (!td.hasColumnFamily(cd.getName())) {</span>
<span class="source-line-no">157</span><span id="line-157"> builder.setColumnFamily(cd);</span>
<span class="source-line-no">158</span><span id="line-158"> }</span>
<span class="source-line-no">159</span><span id="line-159"> }</span>
<span class="source-line-no">160</span><span id="line-160"> td = builder.build();</span>
<span class="source-line-no">161</span><span id="line-161"> int totalNumberOfRegions = 0;</span>
<span class="source-line-no">162</span><span id="line-162"> Connection unmanagedConnection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">163</span><span id="line-163"> Admin admin = unmanagedConnection.getAdmin();</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> try {</span>
<span class="source-line-no">166</span><span id="line-166"> // create a table a pre-splits regions.</span>
<span class="source-line-no">167</span><span id="line-167"> // The number of splits is set as:</span>
<span class="source-line-no">168</span><span id="line-168"> // region servers * regions per region server).</span>
<span class="source-line-no">169</span><span id="line-169"> int numberOfServers = admin.getRegionServers().size();</span>
<span class="source-line-no">170</span><span id="line-170"> if (numberOfServers == 0) {</span>
<span class="source-line-no">171</span><span id="line-171"> throw new IllegalStateException("No live regionservers");</span>
<span class="source-line-no">172</span><span id="line-172"> }</span>
<span class="source-line-no">173</span><span id="line-173"></span>
<span class="source-line-no">174</span><span id="line-174"> totalNumberOfRegions = numberOfServers * numRegionsPerServer;</span>
<span class="source-line-no">175</span><span id="line-175"> LOG.info("Number of live regionservers: " + numberOfServers + ", "</span>
<span class="source-line-no">176</span><span id="line-176"> + "pre-splitting table into " + totalNumberOfRegions + " regions " + "(regions per server: "</span>
<span class="source-line-no">177</span><span id="line-177"> + numRegionsPerServer + ")");</span>
<span class="source-line-no">178</span><span id="line-178"></span>
<span class="source-line-no">179</span><span id="line-179"> byte[][] splits = splitter.split(totalNumberOfRegions);</span>
<span class="source-line-no">180</span><span id="line-180"></span>
<span class="source-line-no">181</span><span id="line-181"> admin.createTable(td, splits);</span>
<span class="source-line-no">182</span><span id="line-182"> } catch (MasterNotRunningException e) {</span>
<span class="source-line-no">183</span><span id="line-183"> LOG.error("Master not running", e);</span>
<span class="source-line-no">184</span><span id="line-184"> throw new IOException(e);</span>
<span class="source-line-no">185</span><span id="line-185"> } catch (TableExistsException e) {</span>
<span class="source-line-no">186</span><span id="line-186"> LOG.warn("Table " + td.getTableName() + " already exists, continuing");</span>
<span class="source-line-no">187</span><span id="line-187"> } finally {</span>
<span class="source-line-no">188</span><span id="line-188"> admin.close();</span>
<span class="source-line-no">189</span><span id="line-189"> unmanagedConnection.close();</span>
<span class="source-line-no">190</span><span id="line-190"> }</span>
<span class="source-line-no">191</span><span id="line-191"> return totalNumberOfRegions;</span>
<span class="source-line-no">192</span><span id="line-192"> }</span>
<span class="source-line-no">193</span><span id="line-193"></span>
<span class="source-line-no">194</span><span id="line-194">}</span>
</pre>
</div>
</main>
</body>
</html>