| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.hadoop.hbase;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import edu.umd.cs.findbugs.annotations.Nullable;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.RegionStatesCount;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.master.RegionState;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Metrics information on the HBase cluster.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * <p><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <tt>ClusterMetrics</tt> provides clients with information such as:<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <ul><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <li>The count and names of region servers in the cluster.</li><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <li>The count and names of dead region servers in the cluster.</li><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <li>The name of the active master for the cluster.</li><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <li>The name(s) of the backup master(s) for the cluster, if they exist.</li><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <li>The average cluster load.</li><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <li>The number of regions deployed on the cluster.</li><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <li>The number of requests since last report.</li><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <li>Detailed region server loading and resource usage information,<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * per server and per region.</li><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <li>Regions in transition at master</li><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <li>The unique cluster ID</li><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * </ul><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <tt>{@link Option}</tt> provides a way to get desired ClusterStatus information.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * The following codes will get all the cluster information.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <pre><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * {@code<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * // Original version still works<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Admin admin = connection.getAdmin();<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * ClusterMetrics metrics = admin.getClusterStatus();<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * // or below, a new version which has the same effects<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * ClusterMetrics metrics = admin.getClusterStatus(EnumSet.allOf(Option.class));<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * }<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * </pre><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * If information about live servers is the only wanted.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * then codes in the following way:<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <pre><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * {@code<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Admin admin = connection.getAdmin();<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * ClusterMetrics metrics = admin.getClusterStatus(EnumSet.of(Option.LIVE_SERVERS));<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * }<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * </pre><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span>@InterfaceAudience.Public<a name="line.67"></a> |
| <span class="sourceLineNo">068</span>public interface ClusterMetrics {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @return the HBase version string as reported by the HMaster<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> @Nullable<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> String getHBaseVersion();<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @return the names of region servers on the dead list<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> List<ServerName> getDeadServerNames();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> /**<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @return the names of region servers on the live list<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> Map<ServerName, ServerMetrics> getLiveServerMetrics();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @return the number of regions deployed on the cluster<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> */<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> default int getRegionCount() {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> return getLiveServerMetrics().entrySet().stream()<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> .mapToInt(v -> v.getValue().getRegionMetrics().size()).sum();<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> /**<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @return the number of requests since last report<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> default long getRequestCount() {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return getLiveServerMetrics().entrySet().stream()<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> .flatMap(v -> v.getValue().getRegionMetrics().values().stream())<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> .mapToLong(RegionMetrics::getRequestCount).sum();<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * Returns detailed information about the current master {@link ServerName}.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @return current master information if it exists<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> */<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> @Nullable<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> ServerName getMasterName();<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @return the names of backup masters<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> List<ServerName> getBackupMasterNames();<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> @InterfaceAudience.Private<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> List<RegionState> getRegionStatesInTransition();<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> @Nullable<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> String getClusterId();<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> List<String> getMasterCoprocessorNames();<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> default long getLastMajorCompactionTimestamp(TableName table) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return getLiveServerMetrics().values().stream()<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> .flatMap(s -> s.getRegionMetrics().values().stream())<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> .filter(r -> RegionInfo.getTable(r.getRegionName()).equals(table))<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> .mapToLong(RegionMetrics::getLastMajorCompactionTimestamp).min().orElse(0);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> default long getLastMajorCompactionTimestamp(byte[] regionName) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> return getLiveServerMetrics().values().stream()<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> .filter(s -> s.getRegionMetrics().containsKey(regionName))<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> .findAny()<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> .map(s -> s.getRegionMetrics().get(regionName).getLastMajorCompactionTimestamp())<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> .orElse(0L);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> }<a name="line.136"></a> |
| <span class="sourceLineNo">137</span><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> @Nullable<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> Boolean getBalancerOn();<a name="line.139"></a> |
| <span class="sourceLineNo">140</span><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> int getMasterInfoPort();<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> List<ServerName> getServersName();<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> /**<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @return the average cluster load<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> */<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> default double getAverageLoad() {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> int serverSize = getLiveServerMetrics().size();<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> if (serverSize == 0) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return 0;<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return (double)getRegionCount() / (double)serverSize;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> /**<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * Provide region states count for given table.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * e.g howmany regions of give table are opened/closed/rit etc<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> *<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @return map of table to region states count<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> */<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> Map<TableName, RegionStatesCount> getTableRegionStatesCount();<a name="line.162"></a> |
| <span class="sourceLineNo">163</span><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> /**<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * Kinds of ClusterMetrics<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> */<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> enum Option {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> /**<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * metrics about hbase version<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> */<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> HBASE_VERSION,<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> /**<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * metrics about cluster id<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> */<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> CLUSTER_ID,<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> /**<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * metrics about balancer is on or not<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> */<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> BALANCER_ON,<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> /**<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * metrics about live region servers<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> */<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> LIVE_SERVERS,<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> /**<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * metrics about dead region servers<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> */<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> DEAD_SERVERS,<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> /**<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * metrics about master name<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> */<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> MASTER,<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> /**<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * metrics about backup masters name<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> */<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> BACKUP_MASTERS,<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> /**<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * metrics about master coprocessors<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> */<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> MASTER_COPROCESSORS,<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> /**<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * metrics about regions in transition<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> */<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> REGIONS_IN_TRANSITION,<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> /**<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * metrics info port<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> */<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> MASTER_INFO_PORT,<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> /**<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * metrics about live region servers name<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> */<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> SERVERS_NAME,<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> /**<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * metrics about table to no of regions status count<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> */<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> TABLE_TO_REGIONS_COUNT,<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> }<a name="line.216"></a> |
| <span class="sourceLineNo">217</span>}<a name="line.217"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |