Google Git
Sign in
apache / hbase-site / d68031f4c651e0a9da31d8e4e1c5306795dd4c20 / . / devapidocs / src-html / org / apache / hadoop / hbase / rsgroup / RSGroupUtil.html
blob: fb2d1cb4289bf1f2a0356cf9893bc8039f0437e0 [file] [log] [blame]
<!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> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.rsgroup;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Collection;<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.Optional;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.function.Predicate;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.conf.Configuration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.TableName;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.client.TableDescriptor;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.master.ClusterSchema;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.master.MasterServices;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.slf4j.Logger;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.slf4j.LoggerFactory;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Helper class for RSGroup implementation<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>@InterfaceAudience.Private<a name="line.39"></a>
<span class="sourceLineNo">040</span>public final class RSGroupUtil {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private static final Logger LOG = LoggerFactory.getLogger(RSGroupUtil.class);<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> public static final String RS_GROUP_ENABLED = "hbase.balancer.rsgroup.enabled";<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private RSGroupUtil() {<a name="line.46"></a>
<span class="sourceLineNo">047</span> }<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> public static boolean isRSGroupEnabled(Configuration conf) {<a name="line.49"></a>
<span class="sourceLineNo">050</span> return conf.getBoolean(RS_GROUP_ENABLED, false);<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> public static void enableRSGroup(Configuration conf) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> conf.setBoolean(RS_GROUP_ENABLED, true);<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> public static List&lt;TableName&gt; listTablesInRSGroup(MasterServices master, String groupName)<a name="line.57"></a>
<span class="sourceLineNo">058</span> throws IOException {<a name="line.58"></a>
<span class="sourceLineNo">059</span> List&lt;TableName&gt; tables = new ArrayList&lt;&gt;();<a name="line.59"></a>
<span class="sourceLineNo">060</span> boolean isDefaultGroup = RSGroupInfo.DEFAULT_GROUP.equals(groupName);<a name="line.60"></a>
<span class="sourceLineNo">061</span> for (TableDescriptor td : master.getTableDescriptors().getAll().values()) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> // no config means in default group<a name="line.62"></a>
<span class="sourceLineNo">063</span> if (<a name="line.63"></a>
<span class="sourceLineNo">064</span> RSGroupUtil.getRSGroupInfo(master, master.getRSGroupInfoManager(), td.getTableName())<a name="line.64"></a>
<span class="sourceLineNo">065</span> .map(g -&gt; g.getName().equals(groupName)).orElse(isDefaultGroup)<a name="line.65"></a>
<span class="sourceLineNo">066</span> ) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> tables.add(td.getTableName());<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span> return tables;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Will try to get the rsgroup from {@link TableDescriptor} first, and then try to get the rsgroup<a name="line.74"></a>
<span class="sourceLineNo">075</span> * from the {@link NamespaceDescriptor}. If still not present, return empty.<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> public static Optional&lt;RSGroupInfo&gt; getRSGroupInfo(MasterServices master,<a name="line.77"></a>
<span class="sourceLineNo">078</span> RSGroupInfoManager manager, TableName tableName) throws IOException {<a name="line.78"></a>
<span class="sourceLineNo">079</span> TableDescriptor td = master.getTableDescriptors().get(tableName);<a name="line.79"></a>
<span class="sourceLineNo">080</span> if (td == null) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> return Optional.empty();<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> // RSGroup information determined by client.<a name="line.83"></a>
<span class="sourceLineNo">084</span> Optional&lt;String&gt; optGroupNameOfTable = td.getRegionServerGroup();<a name="line.84"></a>
<span class="sourceLineNo">085</span> if (optGroupNameOfTable.isPresent()) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> RSGroupInfo group = manager.getRSGroup(optGroupNameOfTable.get());<a name="line.86"></a>
<span class="sourceLineNo">087</span> if (group != null) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> return Optional.of(group);<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span> // for backward compatible, where we may still have table configs in the RSGroupInfo after<a name="line.91"></a>
<span class="sourceLineNo">092</span> // upgrading when migrating is still on-going.<a name="line.92"></a>
<span class="sourceLineNo">093</span> RSGroupInfo groupFromOldRSGroupInfo = manager.getRSGroupForTable(tableName);<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (groupFromOldRSGroupInfo != null) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> return Optional.of(groupFromOldRSGroupInfo);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> // RSGroup information determined by administrator.<a name="line.97"></a>
<span class="sourceLineNo">098</span> String groupDeterminedByAdmin = manager.determineRSGroupInfoForTable(tableName);<a name="line.98"></a>
<span class="sourceLineNo">099</span> RSGroupInfo groupInfo = null;<a name="line.99"></a>
<span class="sourceLineNo">100</span> if (groupDeterminedByAdmin != null) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> groupInfo = manager.getRSGroup(groupDeterminedByAdmin);<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (groupInfo != null) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return Optional.of(groupInfo);<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span> // Finally, we will try to fall back to namespace as rsgroup if exists<a name="line.106"></a>
<span class="sourceLineNo">107</span> ClusterSchema clusterSchema = master.getClusterSchema();<a name="line.107"></a>
<span class="sourceLineNo">108</span> if (clusterSchema == null) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> if (TableName.isMetaTableName(tableName)) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> LOG.info("Can not get the namespace rs group config for meta table, since the"<a name="line.110"></a>
<span class="sourceLineNo">111</span> + " meta table is not online yet, will use default group to assign meta first");<a name="line.111"></a>
<span class="sourceLineNo">112</span> } else {<a name="line.112"></a>
<span class="sourceLineNo">113</span> LOG.warn("ClusterSchema is null, can only use default rsgroup, should not happen?");<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span> return Optional.empty();<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> NamespaceDescriptor nd = clusterSchema.getNamespace(tableName.getNamespaceAsString());<a name="line.117"></a>
<span class="sourceLineNo">118</span> String groupNameOfNs = nd.getConfigurationValue(RSGroupInfo.NAMESPACE_DESC_PROP_GROUP);<a name="line.118"></a>
<span class="sourceLineNo">119</span> if (groupNameOfNs == null) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return Optional.empty();<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span> return Optional.ofNullable(manager.getRSGroup(groupNameOfNs));<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
<span class="sourceLineNo">126</span> * Fill the tables field for {@link RSGroupInfo}, for backward compatibility.<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> @SuppressWarnings("deprecation")<a name="line.128"></a>
<span class="sourceLineNo">129</span> public static RSGroupInfo fillTables(RSGroupInfo rsGroupInfo, Collection&lt;TableDescriptor&gt; tds) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> RSGroupInfo newRsGroupInfo = new RSGroupInfo(rsGroupInfo);<a name="line.130"></a>
<span class="sourceLineNo">131</span> Predicate&lt;TableDescriptor&gt; filter;<a name="line.131"></a>
<span class="sourceLineNo">132</span> if (rsGroupInfo.getName().equals(RSGroupInfo.DEFAULT_GROUP)) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> filter = td -&gt; {<a name="line.133"></a>
<span class="sourceLineNo">134</span> Optional&lt;String&gt; optGroupName = td.getRegionServerGroup();<a name="line.134"></a>
<span class="sourceLineNo">135</span> return !optGroupName.isPresent() || optGroupName.get().equals(RSGroupInfo.DEFAULT_GROUP);<a name="line.135"></a>
<span class="sourceLineNo">136</span> };<a name="line.136"></a>
<span class="sourceLineNo">137</span> } else {<a name="line.137"></a>
<span class="sourceLineNo">138</span> filter = td -&gt; {<a name="line.138"></a>
<span class="sourceLineNo">139</span> Optional&lt;String&gt; optGroupName = td.getRegionServerGroup();<a name="line.139"></a>
<span class="sourceLineNo">140</span> return optGroupName.isPresent() &amp;&amp; optGroupName.get().equals(newRsGroupInfo.getName());<a name="line.140"></a>
<span class="sourceLineNo">141</span> };<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span> tds.stream().filter(filter).map(TableDescriptor::getTableName)<a name="line.143"></a>
<span class="sourceLineNo">144</span> .forEach(newRsGroupInfo::addTable);<a name="line.144"></a>
<span class="sourceLineNo">145</span> return newRsGroupInfo;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span>}<a name="line.147"></a>
</pre>
</div>
</body>
</html>