| <!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, class: ResourceChecker, class: ResourceAnalyzer"> |
| <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;</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.ArrayList;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.List;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.slf4j.Logger;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">024</span><span id="line-24"></span> |
| <span class="source-line-no">025</span><span id="line-25">/**</span> |
| <span class="source-line-no">026</span><span id="line-26"> * Utility class to check the resources: - log them before and after each test method - check them</span> |
| <span class="source-line-no">027</span><span id="line-27"> * against a minimum or maximum - check that they don't leak during the test</span> |
| <span class="source-line-no">028</span><span id="line-28"> */</span> |
| <span class="source-line-no">029</span><span id="line-29">public class ResourceChecker {</span> |
| <span class="source-line-no">030</span><span id="line-30"> private static final Logger LOG = LoggerFactory.getLogger(ResourceChecker.class);</span> |
| <span class="source-line-no">031</span><span id="line-31"> private String tagLine;</span> |
| <span class="source-line-no">032</span><span id="line-32"></span> |
| <span class="source-line-no">033</span><span id="line-33"> enum Phase {</span> |
| <span class="source-line-no">034</span><span id="line-34"> INITIAL,</span> |
| <span class="source-line-no">035</span><span id="line-35"> INTERMEDIATE,</span> |
| <span class="source-line-no">036</span><span id="line-36"> END</span> |
| <span class="source-line-no">037</span><span id="line-37"> }</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"> * Constructor</span> |
| <span class="source-line-no">041</span><span id="line-41"> * @param tagLine The tagLine is added to the logs. Must not be null.</span> |
| <span class="source-line-no">042</span><span id="line-42"> */</span> |
| <span class="source-line-no">043</span><span id="line-43"> public ResourceChecker(final String tagLine) {</span> |
| <span class="source-line-no">044</span><span id="line-44"> this.tagLine = tagLine;</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"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Class to implement for each type of resource.</span> |
| <span class="source-line-no">049</span><span id="line-49"> */</span> |
| <span class="source-line-no">050</span><span id="line-50"> abstract static class ResourceAnalyzer {</span> |
| <span class="source-line-no">051</span><span id="line-51"> /**</span> |
| <span class="source-line-no">052</span><span id="line-52"> * Maximum we set for the resource. Will get a warning in logs if we go over this limit.</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 int getMax() {</span> |
| <span class="source-line-no">055</span><span id="line-55"> return Integer.MAX_VALUE;</span> |
| <span class="source-line-no">056</span><span id="line-56"> }</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /**</span> |
| <span class="source-line-no">059</span><span id="line-59"> * Minimum we set for the resource. Will get a warning in logs if we go under this limit.</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61"> public int getMin() {</span> |
| <span class="source-line-no">062</span><span id="line-62"> return Integer.MIN_VALUE;</span> |
| <span class="source-line-no">063</span><span id="line-63"> }</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> /**</span> |
| <span class="source-line-no">066</span><span id="line-66"> * Name of the resource analyzed. By default extracted from the class name, but can be</span> |
| <span class="source-line-no">067</span><span id="line-67"> * overridden by the subclasses.</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> public String getName() {</span> |
| <span class="source-line-no">070</span><span id="line-70"> String className = this.getClass().getSimpleName();</span> |
| <span class="source-line-no">071</span><span id="line-71"> final String extName = ResourceAnalyzer.class.getSimpleName();</span> |
| <span class="source-line-no">072</span><span id="line-72"> if (className.endsWith(extName)) {</span> |
| <span class="source-line-no">073</span><span id="line-73"> return className.substring(0, className.length() - extName.length());</span> |
| <span class="source-line-no">074</span><span id="line-74"> } else {</span> |
| <span class="source-line-no">075</span><span id="line-75"> return className;</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"> }</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"> * The value for the resource.</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @param phase the {@link Phase} to get the value for</span> |
| <span class="source-line-no">082</span><span id="line-82"> */</span> |
| <span class="source-line-no">083</span><span id="line-83"> abstract public int getVal(Phase phase);</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"> * Retrieves List of Strings which would be logged in logEndings()</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> public List<String> getStringsToLog() {</span> |
| <span class="source-line-no">089</span><span id="line-89"> return null;</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"> private List<ResourceAnalyzer> ras = new ArrayList<>();</span> |
| <span class="source-line-no">094</span><span id="line-94"> private int[] initialValues;</span> |
| <span class="source-line-no">095</span><span id="line-95"> private int[] endingValues;</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> private void fillInit() {</span> |
| <span class="source-line-no">098</span><span id="line-98"> initialValues = new int[ras.size()];</span> |
| <span class="source-line-no">099</span><span id="line-99"> fill(Phase.INITIAL, initialValues);</span> |
| <span class="source-line-no">100</span><span id="line-100"> }</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> private void fillEndings() {</span> |
| <span class="source-line-no">103</span><span id="line-103"> endingValues = new int[ras.size()];</span> |
| <span class="source-line-no">104</span><span id="line-104"> fill(Phase.END, endingValues);</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> private void fill(Phase phase, int[] vals) {</span> |
| <span class="source-line-no">108</span><span id="line-108"> int i = 0;</span> |
| <span class="source-line-no">109</span><span id="line-109"> for (ResourceAnalyzer ra : ras) {</span> |
| <span class="source-line-no">110</span><span id="line-110"> vals[i++] = ra.getVal(phase);</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"></span> |
| <span class="source-line-no">114</span><span id="line-114"> public void checkInit() {</span> |
| <span class="source-line-no">115</span><span id="line-115"> check(initialValues);</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"></span> |
| <span class="source-line-no">118</span><span id="line-118"> private void checkEndings() {</span> |
| <span class="source-line-no">119</span><span id="line-119"> check(endingValues);</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 void check(int[] vals) {</span> |
| <span class="source-line-no">123</span><span id="line-123"> int i = 0;</span> |
| <span class="source-line-no">124</span><span id="line-124"> for (ResourceAnalyzer ra : ras) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> int cur = vals[i++];</span> |
| <span class="source-line-no">126</span><span id="line-126"> if (cur < ra.getMin()) {</span> |
| <span class="source-line-no">127</span><span id="line-127"> LOG.warn(ra.getName() + "=" + cur + " is inferior to " + ra.getMin());</span> |
| <span class="source-line-no">128</span><span id="line-128"> }</span> |
| <span class="source-line-no">129</span><span id="line-129"> if (cur > ra.getMax()) {</span> |
| <span class="source-line-no">130</span><span id="line-130"> LOG.warn(ra.getName() + "=" + cur + " is superior to " + ra.getMax());</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</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"> private void logInit() {</span> |
| <span class="source-line-no">136</span><span id="line-136"> int i = 0;</span> |
| <span class="source-line-no">137</span><span id="line-137"> StringBuilder sb = new StringBuilder();</span> |
| <span class="source-line-no">138</span><span id="line-138"> for (ResourceAnalyzer ra : ras) {</span> |
| <span class="source-line-no">139</span><span id="line-139"> int cur = initialValues[i++];</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> if (sb.length() > 0) {</span> |
| <span class="source-line-no">142</span><span id="line-142"> sb.append(", ");</span> |
| <span class="source-line-no">143</span><span id="line-143"> }</span> |
| <span class="source-line-no">144</span><span id="line-144"></span> |
| <span class="source-line-no">145</span><span id="line-145"> sb.append(ra.getName()).append("=").append(cur);</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147"> LOG.info("before: " + tagLine + " " + sb);</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"> private void logEndings() {</span> |
| <span class="source-line-no">151</span><span id="line-151"> assert initialValues.length == ras.size();</span> |
| <span class="source-line-no">152</span><span id="line-152"> assert endingValues.length == ras.size();</span> |
| <span class="source-line-no">153</span><span id="line-153"></span> |
| <span class="source-line-no">154</span><span id="line-154"> int i = 0;</span> |
| <span class="source-line-no">155</span><span id="line-155"> StringBuilder sb = new StringBuilder();</span> |
| <span class="source-line-no">156</span><span id="line-156"> for (ResourceAnalyzer ra : ras) {</span> |
| <span class="source-line-no">157</span><span id="line-157"> int curP = initialValues[i];</span> |
| <span class="source-line-no">158</span><span id="line-158"> int curN = endingValues[i++];</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 (sb.length() > 0) {</span> |
| <span class="source-line-no">161</span><span id="line-161"> sb.append(", ");</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"> sb.append(ra.getName()).append("=").append(curN).append(" (was ").append(curP).append(")");</span> |
| <span class="source-line-no">165</span><span id="line-165"> if (curN > curP) {</span> |
| <span class="source-line-no">166</span><span id="line-166"> List<String> strings = ra.getStringsToLog();</span> |
| <span class="source-line-no">167</span><span id="line-167"> if (strings != null) {</span> |
| <span class="source-line-no">168</span><span id="line-168"> for (String s : strings) {</span> |
| <span class="source-line-no">169</span><span id="line-169"> sb.append(s);</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"> sb.append(" - ").append(ra.getName()).append(" LEAK? -");</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> |
| <span class="source-line-no">175</span><span id="line-175"> LOG.info("after: " + tagLine + " " + sb);</span> |
| <span class="source-line-no">176</span><span id="line-176"> }</span> |
| <span class="source-line-no">177</span><span id="line-177"></span> |
| <span class="source-line-no">178</span><span id="line-178"> /**</span> |
| <span class="source-line-no">179</span><span id="line-179"> * To be called as the beginning of a test method: - measure the resources - check vs. the limits.</span> |
| <span class="source-line-no">180</span><span id="line-180"> * - logs them.</span> |
| <span class="source-line-no">181</span><span id="line-181"> */</span> |
| <span class="source-line-no">182</span><span id="line-182"> public void start() {</span> |
| <span class="source-line-no">183</span><span id="line-183"> if (ras.isEmpty()) {</span> |
| <span class="source-line-no">184</span><span id="line-184"> LOG.info("No resource analyzer");</span> |
| <span class="source-line-no">185</span><span id="line-185"> return;</span> |
| <span class="source-line-no">186</span><span id="line-186"> }</span> |
| <span class="source-line-no">187</span><span id="line-187"> fillInit();</span> |
| <span class="source-line-no">188</span><span id="line-188"> logInit();</span> |
| <span class="source-line-no">189</span><span id="line-189"> checkInit();</span> |
| <span class="source-line-no">190</span><span id="line-190"> }</span> |
| <span class="source-line-no">191</span><span id="line-191"></span> |
| <span class="source-line-no">192</span><span id="line-192"> /**</span> |
| <span class="source-line-no">193</span><span id="line-193"> * To be called as the end of a test method: - measure the resources - check vs. the limits. -</span> |
| <span class="source-line-no">194</span><span id="line-194"> * check vs. the initial state - logs them.</span> |
| <span class="source-line-no">195</span><span id="line-195"> */</span> |
| <span class="source-line-no">196</span><span id="line-196"> public void end() {</span> |
| <span class="source-line-no">197</span><span id="line-197"> if (ras.isEmpty()) {</span> |
| <span class="source-line-no">198</span><span id="line-198"> LOG.info("No resource analyzer");</span> |
| <span class="source-line-no">199</span><span id="line-199"> return;</span> |
| <span class="source-line-no">200</span><span id="line-200"> }</span> |
| <span class="source-line-no">201</span><span id="line-201"> if (initialValues == null) {</span> |
| <span class="source-line-no">202</span><span id="line-202"> LOG.warn("No initial values");</span> |
| <span class="source-line-no">203</span><span id="line-203"> return;</span> |
| <span class="source-line-no">204</span><span id="line-204"> }</span> |
| <span class="source-line-no">205</span><span id="line-205"></span> |
| <span class="source-line-no">206</span><span id="line-206"> fillEndings();</span> |
| <span class="source-line-no">207</span><span id="line-207"> logEndings();</span> |
| <span class="source-line-no">208</span><span id="line-208"> checkEndings();</span> |
| <span class="source-line-no">209</span><span id="line-209"> }</span> |
| <span class="source-line-no">210</span><span id="line-210"></span> |
| <span class="source-line-no">211</span><span id="line-211"> /**</span> |
| <span class="source-line-no">212</span><span id="line-212"> * Adds a resource analyzer to the resources checked.</span> |
| <span class="source-line-no">213</span><span id="line-213"> */</span> |
| <span class="source-line-no">214</span><span id="line-214"> public void addResourceAnalyzer(ResourceAnalyzer ra) {</span> |
| <span class="source-line-no">215</span><span id="line-215"> ras.add(ra);</span> |
| <span class="source-line-no">216</span><span id="line-216"> }</span> |
| <span class="source-line-no">217</span><span id="line-217">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
