blob: 2d270e4a94c35fcc0f0fd1f46a9d93e2818c1f8f [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.regionserver, class: LogRollRegionServerProcedureManager">
<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.regionserver;</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.concurrent.ThreadPoolExecutor;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.backup.BackupRestoreConstants;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.backup.impl.BackupManager;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.backup.master.LogRollMasterProcedureManager;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.errorhandling.ForeignExceptionDispatcher;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.procedure.ProcedureCoordinationManager;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.procedure.ProcedureMember;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.procedure.ProcedureMemberRpcs;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.procedure.RegionServerProcedureManager;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.procedure.Subprocedure;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.procedure.SubprocedureFactory;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.procedure.ZKProcedureCoordinationManager;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.regionserver.RegionServerServices;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.zookeeper.KeeperException;</span>
<span class="source-line-no">037</span><span id="line-37">import org.slf4j.Logger;</span>
<span class="source-line-no">038</span><span id="line-38">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40">/**</span>
<span class="source-line-no">041</span><span id="line-41"> * This manager class handles the work dealing with distributed WAL roll request.</span>
<span class="source-line-no">042</span><span id="line-42"> * &lt;p&gt;</span>
<span class="source-line-no">043</span><span id="line-43"> * This provides the mechanism necessary to kick off a backup specific {@link Subprocedure} that is</span>
<span class="source-line-no">044</span><span id="line-44"> * responsible by this region server. If any failures occur with the sub-procedure, the manager's</span>
<span class="source-line-no">045</span><span id="line-45"> * procedure member notifies the procedure coordinator to abort all others.</span>
<span class="source-line-no">046</span><span id="line-46"> * &lt;p&gt;</span>
<span class="source-line-no">047</span><span id="line-47"> * On startup, requires {@link #start()} to be called.</span>
<span class="source-line-no">048</span><span id="line-48"> * &lt;p&gt;</span>
<span class="source-line-no">049</span><span id="line-49"> * On shutdown, requires org.apache.hadoop.hbase.procedure.ProcedureMember.close() to be called</span>
<span class="source-line-no">050</span><span id="line-50"> */</span>
<span class="source-line-no">051</span><span id="line-51">@InterfaceAudience.Private</span>
<span class="source-line-no">052</span><span id="line-52">public class LogRollRegionServerProcedureManager extends RegionServerProcedureManager {</span>
<span class="source-line-no">053</span><span id="line-53"> private static final Logger LOG =</span>
<span class="source-line-no">054</span><span id="line-54"> LoggerFactory.getLogger(LogRollRegionServerProcedureManager.class);</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> /** Conf key for number of request threads to start backup on region servers */</span>
<span class="source-line-no">057</span><span id="line-57"> public static final String BACKUP_REQUEST_THREADS_KEY = "hbase.backup.region.pool.threads";</span>
<span class="source-line-no">058</span><span id="line-58"> /** # of threads for backup work on the rs. */</span>
<span class="source-line-no">059</span><span id="line-59"> public static final int BACKUP_REQUEST_THREADS_DEFAULT = 10;</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> public static final String BACKUP_TIMEOUT_MILLIS_KEY = "hbase.backup.timeout";</span>
<span class="source-line-no">062</span><span id="line-62"> public static final long BACKUP_TIMEOUT_MILLIS_DEFAULT = 60000;</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> /** Conf key for millis between checks to see if backup work completed or if there are errors */</span>
<span class="source-line-no">065</span><span id="line-65"> public static final String BACKUP_REQUEST_WAKE_MILLIS_KEY = "hbase.backup.region.wakefrequency";</span>
<span class="source-line-no">066</span><span id="line-66"> /** Default amount of time to check for errors while regions finish backup work */</span>
<span class="source-line-no">067</span><span id="line-67"> private static final long BACKUP_REQUEST_WAKE_MILLIS_DEFAULT = 500;</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> private RegionServerServices rss;</span>
<span class="source-line-no">070</span><span id="line-70"> private ProcedureMemberRpcs memberRpcs;</span>
<span class="source-line-no">071</span><span id="line-71"> private ProcedureMember member;</span>
<span class="source-line-no">072</span><span id="line-72"> private boolean started = false;</span>
<span class="source-line-no">073</span><span id="line-73"></span>
<span class="source-line-no">074</span><span id="line-74"> /**</span>
<span class="source-line-no">075</span><span id="line-75"> * Create a default backup procedure manager</span>
<span class="source-line-no">076</span><span id="line-76"> */</span>
<span class="source-line-no">077</span><span id="line-77"> public LogRollRegionServerProcedureManager() {</span>
<span class="source-line-no">078</span><span id="line-78"> }</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"> * Start accepting backup procedure requests.</span>
<span class="source-line-no">082</span><span id="line-82"> */</span>
<span class="source-line-no">083</span><span id="line-83"> @Override</span>
<span class="source-line-no">084</span><span id="line-84"> public void start() {</span>
<span class="source-line-no">085</span><span id="line-85"> if (!BackupManager.isBackupEnabled(rss.getConfiguration())) {</span>
<span class="source-line-no">086</span><span id="line-86"> LOG.warn("Backup is not enabled. Check your " + BackupRestoreConstants.BACKUP_ENABLE_KEY</span>
<span class="source-line-no">087</span><span id="line-87"> + " setting");</span>
<span class="source-line-no">088</span><span id="line-88"> return;</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"> this.memberRpcs.start(rss.getServerName().toString(), member);</span>
<span class="source-line-no">091</span><span id="line-91"> started = true;</span>
<span class="source-line-no">092</span><span id="line-92"> LOG.info("Started region server backup manager.");</span>
<span class="source-line-no">093</span><span id="line-93"> }</span>
<span class="source-line-no">094</span><span id="line-94"></span>
<span class="source-line-no">095</span><span id="line-95"> /**</span>
<span class="source-line-no">096</span><span id="line-96"> * Close &lt;tt&gt;this&lt;/tt&gt; and all running backup procedure tasks</span>
<span class="source-line-no">097</span><span id="line-97"> * @param force forcefully stop all running tasks</span>
<span class="source-line-no">098</span><span id="line-98"> * @throws IOException exception</span>
<span class="source-line-no">099</span><span id="line-99"> */</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 void stop(boolean force) throws IOException {</span>
<span class="source-line-no">102</span><span id="line-102"> if (!started) {</span>
<span class="source-line-no">103</span><span id="line-103"> return;</span>
<span class="source-line-no">104</span><span id="line-104"> }</span>
<span class="source-line-no">105</span><span id="line-105"> String mode = force ? "abruptly" : "gracefully";</span>
<span class="source-line-no">106</span><span id="line-106"> LOG.info("Stopping RegionServerBackupManager " + mode + ".");</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> try {</span>
<span class="source-line-no">109</span><span id="line-109"> this.member.close();</span>
<span class="source-line-no">110</span><span id="line-110"> } finally {</span>
<span class="source-line-no">111</span><span id="line-111"> this.memberRpcs.close();</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"> }</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> /**</span>
<span class="source-line-no">116</span><span id="line-116"> * If in a running state, creates the specified subprocedure for handling a backup procedure.</span>
<span class="source-line-no">117</span><span id="line-117"> * @return Subprocedure to submit to the ProcedureMember.</span>
<span class="source-line-no">118</span><span id="line-118"> */</span>
<span class="source-line-no">119</span><span id="line-119"> public Subprocedure buildSubprocedure(byte[] data) {</span>
<span class="source-line-no">120</span><span id="line-120"> // don't run a backup if the parent is stop(ping)</span>
<span class="source-line-no">121</span><span id="line-121"> if (rss.isStopping() || rss.isStopped()) {</span>
<span class="source-line-no">122</span><span id="line-122"> throw new IllegalStateException("Can't start backup procedure on RS: " + rss.getServerName()</span>
<span class="source-line-no">123</span><span id="line-123"> + ", because stopping/stopped!");</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"> LOG.info("Attempting to run a roll log procedure for backup.");</span>
<span class="source-line-no">127</span><span id="line-127"> ForeignExceptionDispatcher errorDispatcher = new ForeignExceptionDispatcher();</span>
<span class="source-line-no">128</span><span id="line-128"> Configuration conf = rss.getConfiguration();</span>
<span class="source-line-no">129</span><span id="line-129"> long timeoutMillis = conf.getLong(BACKUP_TIMEOUT_MILLIS_KEY, BACKUP_TIMEOUT_MILLIS_DEFAULT);</span>
<span class="source-line-no">130</span><span id="line-130"> long wakeMillis =</span>
<span class="source-line-no">131</span><span id="line-131"> conf.getLong(BACKUP_REQUEST_WAKE_MILLIS_KEY, BACKUP_REQUEST_WAKE_MILLIS_DEFAULT);</span>
<span class="source-line-no">132</span><span id="line-132"></span>
<span class="source-line-no">133</span><span id="line-133"> LogRollBackupSubprocedurePool taskManager =</span>
<span class="source-line-no">134</span><span id="line-134"> new LogRollBackupSubprocedurePool(rss.getServerName().toString(), conf);</span>
<span class="source-line-no">135</span><span id="line-135"> return new LogRollBackupSubprocedure(rss, member, errorDispatcher, wakeMillis, timeoutMillis,</span>
<span class="source-line-no">136</span><span id="line-136"> taskManager, data);</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"> * Build the actual backup procedure runner that will do all the 'hard' work</span>
<span class="source-line-no">141</span><span id="line-141"> */</span>
<span class="source-line-no">142</span><span id="line-142"> public class BackupSubprocedureBuilder implements SubprocedureFactory {</span>
<span class="source-line-no">143</span><span id="line-143"> @Override</span>
<span class="source-line-no">144</span><span id="line-144"> public Subprocedure buildSubprocedure(String name, byte[] data) {</span>
<span class="source-line-no">145</span><span id="line-145"> return LogRollRegionServerProcedureManager.this.buildSubprocedure(data);</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"> @Override</span>
<span class="source-line-no">150</span><span id="line-150"> public void initialize(RegionServerServices rss) throws KeeperException {</span>
<span class="source-line-no">151</span><span id="line-151"> this.rss = rss;</span>
<span class="source-line-no">152</span><span id="line-152"> if (!BackupManager.isBackupEnabled(rss.getConfiguration())) {</span>
<span class="source-line-no">153</span><span id="line-153"> LOG.warn("Backup is not enabled. Check your " + BackupRestoreConstants.BACKUP_ENABLE_KEY</span>
<span class="source-line-no">154</span><span id="line-154"> + " setting");</span>
<span class="source-line-no">155</span><span id="line-155"> return;</span>
<span class="source-line-no">156</span><span id="line-156"> }</span>
<span class="source-line-no">157</span><span id="line-157"> ProcedureCoordinationManager coordManager = new ZKProcedureCoordinationManager(rss);</span>
<span class="source-line-no">158</span><span id="line-158"> this.memberRpcs = coordManager</span>
<span class="source-line-no">159</span><span id="line-159"> .getProcedureMemberRpcs(LogRollMasterProcedureManager.ROLLLOG_PROCEDURE_SIGNATURE);</span>
<span class="source-line-no">160</span><span id="line-160"></span>
<span class="source-line-no">161</span><span id="line-161"> // read in the backup handler configuration properties</span>
<span class="source-line-no">162</span><span id="line-162"> Configuration conf = rss.getConfiguration();</span>
<span class="source-line-no">163</span><span id="line-163"> long keepAlive = conf.getLong(BACKUP_TIMEOUT_MILLIS_KEY, BACKUP_TIMEOUT_MILLIS_DEFAULT);</span>
<span class="source-line-no">164</span><span id="line-164"> int opThreads = conf.getInt(BACKUP_REQUEST_THREADS_KEY, BACKUP_REQUEST_THREADS_DEFAULT);</span>
<span class="source-line-no">165</span><span id="line-165"> // create the actual cohort member</span>
<span class="source-line-no">166</span><span id="line-166"> ThreadPoolExecutor pool =</span>
<span class="source-line-no">167</span><span id="line-167"> ProcedureMember.defaultPool(rss.getServerName().toString(), opThreads, keepAlive);</span>
<span class="source-line-no">168</span><span id="line-168"> this.member = new ProcedureMember(memberRpcs, pool, new BackupSubprocedureBuilder());</span>
<span class="source-line-no">169</span><span id="line-169"> }</span>
<span class="source-line-no">170</span><span id="line-170"></span>
<span class="source-line-no">171</span><span id="line-171"> @Override</span>
<span class="source-line-no">172</span><span id="line-172"> public String getProcedureSignature() {</span>
<span class="source-line-no">173</span><span id="line-173"> return "backup-proc";</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175">}</span>
</pre>
</div>
</main>
</body>
</html>