blob: ee8f17e6eb0fa7cb6163ed7a108ba06f9dcc826b [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.regionserver, class: StripeStoreConfig">
<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.regionserver;</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 org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.regionserver.compactions.CompactionConfiguration;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23">import org.slf4j.Logger;</span>
<span class="source-line-no">024</span><span id="line-24">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">025</span><span id="line-25"></span>
<span class="source-line-no">026</span><span id="line-26">/**</span>
<span class="source-line-no">027</span><span id="line-27"> * Configuration class for stripe store and compactions. See {@link StripeStoreFileManager} for</span>
<span class="source-line-no">028</span><span id="line-28"> * general documentation. See getters for the description of each setting.</span>
<span class="source-line-no">029</span><span id="line-29"> */</span>
<span class="source-line-no">030</span><span id="line-30">@InterfaceAudience.Private</span>
<span class="source-line-no">031</span><span id="line-31">public class StripeStoreConfig {</span>
<span class="source-line-no">032</span><span id="line-32"> private static final Logger LOG = LoggerFactory.getLogger(StripeStoreConfig.class);</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34"> /** The maximum number of files to compact within a stripe; same as for regular compaction. */</span>
<span class="source-line-no">035</span><span id="line-35"> public static final String MAX_FILES_KEY = "hbase.store.stripe.compaction.maxFiles";</span>
<span class="source-line-no">036</span><span id="line-36"> /** The minimum number of files to compact within a stripe; same as for regular compaction. */</span>
<span class="source-line-no">037</span><span id="line-37"> public static final String MIN_FILES_KEY = "hbase.store.stripe.compaction.minFiles";</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> /**</span>
<span class="source-line-no">040</span><span id="line-40"> * The minimum number of files to compact when compacting L0; same as minFiles for regular</span>
<span class="source-line-no">041</span><span id="line-41"> * compaction. Given that L0 causes unnecessary overwriting of the data, should be higher than</span>
<span class="source-line-no">042</span><span id="line-42"> * regular minFiles.</span>
<span class="source-line-no">043</span><span id="line-43"> */</span>
<span class="source-line-no">044</span><span id="line-44"> public static final String MIN_FILES_L0_KEY = "hbase.store.stripe.compaction.minFilesL0";</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> /**</span>
<span class="source-line-no">047</span><span id="line-47"> * The size the stripe should achieve to be considered for splitting into multiple stripes. Stripe</span>
<span class="source-line-no">048</span><span id="line-48"> * will be split when it can be fully compacted, and it is above this size.</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 SIZE_TO_SPLIT_KEY = "hbase.store.stripe.sizeToSplit";</span>
<span class="source-line-no">051</span><span id="line-51"> /**</span>
<span class="source-line-no">052</span><span id="line-52"> * The target count of new stripes to produce when splitting a stripe. A floating point number,</span>
<span class="source-line-no">053</span><span id="line-53"> * default is 2. Values less than 1 will be converted to 1/x. Non-whole numbers will produce</span>
<span class="source-line-no">054</span><span id="line-54"> * unbalanced splits, which may be good for some cases. In this case the "smaller" of the new</span>
<span class="source-line-no">055</span><span id="line-55"> * stripes will always be the rightmost one. If the stripe is bigger than sizeToSplit when</span>
<span class="source-line-no">056</span><span id="line-56"> * splitting, this will be adjusted by a whole increment.</span>
<span class="source-line-no">057</span><span id="line-57"> */</span>
<span class="source-line-no">058</span><span id="line-58"> public static final String SPLIT_PARTS_KEY = "hbase.store.stripe.splitPartCount";</span>
<span class="source-line-no">059</span><span id="line-59"> /**</span>
<span class="source-line-no">060</span><span id="line-60"> * The initial stripe count to create. If the row distribution is roughly the same over time, it's</span>
<span class="source-line-no">061</span><span id="line-61"> * good to set this to a count of stripes that is expected to be achieved in most regions, to get</span>
<span class="source-line-no">062</span><span id="line-62"> * this count from the outset and prevent unnecessary splitting.</span>
<span class="source-line-no">063</span><span id="line-63"> */</span>
<span class="source-line-no">064</span><span id="line-64"> public static final String INITIAL_STRIPE_COUNT_KEY = "hbase.store.stripe.initialStripeCount";</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> /** Whether to flush memstore to L0 files, or directly to stripes. */</span>
<span class="source-line-no">067</span><span id="line-67"> public static final String FLUSH_TO_L0_KEY = "hbase.store.stripe.compaction.flushToL0";</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> /**</span>
<span class="source-line-no">070</span><span id="line-70"> * When splitting region, the maximum size imbalance to allow in an attempt to split at a stripe</span>
<span class="source-line-no">071</span><span id="line-71"> * boundary, so that no files go to both regions. Most users won't need to change that.</span>
<span class="source-line-no">072</span><span id="line-72"> */</span>
<span class="source-line-no">073</span><span id="line-73"> public static final String MAX_REGION_SPLIT_IMBALANCE_KEY =</span>
<span class="source-line-no">074</span><span id="line-74"> "hbase.store.stripe.region.split.max.imbalance";</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> private final float maxRegionSplitImbalance;</span>
<span class="source-line-no">077</span><span id="line-77"> private final int level0CompactMinFiles;</span>
<span class="source-line-no">078</span><span id="line-78"> private final int stripeCompactMinFiles;</span>
<span class="source-line-no">079</span><span id="line-79"> private final int stripeCompactMaxFiles;</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> private final int initialCount;</span>
<span class="source-line-no">082</span><span id="line-82"> private final long sizeToSplitAt;</span>
<span class="source-line-no">083</span><span id="line-83"> private final float splitPartCount;</span>
<span class="source-line-no">084</span><span id="line-84"> private final boolean flushIntoL0;</span>
<span class="source-line-no">085</span><span id="line-85"> private final long splitPartSize; // derived from sizeToSplitAt and splitPartCount</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> private static final double EPSILON = 0.001; // good enough for this, not a real epsilon.</span>
<span class="source-line-no">088</span><span id="line-88"></span>
<span class="source-line-no">089</span><span id="line-89"> public StripeStoreConfig(Configuration config, StoreConfigInformation sci) {</span>
<span class="source-line-no">090</span><span id="line-90"> this.level0CompactMinFiles = config.getInt(MIN_FILES_L0_KEY, 4);</span>
<span class="source-line-no">091</span><span id="line-91"> this.flushIntoL0 = config.getBoolean(FLUSH_TO_L0_KEY, false);</span>
<span class="source-line-no">092</span><span id="line-92"> int minMinFiles = flushIntoL0 ? 3 : 4; // make sure not to compact tiny files too often.</span>
<span class="source-line-no">093</span><span id="line-93"> int minFiles = config.getInt(CompactionConfiguration.HBASE_HSTORE_COMPACTION_MIN_KEY, -1);</span>
<span class="source-line-no">094</span><span id="line-94"> this.stripeCompactMinFiles = config.getInt(MIN_FILES_KEY, Math.max(minMinFiles, minFiles));</span>
<span class="source-line-no">095</span><span id="line-95"> this.stripeCompactMaxFiles = config.getInt(MAX_FILES_KEY,</span>
<span class="source-line-no">096</span><span id="line-96"> config.getInt(CompactionConfiguration.HBASE_HSTORE_COMPACTION_MAX_KEY, 10));</span>
<span class="source-line-no">097</span><span id="line-97"> this.maxRegionSplitImbalance = getFloat(config, MAX_REGION_SPLIT_IMBALANCE_KEY, 1.5f, true);</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> float splitPartCount = getFloat(config, SPLIT_PARTS_KEY, 2f, true);</span>
<span class="source-line-no">100</span><span id="line-100"> if (Math.abs(splitPartCount - 1.0) &lt; EPSILON) {</span>
<span class="source-line-no">101</span><span id="line-101"> LOG.error("Split part count cannot be 1 (" + splitPartCount + "), using the default");</span>
<span class="source-line-no">102</span><span id="line-102"> splitPartCount = 2f;</span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104"> this.splitPartCount = splitPartCount;</span>
<span class="source-line-no">105</span><span id="line-105"> // Arbitrary default split size - 4 times the size of one L0 compaction.</span>
<span class="source-line-no">106</span><span id="line-106"> // If we flush into L0 there's no split compaction, but for default value it is ok.</span>
<span class="source-line-no">107</span><span id="line-107"> double flushSize = sci.getMemStoreFlushSize();</span>
<span class="source-line-no">108</span><span id="line-108"> if (flushSize == 0) {</span>
<span class="source-line-no">109</span><span id="line-109"> flushSize = 128 * 1024 * 1024;</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"> long defaultSplitSize = (long) (flushSize * getLevel0MinFiles() * 4 * splitPartCount);</span>
<span class="source-line-no">112</span><span id="line-112"> this.sizeToSplitAt = config.getLong(SIZE_TO_SPLIT_KEY, defaultSplitSize);</span>
<span class="source-line-no">113</span><span id="line-113"> int initialCount = config.getInt(INITIAL_STRIPE_COUNT_KEY, 1);</span>
<span class="source-line-no">114</span><span id="line-114"> if (initialCount == 0) {</span>
<span class="source-line-no">115</span><span id="line-115"> LOG.error("Initial stripe count is 0, using the default");</span>
<span class="source-line-no">116</span><span id="line-116"> initialCount = 1;</span>
<span class="source-line-no">117</span><span id="line-117"> }</span>
<span class="source-line-no">118</span><span id="line-118"> this.initialCount = initialCount;</span>
<span class="source-line-no">119</span><span id="line-119"> this.splitPartSize = (long) (this.sizeToSplitAt / this.splitPartCount);</span>
<span class="source-line-no">120</span><span id="line-120"> }</span>
<span class="source-line-no">121</span><span id="line-121"></span>
<span class="source-line-no">122</span><span id="line-122"> private static float getFloat(Configuration config, String key, float defaultValue,</span>
<span class="source-line-no">123</span><span id="line-123"> boolean moreThanOne) {</span>
<span class="source-line-no">124</span><span id="line-124"> float value = config.getFloat(key, defaultValue);</span>
<span class="source-line-no">125</span><span id="line-125"> if (value &lt; EPSILON) {</span>
<span class="source-line-no">126</span><span id="line-126"> LOG.warn(</span>
<span class="source-line-no">127</span><span id="line-127"> String.format("%s is set to 0 or negative; using default value of %f", key, defaultValue));</span>
<span class="source-line-no">128</span><span id="line-128"> value = defaultValue;</span>
<span class="source-line-no">129</span><span id="line-129"> } else if ((value &gt; 1f) != moreThanOne) {</span>
<span class="source-line-no">130</span><span id="line-130"> value = 1f / value;</span>
<span class="source-line-no">131</span><span id="line-131"> }</span>
<span class="source-line-no">132</span><span id="line-132"> return value;</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"> public float getMaxSplitImbalance() {</span>
<span class="source-line-no">136</span><span id="line-136"> return this.maxRegionSplitImbalance;</span>
<span class="source-line-no">137</span><span id="line-137"> }</span>
<span class="source-line-no">138</span><span id="line-138"></span>
<span class="source-line-no">139</span><span id="line-139"> public int getLevel0MinFiles() {</span>
<span class="source-line-no">140</span><span id="line-140"> return level0CompactMinFiles;</span>
<span class="source-line-no">141</span><span id="line-141"> }</span>
<span class="source-line-no">142</span><span id="line-142"></span>
<span class="source-line-no">143</span><span id="line-143"> public int getStripeCompactMinFiles() {</span>
<span class="source-line-no">144</span><span id="line-144"> return stripeCompactMinFiles;</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"> public int getStripeCompactMaxFiles() {</span>
<span class="source-line-no">148</span><span id="line-148"> return stripeCompactMaxFiles;</span>
<span class="source-line-no">149</span><span id="line-149"> }</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 boolean isUsingL0Flush() {</span>
<span class="source-line-no">152</span><span id="line-152"> return flushIntoL0;</span>
<span class="source-line-no">153</span><span id="line-153"> }</span>
<span class="source-line-no">154</span><span id="line-154"></span>
<span class="source-line-no">155</span><span id="line-155"> public long getSplitSize() {</span>
<span class="source-line-no">156</span><span id="line-156"> return sizeToSplitAt;</span>
<span class="source-line-no">157</span><span id="line-157"> }</span>
<span class="source-line-no">158</span><span id="line-158"></span>
<span class="source-line-no">159</span><span id="line-159"> public int getInitialCount() {</span>
<span class="source-line-no">160</span><span id="line-160"> return initialCount;</span>
<span class="source-line-no">161</span><span id="line-161"> }</span>
<span class="source-line-no">162</span><span id="line-162"></span>
<span class="source-line-no">163</span><span id="line-163"> public float getSplitCount() {</span>
<span class="source-line-no">164</span><span id="line-164"> return splitPartCount;</span>
<span class="source-line-no">165</span><span id="line-165"> }</span>
<span class="source-line-no">166</span><span id="line-166"></span>
<span class="source-line-no">167</span><span id="line-167"> /**</span>
<span class="source-line-no">168</span><span id="line-168"> * @return the desired size of the target stripe when splitting, in bytes. Derived from</span>
<span class="source-line-no">169</span><span id="line-169"> * {@link #getSplitSize()} and {@link #getSplitCount()}.</span>
<span class="source-line-no">170</span><span id="line-170"> */</span>
<span class="source-line-no">171</span><span id="line-171"> public long getSplitPartSize() {</span>
<span class="source-line-no">172</span><span id="line-172"> return splitPartSize;</span>
<span class="source-line-no">173</span><span id="line-173"> }</span>
<span class="source-line-no">174</span><span id="line-174">}</span>
</pre>
</div>
</main>
</body>
</html>