blob: e891806003360a712146724ca32447d2360af834 [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.throttle, class: PressureAwareCompactionThroughputController">
<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.throttle;</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.HBaseInterfaceAudience;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.ScheduledChore;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.regionserver.RegionServerServices;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.regionserver.compactions.OffPeakHours;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">026</span><span id="line-26">import org.slf4j.Logger;</span>
<span class="source-line-no">027</span><span id="line-27">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">028</span><span id="line-28"></span>
<span class="source-line-no">029</span><span id="line-29">/**</span>
<span class="source-line-no">030</span><span id="line-30"> * A throughput controller which uses the follow schema to limit throughput</span>
<span class="source-line-no">031</span><span id="line-31"> * &lt;ul&gt;</span>
<span class="source-line-no">032</span><span id="line-32"> * &lt;li&gt;If compaction pressure is greater than 1.0, no limitation.&lt;/li&gt;</span>
<span class="source-line-no">033</span><span id="line-33"> * &lt;li&gt;In off peak hours, use a fixed throughput limitation</span>
<span class="source-line-no">034</span><span id="line-34"> * {@value #HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK}&lt;/li&gt;</span>
<span class="source-line-no">035</span><span id="line-35"> * &lt;li&gt;In normal hours, the max throughput is tuned between</span>
<span class="source-line-no">036</span><span id="line-36"> * {@value #HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND} and</span>
<span class="source-line-no">037</span><span id="line-37"> * {@value #HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND}, using the formula &amp;quot;lower +</span>
<span class="source-line-no">038</span><span id="line-38"> * (higer - lower) * compactionPressure&amp;quot;, where compactionPressure is in range [0.0, 1.0]&lt;/li&gt;</span>
<span class="source-line-no">039</span><span id="line-39"> * &lt;/ul&gt;</span>
<span class="source-line-no">040</span><span id="line-40"> * @see org.apache.hadoop.hbase.regionserver.HStore#getCompactionPressure()</span>
<span class="source-line-no">041</span><span id="line-41"> */</span>
<span class="source-line-no">042</span><span id="line-42">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)</span>
<span class="source-line-no">043</span><span id="line-43">public class PressureAwareCompactionThroughputController extends PressureAwareThroughputController {</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> private final static Logger LOG =</span>
<span class="source-line-no">046</span><span id="line-46"> LoggerFactory.getLogger(PressureAwareCompactionThroughputController.class);</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> public static final String HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND =</span>
<span class="source-line-no">049</span><span id="line-49"> "hbase.hstore.compaction.throughput.higher.bound";</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> private static final long DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND =</span>
<span class="source-line-no">052</span><span id="line-52"> 100L * 1024 * 1024;</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> public static final String HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND =</span>
<span class="source-line-no">055</span><span id="line-55"> "hbase.hstore.compaction.throughput.lower.bound";</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> private static final long DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND =</span>
<span class="source-line-no">058</span><span id="line-58"> 50L * 1024 * 1024;</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> public static final String HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK =</span>
<span class="source-line-no">061</span><span id="line-61"> "hbase.hstore.compaction.throughput.offpeak";</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> private static final long DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK = Long.MAX_VALUE;</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> public static final String HBASE_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD =</span>
<span class="source-line-no">066</span><span id="line-66"> "hbase.hstore.compaction.throughput.tune.period";</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> private static final int DEFAULT_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD = 60 * 1000;</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> // check compaction throughput every this size</span>
<span class="source-line-no">071</span><span id="line-71"> private static final String HBASE_HSTORE_COMPACTION_THROUGHPUT_CONTROL_CHECK_INTERVAL =</span>
<span class="source-line-no">072</span><span id="line-72"> "hbase.hstore.compaction.throughput.control.check.interval";</span>
<span class="source-line-no">073</span><span id="line-73"></span>
<span class="source-line-no">074</span><span id="line-74"> private long maxThroughputOffpeak;</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> @Override</span>
<span class="source-line-no">077</span><span id="line-77"> public void setup(final RegionServerServices server) {</span>
<span class="source-line-no">078</span><span id="line-78"> server.getChoreService()</span>
<span class="source-line-no">079</span><span id="line-79"> .scheduleChore(new ScheduledChore("CompactionThroughputTuner", this, tuningPeriod) {</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> @Override</span>
<span class="source-line-no">082</span><span id="line-82"> protected void chore() {</span>
<span class="source-line-no">083</span><span id="line-83"> tune(server.getCompactionPressure());</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"> });</span>
<span class="source-line-no">086</span><span id="line-86"> }</span>
<span class="source-line-no">087</span><span id="line-87"></span>
<span class="source-line-no">088</span><span id="line-88"> private void tune(double compactionPressure) {</span>
<span class="source-line-no">089</span><span id="line-89"> double maxThroughputToSet;</span>
<span class="source-line-no">090</span><span id="line-90"> if (compactionPressure &gt; 1.0) {</span>
<span class="source-line-no">091</span><span id="line-91"> // set to unlimited if some stores already reach the blocking store file count</span>
<span class="source-line-no">092</span><span id="line-92"> maxThroughputToSet = Double.MAX_VALUE;</span>
<span class="source-line-no">093</span><span id="line-93"> } else if (offPeakHours.isOffPeakHour()) {</span>
<span class="source-line-no">094</span><span id="line-94"> maxThroughputToSet = maxThroughputOffpeak;</span>
<span class="source-line-no">095</span><span id="line-95"> } else {</span>
<span class="source-line-no">096</span><span id="line-96"> // compactionPressure is between 0.0 and 1.0, we use a simple linear formula to</span>
<span class="source-line-no">097</span><span id="line-97"> // calculate the throughput limitation.</span>
<span class="source-line-no">098</span><span id="line-98"> maxThroughputToSet = maxThroughputLowerBound</span>
<span class="source-line-no">099</span><span id="line-99"> + (maxThroughputUpperBound - maxThroughputLowerBound) * compactionPressure;</span>
<span class="source-line-no">100</span><span id="line-100"> }</span>
<span class="source-line-no">101</span><span id="line-101"> if (LOG.isDebugEnabled()) {</span>
<span class="source-line-no">102</span><span id="line-102"> if (Math.abs(maxThroughputToSet - getMaxThroughput()) &gt;= .0000001) {</span>
<span class="source-line-no">103</span><span id="line-103"> LOG.debug("CompactionPressure is " + compactionPressure + ", tune throughput to "</span>
<span class="source-line-no">104</span><span id="line-104"> + throughputDesc(maxThroughputToSet));</span>
<span class="source-line-no">105</span><span id="line-105"> } else if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">106</span><span id="line-106"> LOG.trace("CompactionPressure is " + compactionPressure + ", keep throughput throttling to "</span>
<span class="source-line-no">107</span><span id="line-107"> + throughputDesc(maxThroughputToSet));</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"> this.setMaxThroughput(maxThroughputToSet);</span>
<span class="source-line-no">111</span><span id="line-111"> }</span>
<span class="source-line-no">112</span><span id="line-112"></span>
<span class="source-line-no">113</span><span id="line-113"> @Override</span>
<span class="source-line-no">114</span><span id="line-114"> public void setConf(Configuration conf) {</span>
<span class="source-line-no">115</span><span id="line-115"> super.setConf(conf);</span>
<span class="source-line-no">116</span><span id="line-116"> if (conf == null) {</span>
<span class="source-line-no">117</span><span id="line-117"> return;</span>
<span class="source-line-no">118</span><span id="line-118"> }</span>
<span class="source-line-no">119</span><span id="line-119"> this.maxThroughputUpperBound = conf.getLong(HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND,</span>
<span class="source-line-no">120</span><span id="line-120"> DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_HIGHER_BOUND);</span>
<span class="source-line-no">121</span><span id="line-121"> this.maxThroughputLowerBound = conf.getLong(HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND,</span>
<span class="source-line-no">122</span><span id="line-122"> DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_LOWER_BOUND);</span>
<span class="source-line-no">123</span><span id="line-123"> this.maxThroughputOffpeak = conf.getLong(HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK,</span>
<span class="source-line-no">124</span><span id="line-124"> DEFAULT_HBASE_HSTORE_COMPACTION_MAX_THROUGHPUT_OFFPEAK);</span>
<span class="source-line-no">125</span><span id="line-125"> this.offPeakHours = OffPeakHours.getInstance(conf);</span>
<span class="source-line-no">126</span><span id="line-126"> this.controlPerSize = conf.getLong(HBASE_HSTORE_COMPACTION_THROUGHPUT_CONTROL_CHECK_INTERVAL,</span>
<span class="source-line-no">127</span><span id="line-127"> this.maxThroughputLowerBound);</span>
<span class="source-line-no">128</span><span id="line-128"> this.setMaxThroughput(this.maxThroughputLowerBound);</span>
<span class="source-line-no">129</span><span id="line-129"> this.tuningPeriod = getConf().getInt(HBASE_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD,</span>
<span class="source-line-no">130</span><span id="line-130"> DEFAULT_HSTORE_COMPACTION_THROUGHPUT_TUNE_PERIOD);</span>
<span class="source-line-no">131</span><span id="line-131"> LOG.info("Compaction throughput configurations, higher bound: "</span>
<span class="source-line-no">132</span><span id="line-132"> + throughputDesc(maxThroughputUpperBound) + ", lower bound "</span>
<span class="source-line-no">133</span><span id="line-133"> + throughputDesc(maxThroughputLowerBound) + ", off peak: "</span>
<span class="source-line-no">134</span><span id="line-134"> + throughputDesc(maxThroughputOffpeak) + ", tuning period: " + tuningPeriod + " ms");</span>
<span class="source-line-no">135</span><span id="line-135"> }</span>
<span class="source-line-no">136</span><span id="line-136"></span>
<span class="source-line-no">137</span><span id="line-137"> @Override</span>
<span class="source-line-no">138</span><span id="line-138"> public String toString() {</span>
<span class="source-line-no">139</span><span id="line-139"> return "DefaultCompactionThroughputController [maxThroughput="</span>
<span class="source-line-no">140</span><span id="line-140"> + throughputDesc(getMaxThroughput()) + ", activeCompactions=" + activeOperations.size() + "]";</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>
</pre>
</div>
</main>
</body>
</html>