| <!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, interface: ClusterMetrics"> |
| <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 edu.umd.cs.findbugs.annotations.Nullable;</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 java.util.Map;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.client.RegionInfo;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.client.RegionStatesCount;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.master.RegionState;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * Metrics information on the HBase cluster.</span> |
| <span class="source-line-no">030</span><span id="line-30"> * <p></span> |
| <span class="source-line-no">031</span><span id="line-31"> * <tt>ClusterMetrics</tt> provides clients with information such as:</span> |
| <span class="source-line-no">032</span><span id="line-32"> * <ul></span> |
| <span class="source-line-no">033</span><span id="line-33"> * <li>The count and names of region servers in the cluster.</li></span> |
| <span class="source-line-no">034</span><span id="line-34"> * <li>The count and names of dead region servers in the cluster.</li></span> |
| <span class="source-line-no">035</span><span id="line-35"> * <li>The name of the active master for the cluster.</li></span> |
| <span class="source-line-no">036</span><span id="line-36"> * <li>The name(s) of the backup master(s) for the cluster, if they exist.</li></span> |
| <span class="source-line-no">037</span><span id="line-37"> * <li>The average cluster load.</li></span> |
| <span class="source-line-no">038</span><span id="line-38"> * <li>The number of regions deployed on the cluster.</li></span> |
| <span class="source-line-no">039</span><span id="line-39"> * <li>The number of requests since last report.</li></span> |
| <span class="source-line-no">040</span><span id="line-40"> * <li>Detailed region server loading and resource usage information, per server and per</span> |
| <span class="source-line-no">041</span><span id="line-41"> * region.</li></span> |
| <span class="source-line-no">042</span><span id="line-42"> * <li>Regions in transition at master</li></span> |
| <span class="source-line-no">043</span><span id="line-43"> * <li>The unique cluster ID</li></span> |
| <span class="source-line-no">044</span><span id="line-44"> * </ul></span> |
| <span class="source-line-no">045</span><span id="line-45"> * <tt>{@link Option}</tt> provides a way to get desired ClusterStatus information. The following</span> |
| <span class="source-line-no">046</span><span id="line-46"> * codes will get all the cluster information.</span> |
| <span class="source-line-no">047</span><span id="line-47"> *</span> |
| <span class="source-line-no">048</span><span id="line-48"> * <pre></span> |
| <span class="source-line-no">049</span><span id="line-49"> * {</span> |
| <span class="source-line-no">050</span><span id="line-50"> * &#64;code</span> |
| <span class="source-line-no">051</span><span id="line-51"> * // Original version still works</span> |
| <span class="source-line-no">052</span><span id="line-52"> * Admin admin = connection.getAdmin();</span> |
| <span class="source-line-no">053</span><span id="line-53"> * ClusterMetrics metrics = admin.getClusterStatus();</span> |
| <span class="source-line-no">054</span><span id="line-54"> * // or below, a new version which has the same effects</span> |
| <span class="source-line-no">055</span><span id="line-55"> * ClusterMetrics metrics = admin.getClusterStatus(EnumSet.allOf(Option.class));</span> |
| <span class="source-line-no">056</span><span id="line-56"> * }</span> |
| <span class="source-line-no">057</span><span id="line-57"> * </pre></span> |
| <span class="source-line-no">058</span><span id="line-58"> *</span> |
| <span class="source-line-no">059</span><span id="line-59"> * If information about live servers is the only wanted. then codes in the following way:</span> |
| <span class="source-line-no">060</span><span id="line-60"> *</span> |
| <span class="source-line-no">061</span><span id="line-61"> * <pre></span> |
| <span class="source-line-no">062</span><span id="line-62"> * {</span> |
| <span class="source-line-no">063</span><span id="line-63"> * &#64;code</span> |
| <span class="source-line-no">064</span><span id="line-64"> * Admin admin = connection.getAdmin();</span> |
| <span class="source-line-no">065</span><span id="line-65"> * ClusterMetrics metrics = admin.getClusterStatus(EnumSet.of(Option.LIVE_SERVERS));</span> |
| <span class="source-line-no">066</span><span id="line-66"> * }</span> |
| <span class="source-line-no">067</span><span id="line-67"> * </pre></span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69">@InterfaceAudience.Public</span> |
| <span class="source-line-no">070</span><span id="line-70">public interface ClusterMetrics {</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> /** Returns the HBase version string as reported by the HMaster */</span> |
| <span class="source-line-no">073</span><span id="line-73"> @Nullable</span> |
| <span class="source-line-no">074</span><span id="line-74"> String getHBaseVersion();</span> |
| <span class="source-line-no">075</span><span id="line-75"></span> |
| <span class="source-line-no">076</span><span id="line-76"> /** Returns the names of region servers on the dead list */</span> |
| <span class="source-line-no">077</span><span id="line-77"> List<ServerName> getDeadServerNames();</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> /** Returns the names of region servers on the unknown list */</span> |
| <span class="source-line-no">080</span><span id="line-80"> List<ServerName> getUnknownServerNames();</span> |
| <span class="source-line-no">081</span><span id="line-81"></span> |
| <span class="source-line-no">082</span><span id="line-82"> /** Returns the names of region servers on the decommissioned list */</span> |
| <span class="source-line-no">083</span><span id="line-83"> List<ServerName> getDecommissionedServerNames();</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> /** Returns the names of region servers on the live list */</span> |
| <span class="source-line-no">086</span><span id="line-86"> Map<ServerName, ServerMetrics> getLiveServerMetrics();</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> /** Returns the number of regions deployed on the cluster */</span> |
| <span class="source-line-no">089</span><span id="line-89"> default int getRegionCount() {</span> |
| <span class="source-line-no">090</span><span id="line-90"> return getLiveServerMetrics().entrySet().stream()</span> |
| <span class="source-line-no">091</span><span id="line-91"> .mapToInt(v -> v.getValue().getRegionMetrics().size()).sum();</span> |
| <span class="source-line-no">092</span><span id="line-92"> }</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> /** Returns the number of requests since last report */</span> |
| <span class="source-line-no">095</span><span id="line-95"> default long getRequestCount() {</span> |
| <span class="source-line-no">096</span><span id="line-96"> return getLiveServerMetrics().entrySet().stream()</span> |
| <span class="source-line-no">097</span><span id="line-97"> .flatMap(v -> v.getValue().getRegionMetrics().values().stream())</span> |
| <span class="source-line-no">098</span><span id="line-98"> .mapToLong(RegionMetrics::getRequestCount).sum();</span> |
| <span class="source-line-no">099</span><span id="line-99"> }</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"> * Returns detailed information about the current master {@link ServerName}.</span> |
| <span class="source-line-no">103</span><span id="line-103"> * @return current master information if it exists</span> |
| <span class="source-line-no">104</span><span id="line-104"> */</span> |
| <span class="source-line-no">105</span><span id="line-105"> @Nullable</span> |
| <span class="source-line-no">106</span><span id="line-106"> ServerName getMasterName();</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> /** Returns the names of backup masters */</span> |
| <span class="source-line-no">109</span><span id="line-109"> List<ServerName> getBackupMasterNames();</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">112</span><span id="line-112"> List<RegionState> getRegionStatesInTransition();</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> @Nullable</span> |
| <span class="source-line-no">115</span><span id="line-115"> String getClusterId();</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> List<String> getMasterCoprocessorNames();</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> default long getLastMajorCompactionTimestamp(TableName table) {</span> |
| <span class="source-line-no">120</span><span id="line-120"> return getLiveServerMetrics().values().stream()</span> |
| <span class="source-line-no">121</span><span id="line-121"> .flatMap(s -> s.getRegionMetrics().values().stream())</span> |
| <span class="source-line-no">122</span><span id="line-122"> .filter(r -> RegionInfo.getTable(r.getRegionName()).equals(table))</span> |
| <span class="source-line-no">123</span><span id="line-123"> .mapToLong(RegionMetrics::getLastMajorCompactionTimestamp).min().orElse(0);</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</span> |
| <span class="source-line-no">125</span><span id="line-125"></span> |
| <span class="source-line-no">126</span><span id="line-126"> default long getLastMajorCompactionTimestamp(byte[] regionName) {</span> |
| <span class="source-line-no">127</span><span id="line-127"> return getLiveServerMetrics().values().stream()</span> |
| <span class="source-line-no">128</span><span id="line-128"> .filter(s -> s.getRegionMetrics().containsKey(regionName)).findAny()</span> |
| <span class="source-line-no">129</span><span id="line-129"> .map(s -> s.getRegionMetrics().get(regionName).getLastMajorCompactionTimestamp()).orElse(0L);</span> |
| <span class="source-line-no">130</span><span id="line-130"> }</span> |
| <span class="source-line-no">131</span><span id="line-131"></span> |
| <span class="source-line-no">132</span><span id="line-132"> @Nullable</span> |
| <span class="source-line-no">133</span><span id="line-133"> Boolean getBalancerOn();</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> int getMasterInfoPort();</span> |
| <span class="source-line-no">136</span><span id="line-136"></span> |
| <span class="source-line-no">137</span><span id="line-137"> List<ServerName> getServersName();</span> |
| <span class="source-line-no">138</span><span id="line-138"></span> |
| <span class="source-line-no">139</span><span id="line-139"> /** Returns the average cluster load */</span> |
| <span class="source-line-no">140</span><span id="line-140"> default double getAverageLoad() {</span> |
| <span class="source-line-no">141</span><span id="line-141"> int serverSize = getLiveServerMetrics().size();</span> |
| <span class="source-line-no">142</span><span id="line-142"> if (serverSize == 0) {</span> |
| <span class="source-line-no">143</span><span id="line-143"> return 0;</span> |
| <span class="source-line-no">144</span><span id="line-144"> }</span> |
| <span class="source-line-no">145</span><span id="line-145"> return (double) getRegionCount() / (double) serverSize;</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147"></span> |
| <span class="source-line-no">148</span><span id="line-148"> /**</span> |
| <span class="source-line-no">149</span><span id="line-149"> * Provide region states count for given table. e.g howmany regions of give table are</span> |
| <span class="source-line-no">150</span><span id="line-150"> * opened/closed/rit etc</span> |
| <span class="source-line-no">151</span><span id="line-151"> * @return map of table to region states count</span> |
| <span class="source-line-no">152</span><span id="line-152"> */</span> |
| <span class="source-line-no">153</span><span id="line-153"> Map<TableName, RegionStatesCount> getTableRegionStatesCount();</span> |
| <span class="source-line-no">154</span><span id="line-154"></span> |
| <span class="source-line-no">155</span><span id="line-155"> /**</span> |
| <span class="source-line-no">156</span><span id="line-156"> * Provide the list of master tasks</span> |
| <span class="source-line-no">157</span><span id="line-157"> */</span> |
| <span class="source-line-no">158</span><span id="line-158"> @Nullable</span> |
| <span class="source-line-no">159</span><span id="line-159"> List<ServerTask> getMasterTasks();</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"> * Kinds of ClusterMetrics</span> |
| <span class="source-line-no">163</span><span id="line-163"> */</span> |
| <span class="source-line-no">164</span><span id="line-164"> enum Option {</span> |
| <span class="source-line-no">165</span><span id="line-165"> /**</span> |
| <span class="source-line-no">166</span><span id="line-166"> * metrics about hbase version</span> |
| <span class="source-line-no">167</span><span id="line-167"> */</span> |
| <span class="source-line-no">168</span><span id="line-168"> HBASE_VERSION,</span> |
| <span class="source-line-no">169</span><span id="line-169"> /**</span> |
| <span class="source-line-no">170</span><span id="line-170"> * metrics about cluster id</span> |
| <span class="source-line-no">171</span><span id="line-171"> */</span> |
| <span class="source-line-no">172</span><span id="line-172"> CLUSTER_ID,</span> |
| <span class="source-line-no">173</span><span id="line-173"> /**</span> |
| <span class="source-line-no">174</span><span id="line-174"> * metrics about balancer is on or not</span> |
| <span class="source-line-no">175</span><span id="line-175"> */</span> |
| <span class="source-line-no">176</span><span id="line-176"> BALANCER_ON,</span> |
| <span class="source-line-no">177</span><span id="line-177"> /**</span> |
| <span class="source-line-no">178</span><span id="line-178"> * metrics about live region servers</span> |
| <span class="source-line-no">179</span><span id="line-179"> */</span> |
| <span class="source-line-no">180</span><span id="line-180"> LIVE_SERVERS,</span> |
| <span class="source-line-no">181</span><span id="line-181"> /**</span> |
| <span class="source-line-no">182</span><span id="line-182"> * metrics about dead region servers</span> |
| <span class="source-line-no">183</span><span id="line-183"> */</span> |
| <span class="source-line-no">184</span><span id="line-184"> DEAD_SERVERS,</span> |
| <span class="source-line-no">185</span><span id="line-185"> /**</span> |
| <span class="source-line-no">186</span><span id="line-186"> * metrics about unknown region servers</span> |
| <span class="source-line-no">187</span><span id="line-187"> */</span> |
| <span class="source-line-no">188</span><span id="line-188"> UNKNOWN_SERVERS,</span> |
| <span class="source-line-no">189</span><span id="line-189"> /**</span> |
| <span class="source-line-no">190</span><span id="line-190"> * metrics about master name</span> |
| <span class="source-line-no">191</span><span id="line-191"> */</span> |
| <span class="source-line-no">192</span><span id="line-192"> MASTER,</span> |
| <span class="source-line-no">193</span><span id="line-193"> /**</span> |
| <span class="source-line-no">194</span><span id="line-194"> * metrics about backup masters name</span> |
| <span class="source-line-no">195</span><span id="line-195"> */</span> |
| <span class="source-line-no">196</span><span id="line-196"> BACKUP_MASTERS,</span> |
| <span class="source-line-no">197</span><span id="line-197"> /**</span> |
| <span class="source-line-no">198</span><span id="line-198"> * metrics about master coprocessors</span> |
| <span class="source-line-no">199</span><span id="line-199"> */</span> |
| <span class="source-line-no">200</span><span id="line-200"> MASTER_COPROCESSORS,</span> |
| <span class="source-line-no">201</span><span id="line-201"> /**</span> |
| <span class="source-line-no">202</span><span id="line-202"> * metrics about regions in transition</span> |
| <span class="source-line-no">203</span><span id="line-203"> */</span> |
| <span class="source-line-no">204</span><span id="line-204"> REGIONS_IN_TRANSITION,</span> |
| <span class="source-line-no">205</span><span id="line-205"> /**</span> |
| <span class="source-line-no">206</span><span id="line-206"> * metrics info port</span> |
| <span class="source-line-no">207</span><span id="line-207"> */</span> |
| <span class="source-line-no">208</span><span id="line-208"> MASTER_INFO_PORT,</span> |
| <span class="source-line-no">209</span><span id="line-209"> /**</span> |
| <span class="source-line-no">210</span><span id="line-210"> * metrics about live region servers name</span> |
| <span class="source-line-no">211</span><span id="line-211"> */</span> |
| <span class="source-line-no">212</span><span id="line-212"> SERVERS_NAME,</span> |
| <span class="source-line-no">213</span><span id="line-213"> /**</span> |
| <span class="source-line-no">214</span><span id="line-214"> * metrics about table to no of regions status count</span> |
| <span class="source-line-no">215</span><span id="line-215"> */</span> |
| <span class="source-line-no">216</span><span id="line-216"> TABLE_TO_REGIONS_COUNT,</span> |
| <span class="source-line-no">217</span><span id="line-217"> /**</span> |
| <span class="source-line-no">218</span><span id="line-218"> * metrics about monitored tasks</span> |
| <span class="source-line-no">219</span><span id="line-219"> */</span> |
| <span class="source-line-no">220</span><span id="line-220"> TASKS,</span> |
| <span class="source-line-no">221</span><span id="line-221"> /**</span> |
| <span class="source-line-no">222</span><span id="line-222"> * metrics about decommissioned region servers</span> |
| <span class="source-line-no">223</span><span id="line-223"> */</span> |
| <span class="source-line-no">224</span><span id="line-224"> DECOMMISSIONED_SERVERS,</span> |
| <span class="source-line-no">225</span><span id="line-225"> }</span> |
| <span class="source-line-no">226</span><span id="line-226">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
