blob: 2eac3f737b16f3f852de54cf6b4983f2f2e99941 [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, class: ResourceCheckerJUnitListener, class: SystemLoadAverageResourceAnalyzer">
<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.HashSet;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.List;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.Map;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.Set;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.concurrent.ConcurrentHashMap;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.ResourceChecker.Phase;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.JVM;</span>
<span class="source-line-no">028</span><span id="line-28">import org.junit.runner.notification.RunListener;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">/**</span>
<span class="source-line-no">031</span><span id="line-31"> * Listen to the test progress and check the usage of:</span>
<span class="source-line-no">032</span><span id="line-32"> * &lt;ul&gt;</span>
<span class="source-line-no">033</span><span id="line-33"> * &lt;li&gt;threads&lt;/li&gt;</span>
<span class="source-line-no">034</span><span id="line-34"> * &lt;li&gt;open file descriptor&lt;/li&gt;</span>
<span class="source-line-no">035</span><span id="line-35"> * &lt;li&gt;max open file descriptor&lt;/li&gt;</span>
<span class="source-line-no">036</span><span id="line-36"> * &lt;/ul&gt;</span>
<span class="source-line-no">037</span><span id="line-37"> * &lt;p&gt;</span>
<span class="source-line-no">038</span><span id="line-38"> * When surefire forkMode=once/always/perthread, this code is executed on the forked process.</span>
<span class="source-line-no">039</span><span id="line-39"> */</span>
<span class="source-line-no">040</span><span id="line-40">public class ResourceCheckerJUnitListener extends RunListener {</span>
<span class="source-line-no">041</span><span id="line-41"> private Map&lt;String, ResourceChecker&gt; rcs = new ConcurrentHashMap&lt;&gt;();</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> static class ThreadResourceAnalyzer extends ResourceChecker.ResourceAnalyzer {</span>
<span class="source-line-no">044</span><span id="line-44"> private static Set&lt;String&gt; initialThreadNames = new HashSet&lt;&gt;();</span>
<span class="source-line-no">045</span><span id="line-45"> private static List&lt;String&gt; stringsToLog = null;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> @Override</span>
<span class="source-line-no">048</span><span id="line-48"> public int getVal(Phase phase) {</span>
<span class="source-line-no">049</span><span id="line-49"> Map&lt;Thread, StackTraceElement[]&gt; stackTraces = Thread.getAllStackTraces();</span>
<span class="source-line-no">050</span><span id="line-50"> if (phase == Phase.INITIAL) {</span>
<span class="source-line-no">051</span><span id="line-51"> stringsToLog = null;</span>
<span class="source-line-no">052</span><span id="line-52"> for (Thread t : stackTraces.keySet()) {</span>
<span class="source-line-no">053</span><span id="line-53"> initialThreadNames.add(t.getName());</span>
<span class="source-line-no">054</span><span id="line-54"> }</span>
<span class="source-line-no">055</span><span id="line-55"> } else if (phase == Phase.END) {</span>
<span class="source-line-no">056</span><span id="line-56"> if (stackTraces.size() &gt; initialThreadNames.size()) {</span>
<span class="source-line-no">057</span><span id="line-57"> stringsToLog = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">058</span><span id="line-58"> for (Thread t : stackTraces.keySet()) {</span>
<span class="source-line-no">059</span><span id="line-59"> if (!initialThreadNames.contains(t.getName())) {</span>
<span class="source-line-no">060</span><span id="line-60"> stringsToLog.add("\nPotentially hanging thread: " + t.getName() + "\n");</span>
<span class="source-line-no">061</span><span id="line-61"> StackTraceElement[] stackElements = stackTraces.get(t);</span>
<span class="source-line-no">062</span><span id="line-62"> for (StackTraceElement ele : stackElements) {</span>
<span class="source-line-no">063</span><span id="line-63"> stringsToLog.add("\t" + ele + "\n");</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"> }</span>
<span class="source-line-no">067</span><span id="line-67"> }</span>
<span class="source-line-no">068</span><span id="line-68"> }</span>
<span class="source-line-no">069</span><span id="line-69"> return stackTraces.size();</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"> public int getMax() {</span>
<span class="source-line-no">074</span><span id="line-74"> return 500;</span>
<span class="source-line-no">075</span><span id="line-75"> }</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> @Override</span>
<span class="source-line-no">078</span><span id="line-78"> public List&lt;String&gt; getStringsToLog() {</span>
<span class="source-line-no">079</span><span id="line-79"> return stringsToLog;</span>
<span class="source-line-no">080</span><span id="line-80"> }</span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> static class OpenFileDescriptorResourceAnalyzer extends ResourceChecker.ResourceAnalyzer {</span>
<span class="source-line-no">084</span><span id="line-84"> @Override</span>
<span class="source-line-no">085</span><span id="line-85"> public int getVal(Phase phase) {</span>
<span class="source-line-no">086</span><span id="line-86"> if (!JVM.isUnix()) {</span>
<span class="source-line-no">087</span><span id="line-87"> return 0;</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"> JVM jvm = new JVM();</span>
<span class="source-line-no">090</span><span id="line-90"> return (int) jvm.getOpenFileDescriptorCount();</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"> @Override</span>
<span class="source-line-no">094</span><span id="line-94"> public int getMax() {</span>
<span class="source-line-no">095</span><span id="line-95"> return 1024;</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> static class MaxFileDescriptorResourceAnalyzer extends ResourceChecker.ResourceAnalyzer {</span>
<span class="source-line-no">100</span><span id="line-100"> @Override</span>
<span class="source-line-no">101</span><span id="line-101"> public int getVal(Phase phase) {</span>
<span class="source-line-no">102</span><span id="line-102"> if (!JVM.isUnix()) {</span>
<span class="source-line-no">103</span><span id="line-103"> return 0;</span>
<span class="source-line-no">104</span><span id="line-104"> }</span>
<span class="source-line-no">105</span><span id="line-105"> JVM jvm = new JVM();</span>
<span class="source-line-no">106</span><span id="line-106"> return (int) jvm.getMaxFileDescriptorCount();</span>
<span class="source-line-no">107</span><span id="line-107"> }</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"> static class SystemLoadAverageResourceAnalyzer extends ResourceChecker.ResourceAnalyzer {</span>
<span class="source-line-no">111</span><span id="line-111"> @Override</span>
<span class="source-line-no">112</span><span id="line-112"> public int getVal(Phase phase) {</span>
<span class="source-line-no">113</span><span id="line-113"> if (!JVM.isUnix()) {</span>
<span class="source-line-no">114</span><span id="line-114"> return 0;</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"> return (int) (new JVM().getSystemLoadAverage() * 100);</span>
<span class="source-line-no">117</span><span id="line-117"> }</span>
<span class="source-line-no">118</span><span id="line-118"> }</span>
<span class="source-line-no">119</span><span id="line-119"></span>
<span class="source-line-no">120</span><span id="line-120"> static class ProcessCountResourceAnalyzer extends ResourceChecker.ResourceAnalyzer {</span>
<span class="source-line-no">121</span><span id="line-121"> @Override</span>
<span class="source-line-no">122</span><span id="line-122"> public int getVal(Phase phase) {</span>
<span class="source-line-no">123</span><span id="line-123"> if (!JVM.isUnix()) {</span>
<span class="source-line-no">124</span><span id="line-124"> return 0;</span>
<span class="source-line-no">125</span><span id="line-125"> }</span>
<span class="source-line-no">126</span><span id="line-126"> return new JVM().getNumberOfRunningProcess();</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"></span>
<span class="source-line-no">130</span><span id="line-130"> static class AvailableMemoryMBResourceAnalyzer extends ResourceChecker.ResourceAnalyzer {</span>
<span class="source-line-no">131</span><span id="line-131"> @Override</span>
<span class="source-line-no">132</span><span id="line-132"> public int getVal(Phase phase) {</span>
<span class="source-line-no">133</span><span id="line-133"> if (!JVM.isUnix()) {</span>
<span class="source-line-no">134</span><span id="line-134"> return 0;</span>
<span class="source-line-no">135</span><span id="line-135"> }</span>
<span class="source-line-no">136</span><span id="line-136"> return (int) (new JVM().getFreeMemory() / (1024L * 1024L));</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"></span>
<span class="source-line-no">140</span><span id="line-140"> /**</span>
<span class="source-line-no">141</span><span id="line-141"> * To be implemented by sub classes if they want to add specific ResourceAnalyzer.</span>
<span class="source-line-no">142</span><span id="line-142"> */</span>
<span class="source-line-no">143</span><span id="line-143"> protected void addResourceAnalyzer(ResourceChecker rc) {</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"> private void start(String testName) {</span>
<span class="source-line-no">147</span><span id="line-147"> ResourceChecker rc = new ResourceChecker(testName);</span>
<span class="source-line-no">148</span><span id="line-148"> rc.addResourceAnalyzer(new ThreadResourceAnalyzer());</span>
<span class="source-line-no">149</span><span id="line-149"> rc.addResourceAnalyzer(new OpenFileDescriptorResourceAnalyzer());</span>
<span class="source-line-no">150</span><span id="line-150"> rc.addResourceAnalyzer(new MaxFileDescriptorResourceAnalyzer());</span>
<span class="source-line-no">151</span><span id="line-151"> rc.addResourceAnalyzer(new SystemLoadAverageResourceAnalyzer());</span>
<span class="source-line-no">152</span><span id="line-152"> rc.addResourceAnalyzer(new ProcessCountResourceAnalyzer());</span>
<span class="source-line-no">153</span><span id="line-153"> rc.addResourceAnalyzer(new AvailableMemoryMBResourceAnalyzer());</span>
<span class="source-line-no">154</span><span id="line-154"></span>
<span class="source-line-no">155</span><span id="line-155"> addResourceAnalyzer(rc);</span>
<span class="source-line-no">156</span><span id="line-156"></span>
<span class="source-line-no">157</span><span id="line-157"> rcs.put(testName, rc);</span>
<span class="source-line-no">158</span><span id="line-158"></span>
<span class="source-line-no">159</span><span id="line-159"> rc.start();</span>
<span class="source-line-no">160</span><span id="line-160"> }</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> private void end(String testName) {</span>
<span class="source-line-no">163</span><span id="line-163"> ResourceChecker rc = rcs.remove(testName);</span>
<span class="source-line-no">164</span><span id="line-164"> assert rc != null;</span>
<span class="source-line-no">165</span><span id="line-165"> rc.end();</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"> /**</span>
<span class="source-line-no">169</span><span id="line-169"> * Get the test name from the JUnit Description</span>
<span class="source-line-no">170</span><span id="line-170"> * @return the string for the short test name</span>
<span class="source-line-no">171</span><span id="line-171"> */</span>
<span class="source-line-no">172</span><span id="line-172"> private String descriptionToShortTestName(org.junit.runner.Description description) {</span>
<span class="source-line-no">173</span><span id="line-173"> final int toRemove = "org.apache.hadoop.hbase.".length();</span>
<span class="source-line-no">174</span><span id="line-174"> return description.getTestClass().getName().substring(toRemove) + "#"</span>
<span class="source-line-no">175</span><span id="line-175"> + description.getMethodName();</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"> @Override</span>
<span class="source-line-no">179</span><span id="line-179"> public void testStarted(org.junit.runner.Description description) throws java.lang.Exception {</span>
<span class="source-line-no">180</span><span id="line-180"> start(descriptionToShortTestName(description));</span>
<span class="source-line-no">181</span><span id="line-181"> }</span>
<span class="source-line-no">182</span><span id="line-182"></span>
<span class="source-line-no">183</span><span id="line-183"> @Override</span>
<span class="source-line-no">184</span><span id="line-184"> public void testFinished(org.junit.runner.Description description) throws java.lang.Exception {</span>
<span class="source-line-no">185</span><span id="line-185"> end(descriptionToShortTestName(description));</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187">}</span>
</pre>
</div>
</main>
</body>
</html>