blob: e2704871ffa5aea9ffb9193c8fa7e0e42b63ceb6 [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.backup.master, class: LogRollMasterProcedureManager">
<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.backup.master;</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.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.ArrayList;</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.concurrent.ThreadPoolExecutor;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.ServerName;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.backup.BackupRestoreConstants;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.backup.impl.BackupManager;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.errorhandling.ForeignException;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.errorhandling.ForeignExceptionDispatcher;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.master.MasterServices;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.master.MetricsMaster;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.procedure.MasterProcedureManager;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.procedure.Procedure;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.procedure.ProcedureCoordinationManager;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.procedure.ProcedureCoordinator;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.procedure.ProcedureCoordinatorRpcs;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.procedure.RegionServerProcedureManager;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.procedure.ZKProcedureCoordinationManager;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.security.User;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.security.access.AccessChecker;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">043</span><span id="line-43">import org.slf4j.Logger;</span>
<span class="source-line-no">044</span><span id="line-44">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46">import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.NameStringPair;</span>
<span class="source-line-no">047</span><span id="line-47">import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.ProcedureDescription;</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49">/**</span>
<span class="source-line-no">050</span><span id="line-50"> * Master procedure manager for coordinated cluster-wide WAL roll operation, which is run during</span>
<span class="source-line-no">051</span><span id="line-51"> * backup operation, see {@link MasterProcedureManager} and {@link RegionServerProcedureManager}</span>
<span class="source-line-no">052</span><span id="line-52"> */</span>
<span class="source-line-no">053</span><span id="line-53">@InterfaceAudience.Private</span>
<span class="source-line-no">054</span><span id="line-54">public class LogRollMasterProcedureManager extends MasterProcedureManager {</span>
<span class="source-line-no">055</span><span id="line-55"> private static final Logger LOG = LoggerFactory.getLogger(LogRollMasterProcedureManager.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"> public static final String ROLLLOG_PROCEDURE_SIGNATURE = "rolllog-proc";</span>
<span class="source-line-no">058</span><span id="line-58"> public static final String ROLLLOG_PROCEDURE_NAME = "rolllog";</span>
<span class="source-line-no">059</span><span id="line-59"> public static final String BACKUP_WAKE_MILLIS_KEY = "hbase.backup.logroll.wake.millis";</span>
<span class="source-line-no">060</span><span id="line-60"> public static final String BACKUP_TIMEOUT_MILLIS_KEY = "hbase.backup.logroll.timeout.millis";</span>
<span class="source-line-no">061</span><span id="line-61"> public static final String BACKUP_POOL_THREAD_NUMBER_KEY =</span>
<span class="source-line-no">062</span><span id="line-62"> "hbase.backup.logroll.pool.thread.number";</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> public static final int BACKUP_WAKE_MILLIS_DEFAULT = 500;</span>
<span class="source-line-no">065</span><span id="line-65"> public static final int BACKUP_TIMEOUT_MILLIS_DEFAULT = 180000;</span>
<span class="source-line-no">066</span><span id="line-66"> public static final int BACKUP_POOL_THREAD_NUMBER_DEFAULT = 8;</span>
<span class="source-line-no">067</span><span id="line-67"> private MasterServices master;</span>
<span class="source-line-no">068</span><span id="line-68"> private ProcedureCoordinator coordinator;</span>
<span class="source-line-no">069</span><span id="line-69"> private boolean done;</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> @Override</span>
<span class="source-line-no">072</span><span id="line-72"> public void stop(String why) {</span>
<span class="source-line-no">073</span><span id="line-73"> LOG.info("stop: " + why);</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> @Override</span>
<span class="source-line-no">077</span><span id="line-77"> public boolean isStopped() {</span>
<span class="source-line-no">078</span><span id="line-78"> return false;</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> @Override</span>
<span class="source-line-no">082</span><span id="line-82"> public void initialize(MasterServices master, MetricsMaster metricsMaster)</span>
<span class="source-line-no">083</span><span id="line-83"> throws IOException, UnsupportedOperationException {</span>
<span class="source-line-no">084</span><span id="line-84"> this.master = master;</span>
<span class="source-line-no">085</span><span id="line-85"> this.done = false;</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> // setup the default procedure coordinator</span>
<span class="source-line-no">088</span><span id="line-88"> String name = master.getServerName().toString();</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> // get the configuration for the coordinator</span>
<span class="source-line-no">091</span><span id="line-91"> Configuration conf = master.getConfiguration();</span>
<span class="source-line-no">092</span><span id="line-92"> long wakeFrequency = conf.getInt(BACKUP_WAKE_MILLIS_KEY, BACKUP_WAKE_MILLIS_DEFAULT);</span>
<span class="source-line-no">093</span><span id="line-93"> long timeoutMillis = conf.getLong(BACKUP_TIMEOUT_MILLIS_KEY, BACKUP_TIMEOUT_MILLIS_DEFAULT);</span>
<span class="source-line-no">094</span><span id="line-94"> int opThreads = conf.getInt(BACKUP_POOL_THREAD_NUMBER_KEY, BACKUP_POOL_THREAD_NUMBER_DEFAULT);</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> // setup the default procedure coordinator</span>
<span class="source-line-no">097</span><span id="line-97"> ThreadPoolExecutor tpool = ProcedureCoordinator.defaultPool(name, opThreads);</span>
<span class="source-line-no">098</span><span id="line-98"> ProcedureCoordinationManager coordManager = new ZKProcedureCoordinationManager(master);</span>
<span class="source-line-no">099</span><span id="line-99"> ProcedureCoordinatorRpcs comms =</span>
<span class="source-line-no">100</span><span id="line-100"> coordManager.getProcedureCoordinatorRpcs(getProcedureSignature(), name);</span>
<span class="source-line-no">101</span><span id="line-101"> this.coordinator = new ProcedureCoordinator(comms, tpool, timeoutMillis, wakeFrequency);</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104"></span>
<span class="source-line-no">105</span><span id="line-105"> @Override</span>
<span class="source-line-no">106</span><span id="line-106"> public String getProcedureSignature() {</span>
<span class="source-line-no">107</span><span id="line-107"> return ROLLLOG_PROCEDURE_SIGNATURE;</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"> @Override</span>
<span class="source-line-no">111</span><span id="line-111"> public void execProcedure(ProcedureDescription desc) throws IOException {</span>
<span class="source-line-no">112</span><span id="line-112"> if (!isBackupEnabled()) {</span>
<span class="source-line-no">113</span><span id="line-113"> LOG.warn("Backup is not enabled. Check your " + BackupRestoreConstants.BACKUP_ENABLE_KEY</span>
<span class="source-line-no">114</span><span id="line-114"> + " setting");</span>
<span class="source-line-no">115</span><span id="line-115"> return;</span>
<span class="source-line-no">116</span><span id="line-116"> }</span>
<span class="source-line-no">117</span><span id="line-117"> this.done = false;</span>
<span class="source-line-no">118</span><span id="line-118"> // start the process on the RS</span>
<span class="source-line-no">119</span><span id="line-119"> ForeignExceptionDispatcher monitor = new ForeignExceptionDispatcher(desc.getInstance());</span>
<span class="source-line-no">120</span><span id="line-120"> List&lt;ServerName&gt; serverNames = master.getServerManager().getOnlineServersList();</span>
<span class="source-line-no">121</span><span id="line-121"> List&lt;String&gt; servers = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">122</span><span id="line-122"> for (ServerName sn : serverNames) {</span>
<span class="source-line-no">123</span><span id="line-123"> servers.add(sn.toString());</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"> List&lt;NameStringPair&gt; conf = desc.getConfigurationList();</span>
<span class="source-line-no">127</span><span id="line-127"> byte[] data = new byte[0];</span>
<span class="source-line-no">128</span><span id="line-128"> if (conf.size() &gt; 0) {</span>
<span class="source-line-no">129</span><span id="line-129"> // Get backup root path</span>
<span class="source-line-no">130</span><span id="line-130"> data = Bytes.toBytes(conf.get(0).getValue());</span>
<span class="source-line-no">131</span><span id="line-131"> }</span>
<span class="source-line-no">132</span><span id="line-132"> Procedure proc = coordinator.startProcedure(monitor, desc.getInstance(), data, servers);</span>
<span class="source-line-no">133</span><span id="line-133"> if (proc == null) {</span>
<span class="source-line-no">134</span><span id="line-134"> String msg = "Failed to submit distributed procedure for '" + desc.getInstance() + "'";</span>
<span class="source-line-no">135</span><span id="line-135"> LOG.error(msg);</span>
<span class="source-line-no">136</span><span id="line-136"> throw new IOException(msg);</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"> try {</span>
<span class="source-line-no">140</span><span id="line-140"> // wait for the procedure to complete. A timer thread is kicked off that should cancel this</span>
<span class="source-line-no">141</span><span id="line-141"> // if it takes too long.</span>
<span class="source-line-no">142</span><span id="line-142"> proc.waitForCompleted();</span>
<span class="source-line-no">143</span><span id="line-143"> LOG.info("Done waiting - exec procedure for " + desc.getInstance());</span>
<span class="source-line-no">144</span><span id="line-144"> LOG.info("Distributed roll log procedure is successful!");</span>
<span class="source-line-no">145</span><span id="line-145"> this.done = true;</span>
<span class="source-line-no">146</span><span id="line-146"> } catch (InterruptedException e) {</span>
<span class="source-line-no">147</span><span id="line-147"> ForeignException ee =</span>
<span class="source-line-no">148</span><span id="line-148"> new ForeignException("Interrupted while waiting for roll log procdure to finish", e);</span>
<span class="source-line-no">149</span><span id="line-149"> monitor.receive(ee);</span>
<span class="source-line-no">150</span><span id="line-150"> Thread.currentThread().interrupt();</span>
<span class="source-line-no">151</span><span id="line-151"> } catch (ForeignException e) {</span>
<span class="source-line-no">152</span><span id="line-152"> ForeignException ee =</span>
<span class="source-line-no">153</span><span id="line-153"> new ForeignException("Exception while waiting for roll log procdure to finish", e);</span>
<span class="source-line-no">154</span><span id="line-154"> monitor.receive(ee);</span>
<span class="source-line-no">155</span><span id="line-155"> }</span>
<span class="source-line-no">156</span><span id="line-156"> monitor.rethrowException();</span>
<span class="source-line-no">157</span><span id="line-157"> }</span>
<span class="source-line-no">158</span><span id="line-158"></span>
<span class="source-line-no">159</span><span id="line-159"> @Override</span>
<span class="source-line-no">160</span><span id="line-160"> public void checkPermissions(ProcedureDescription desc, AccessChecker accessChecker, User user)</span>
<span class="source-line-no">161</span><span id="line-161"> throws IOException {</span>
<span class="source-line-no">162</span><span id="line-162"> // TODO: what permissions checks are needed here?</span>
<span class="source-line-no">163</span><span id="line-163"> }</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> private boolean isBackupEnabled() {</span>
<span class="source-line-no">166</span><span id="line-166"> return BackupManager.isBackupEnabled(master.getConfiguration());</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"> @Override</span>
<span class="source-line-no">170</span><span id="line-170"> public boolean isProcedureDone(ProcedureDescription desc) {</span>
<span class="source-line-no">171</span><span id="line-171"> return done;</span>
<span class="source-line-no">172</span><span id="line-172"> }</span>
<span class="source-line-no">173</span><span id="line-173">}</span>
</pre>
</div>
</main>
</body>
</html>