| <!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.quotas, class: FileSystemUtilizationChore"> |
| <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.quotas;</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.util.HashSet;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Iterator;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Set;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.ScheduledChore;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.RegionInfo;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.regionserver.HRegion;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.regionserver.HRegionServer;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.regionserver.Region;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.regionserver.Store;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.slf4j.Logger;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36">/**</span> |
| <span class="source-line-no">037</span><span id="line-37"> * A chore which computes the size of each {@link HRegion} on the FileSystem hosted by the given</span> |
| <span class="source-line-no">038</span><span id="line-38"> * {@link HRegionServer}. The results of this computation are stored in the</span> |
| <span class="source-line-no">039</span><span id="line-39"> * {@link RegionServerSpaceQuotaManager}'s {@link RegionSizeStore} object.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.Private</span> |
| <span class="source-line-no">042</span><span id="line-42">public class FileSystemUtilizationChore extends ScheduledChore {</span> |
| <span class="source-line-no">043</span><span id="line-43"> private static final Logger LOG = LoggerFactory.getLogger(FileSystemUtilizationChore.class);</span> |
| <span class="source-line-no">044</span><span id="line-44"> static final String FS_UTILIZATION_CHORE_PERIOD_KEY =</span> |
| <span class="source-line-no">045</span><span id="line-45"> "hbase.regionserver.quotas.fs.utilization.chore.period";</span> |
| <span class="source-line-no">046</span><span id="line-46"> static final int FS_UTILIZATION_CHORE_PERIOD_DEFAULT = 1000 * 60 * 5; // 5 minutes in millis</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> static final String FS_UTILIZATION_CHORE_DELAY_KEY =</span> |
| <span class="source-line-no">049</span><span id="line-49"> "hbase.regionserver.quotas.fs.utilization.chore.delay";</span> |
| <span class="source-line-no">050</span><span id="line-50"> static final long FS_UTILIZATION_CHORE_DELAY_DEFAULT = 1000L * 60L; // 1 minute</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> static final String FS_UTILIZATION_CHORE_TIMEUNIT_KEY =</span> |
| <span class="source-line-no">053</span><span id="line-53"> "hbase.regionserver.quotas.fs.utilization.chore.timeunit";</span> |
| <span class="source-line-no">054</span><span id="line-54"> static final String FS_UTILIZATION_CHORE_TIMEUNIT_DEFAULT = TimeUnit.MILLISECONDS.name();</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> static final String FS_UTILIZATION_MAX_ITERATION_DURATION_KEY =</span> |
| <span class="source-line-no">057</span><span id="line-57"> "hbase.regionserver.quotas.fs.utilization.chore.max.iteration.millis";</span> |
| <span class="source-line-no">058</span><span id="line-58"> static final long FS_UTILIZATION_MAX_ITERATION_DURATION_DEFAULT = 5000L;</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> private final HRegionServer rs;</span> |
| <span class="source-line-no">061</span><span id="line-61"> private final long maxIterationMillis;</span> |
| <span class="source-line-no">062</span><span id="line-62"> private Iterator<Region> leftoverRegions;</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 FileSystemUtilizationChore(HRegionServer rs) {</span> |
| <span class="source-line-no">065</span><span id="line-65"> super(FileSystemUtilizationChore.class.getSimpleName(), rs, getPeriod(rs.getConfiguration()),</span> |
| <span class="source-line-no">066</span><span id="line-66"> getInitialDelay(rs.getConfiguration()), getTimeUnit(rs.getConfiguration()));</span> |
| <span class="source-line-no">067</span><span id="line-67"> this.rs = rs;</span> |
| <span class="source-line-no">068</span><span id="line-68"> this.maxIterationMillis = rs.getConfiguration().getLong(</span> |
| <span class="source-line-no">069</span><span id="line-69"> FS_UTILIZATION_MAX_ITERATION_DURATION_KEY, FS_UTILIZATION_MAX_ITERATION_DURATION_DEFAULT);</span> |
| <span class="source-line-no">070</span><span id="line-70"> }</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> @Override</span> |
| <span class="source-line-no">073</span><span id="line-73"> protected void chore() {</span> |
| <span class="source-line-no">074</span><span id="line-74"> final RegionSizeStore regionSizeStore = getRegionSizeStore();</span> |
| <span class="source-line-no">075</span><span id="line-75"> final Set<Region> onlineRegions = new HashSet<>(rs.getRegions());</span> |
| <span class="source-line-no">076</span><span id="line-76"> // Process the regions from the last run if we have any. If we are somehow having difficulty</span> |
| <span class="source-line-no">077</span><span id="line-77"> // processing the Regions, we want to avoid creating a backlog in memory of Region objs.</span> |
| <span class="source-line-no">078</span><span id="line-78"> Iterator<Region> oldRegionsToProcess = getLeftoverRegions();</span> |
| <span class="source-line-no">079</span><span id="line-79"> final Iterator<Region> iterator;</span> |
| <span class="source-line-no">080</span><span id="line-80"> final boolean processingLeftovers;</span> |
| <span class="source-line-no">081</span><span id="line-81"> if (oldRegionsToProcess == null) {</span> |
| <span class="source-line-no">082</span><span id="line-82"> iterator = onlineRegions.iterator();</span> |
| <span class="source-line-no">083</span><span id="line-83"> processingLeftovers = false;</span> |
| <span class="source-line-no">084</span><span id="line-84"> } else {</span> |
| <span class="source-line-no">085</span><span id="line-85"> iterator = oldRegionsToProcess;</span> |
| <span class="source-line-no">086</span><span id="line-86"> processingLeftovers = true;</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"> // Reset the leftoverRegions and let the loop re-assign if necessary.</span> |
| <span class="source-line-no">089</span><span id="line-89"> setLeftoverRegions(null);</span> |
| <span class="source-line-no">090</span><span id="line-90"> long regionSizesCalculated = 0L;</span> |
| <span class="source-line-no">091</span><span id="line-91"> long offlineRegionsSkipped = 0L;</span> |
| <span class="source-line-no">092</span><span id="line-92"> long skippedSplitParents = 0L;</span> |
| <span class="source-line-no">093</span><span id="line-93"> long skippedRegionReplicas = 0L;</span> |
| <span class="source-line-no">094</span><span id="line-94"> final long start = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">095</span><span id="line-95"> while (iterator.hasNext()) {</span> |
| <span class="source-line-no">096</span><span id="line-96"> // Make sure this chore doesn't hog the thread.</span> |
| <span class="source-line-no">097</span><span id="line-97"> long timeRunning = EnvironmentEdgeManager.currentTime() - start;</span> |
| <span class="source-line-no">098</span><span id="line-98"> if (timeRunning > maxIterationMillis) {</span> |
| <span class="source-line-no">099</span><span id="line-99"> LOG.debug("Preempting execution of FileSystemUtilizationChore because it exceeds the"</span> |
| <span class="source-line-no">100</span><span id="line-100"> + " maximum iteration configuration value. Will process remaining Regions"</span> |
| <span class="source-line-no">101</span><span id="line-101"> + " on a subsequent invocation.");</span> |
| <span class="source-line-no">102</span><span id="line-102"> setLeftoverRegions(iterator);</span> |
| <span class="source-line-no">103</span><span id="line-103"> break;</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> final Region region = iterator.next();</span> |
| <span class="source-line-no">107</span><span id="line-107"> // If we're processing leftover regions, the region may no-longer be online.</span> |
| <span class="source-line-no">108</span><span id="line-108"> // If so, we can skip it.</span> |
| <span class="source-line-no">109</span><span id="line-109"> if (processingLeftovers && !onlineRegions.contains(region)) {</span> |
| <span class="source-line-no">110</span><span id="line-110"> offlineRegionsSkipped++;</span> |
| <span class="source-line-no">111</span><span id="line-111"> continue;</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"> // Avoid computing the size of regions which are the parent of split.</span> |
| <span class="source-line-no">114</span><span id="line-114"> if (region.getRegionInfo().isSplitParent()) {</span> |
| <span class="source-line-no">115</span><span id="line-115"> skippedSplitParents++;</span> |
| <span class="source-line-no">116</span><span id="line-116"> continue;</span> |
| <span class="source-line-no">117</span><span id="line-117"> }</span> |
| <span class="source-line-no">118</span><span id="line-118"> // Avoid computing the size of region replicas.</span> |
| <span class="source-line-no">119</span><span id="line-119"> if (RegionInfo.DEFAULT_REPLICA_ID != region.getRegionInfo().getReplicaId()) {</span> |
| <span class="source-line-no">120</span><span id="line-120"> skippedRegionReplicas++;</span> |
| <span class="source-line-no">121</span><span id="line-121"> continue;</span> |
| <span class="source-line-no">122</span><span id="line-122"> }</span> |
| <span class="source-line-no">123</span><span id="line-123"> final long sizeInBytes = computeSize(region);</span> |
| <span class="source-line-no">124</span><span id="line-124"> regionSizeStore.put(region.getRegionInfo(), sizeInBytes);</span> |
| <span class="source-line-no">125</span><span id="line-125"> regionSizesCalculated++;</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">128</span><span id="line-128"> LOG.trace("Computed the size of " + regionSizesCalculated + " Regions. Skipped computation"</span> |
| <span class="source-line-no">129</span><span id="line-129"> + " of " + offlineRegionsSkipped + " regions due to not being online on this RS, "</span> |
| <span class="source-line-no">130</span><span id="line-130"> + skippedSplitParents + " regions due to being the parent of a split, and"</span> |
| <span class="source-line-no">131</span><span id="line-131"> + skippedRegionReplicas + " regions due to being region replicas.");</span> |
| <span class="source-line-no">132</span><span id="line-132"> }</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"> * Returns an {@link Iterator} over the Regions which were skipped last invocation of the chore.</span> |
| <span class="source-line-no">137</span><span id="line-137"> * @return Regions from the previous invocation to process, or null.</span> |
| <span class="source-line-no">138</span><span id="line-138"> */</span> |
| <span class="source-line-no">139</span><span id="line-139"> Iterator<Region> getLeftoverRegions() {</span> |
| <span class="source-line-no">140</span><span id="line-140"> return leftoverRegions;</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"> /**</span> |
| <span class="source-line-no">144</span><span id="line-144"> * Sets a new collection of Regions as leftovers.</span> |
| <span class="source-line-no">145</span><span id="line-145"> */</span> |
| <span class="source-line-no">146</span><span id="line-146"> void setLeftoverRegions(Iterator<Region> newLeftovers) {</span> |
| <span class="source-line-no">147</span><span id="line-147"> this.leftoverRegions = newLeftovers;</span> |
| <span class="source-line-no">148</span><span id="line-148"> }</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"> * Computes total FileSystem size for the given {@link Region}.</span> |
| <span class="source-line-no">152</span><span id="line-152"> * @param r The region</span> |
| <span class="source-line-no">153</span><span id="line-153"> * @return The size, in bytes, of the Region.</span> |
| <span class="source-line-no">154</span><span id="line-154"> */</span> |
| <span class="source-line-no">155</span><span id="line-155"> long computeSize(Region r) {</span> |
| <span class="source-line-no">156</span><span id="line-156"> long regionSize = 0L;</span> |
| <span class="source-line-no">157</span><span id="line-157"> for (Store store : r.getStores()) {</span> |
| <span class="source-line-no">158</span><span id="line-158"> regionSize += store.getHFilesSize();</span> |
| <span class="source-line-no">159</span><span id="line-159"> }</span> |
| <span class="source-line-no">160</span><span id="line-160"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">161</span><span id="line-161"> LOG.trace("Size of " + r + " is " + regionSize);</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163"> return regionSize;</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"></span> |
| <span class="source-line-no">166</span><span id="line-166"> // visible for testing</span> |
| <span class="source-line-no">167</span><span id="line-167"> RegionSizeStore getRegionSizeStore() {</span> |
| <span class="source-line-no">168</span><span id="line-168"> return rs.getRegionServerSpaceQuotaManager().getRegionSizeStore();</span> |
| <span class="source-line-no">169</span><span id="line-169"> }</span> |
| <span class="source-line-no">170</span><span id="line-170"></span> |
| <span class="source-line-no">171</span><span id="line-171"> /**</span> |
| <span class="source-line-no">172</span><span id="line-172"> * Extracts the period for the chore from the configuration.</span> |
| <span class="source-line-no">173</span><span id="line-173"> * @param conf The configuration object.</span> |
| <span class="source-line-no">174</span><span id="line-174"> * @return The configured chore period or the default value.</span> |
| <span class="source-line-no">175</span><span id="line-175"> */</span> |
| <span class="source-line-no">176</span><span id="line-176"> static int getPeriod(Configuration conf) {</span> |
| <span class="source-line-no">177</span><span id="line-177"> return conf.getInt(FS_UTILIZATION_CHORE_PERIOD_KEY, FS_UTILIZATION_CHORE_PERIOD_DEFAULT);</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"></span> |
| <span class="source-line-no">180</span><span id="line-180"> /**</span> |
| <span class="source-line-no">181</span><span id="line-181"> * Extracts the initial delay for the chore from the configuration.</span> |
| <span class="source-line-no">182</span><span id="line-182"> * @param conf The configuration object.</span> |
| <span class="source-line-no">183</span><span id="line-183"> * @return The configured chore initial delay or the default value.</span> |
| <span class="source-line-no">184</span><span id="line-184"> */</span> |
| <span class="source-line-no">185</span><span id="line-185"> static long getInitialDelay(Configuration conf) {</span> |
| <span class="source-line-no">186</span><span id="line-186"> return conf.getLong(FS_UTILIZATION_CHORE_DELAY_KEY, FS_UTILIZATION_CHORE_DELAY_DEFAULT);</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> |
| <span class="source-line-no">189</span><span id="line-189"> /**</span> |
| <span class="source-line-no">190</span><span id="line-190"> * Extracts the time unit for the chore period and initial delay from the configuration. The</span> |
| <span class="source-line-no">191</span><span id="line-191"> * configuration value for {@link #FS_UTILIZATION_CHORE_TIMEUNIT_KEY} must correspond to a</span> |
| <span class="source-line-no">192</span><span id="line-192"> * {@link TimeUnit} value.</span> |
| <span class="source-line-no">193</span><span id="line-193"> * @param conf The configuration object.</span> |
| <span class="source-line-no">194</span><span id="line-194"> * @return The configured time unit for the chore period and initial delay or the default value.</span> |
| <span class="source-line-no">195</span><span id="line-195"> */</span> |
| <span class="source-line-no">196</span><span id="line-196"> static TimeUnit getTimeUnit(Configuration conf) {</span> |
| <span class="source-line-no">197</span><span id="line-197"> return TimeUnit</span> |
| <span class="source-line-no">198</span><span id="line-198"> .valueOf(conf.get(FS_UTILIZATION_CHORE_TIMEUNIT_KEY, FS_UTILIZATION_CHORE_TIMEUNIT_DEFAULT));</span> |
| <span class="source-line-no">199</span><span id="line-199"> }</span> |
| <span class="source-line-no">200</span><span id="line-200">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |