blob: 73f4e353eb72bc3645c70b80c8d98c6cd4373ea0 [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.impl, class: FullTableBackupClient">
<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.impl;</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 static org.apache.hadoop.hbase.backup.BackupRestoreConstants.BACKUP_ATTEMPTS_PAUSE_MS_KEY;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.BACKUP_MAX_ATTEMPTS_KEY;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.DEFAULT_BACKUP_ATTEMPTS_PAUSE_MS;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.DEFAULT_BACKUP_MAX_ATTEMPTS;</span>
<span class="source-line-no">024</span><span id="line-24">import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.JOB_NAME_CONF_KEY;</span>
<span class="source-line-no">025</span><span id="line-25"></span>
<span class="source-line-no">026</span><span id="line-26">import java.io.IOException;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.ArrayList;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.HashMap;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.Map;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.backup.BackupCopyJob;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.backup.BackupInfo;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.backup.BackupInfo.BackupPhase;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.backup.BackupInfo.BackupState;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.backup.BackupRequest;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.backup.BackupRestoreFactory;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.backup.BackupType;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.backup.master.LogRollMasterProcedureManager;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.backup.util.BackupUtils;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.client.Admin;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.client.Connection;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">044</span><span id="line-44">import org.slf4j.Logger;</span>
<span class="source-line-no">045</span><span id="line-45">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47">/**</span>
<span class="source-line-no">048</span><span id="line-48"> * Full table backup implementation</span>
<span class="source-line-no">049</span><span id="line-49"> */</span>
<span class="source-line-no">050</span><span id="line-50">@InterfaceAudience.Private</span>
<span class="source-line-no">051</span><span id="line-51">public class FullTableBackupClient extends TableBackupClient {</span>
<span class="source-line-no">052</span><span id="line-52"> private static final Logger LOG = LoggerFactory.getLogger(FullTableBackupClient.class);</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> public FullTableBackupClient() {</span>
<span class="source-line-no">055</span><span id="line-55"> }</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 FullTableBackupClient(final Connection conn, final String backupId, BackupRequest request)</span>
<span class="source-line-no">058</span><span id="line-58"> throws IOException {</span>
<span class="source-line-no">059</span><span id="line-59"> super(conn, backupId, request);</span>
<span class="source-line-no">060</span><span id="line-60"> }</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> /**</span>
<span class="source-line-no">063</span><span id="line-63"> * Do snapshot copy.</span>
<span class="source-line-no">064</span><span id="line-64"> * @param backupInfo backup info</span>
<span class="source-line-no">065</span><span id="line-65"> * @throws Exception exception</span>
<span class="source-line-no">066</span><span id="line-66"> */</span>
<span class="source-line-no">067</span><span id="line-67"> protected void snapshotCopy(BackupInfo backupInfo) throws Exception {</span>
<span class="source-line-no">068</span><span id="line-68"> LOG.info("Snapshot copy is starting.");</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> // set overall backup phase: snapshot_copy</span>
<span class="source-line-no">071</span><span id="line-71"> backupInfo.setPhase(BackupPhase.SNAPSHOTCOPY);</span>
<span class="source-line-no">072</span><span id="line-72"></span>
<span class="source-line-no">073</span><span id="line-73"> // call ExportSnapshot to copy files based on hbase snapshot for backup</span>
<span class="source-line-no">074</span><span id="line-74"> // ExportSnapshot only support single snapshot export, need loop for multiple tables case</span>
<span class="source-line-no">075</span><span id="line-75"> BackupCopyJob copyService = BackupRestoreFactory.getBackupCopyJob(conf);</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> // number of snapshots matches number of tables</span>
<span class="source-line-no">078</span><span id="line-78"> float numOfSnapshots = backupInfo.getSnapshotNames().size();</span>
<span class="source-line-no">079</span><span id="line-79"></span>
<span class="source-line-no">080</span><span id="line-80"> LOG.debug("There are " + (int) numOfSnapshots + " snapshots to be copied.");</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> for (TableName table : backupInfo.getTables()) {</span>
<span class="source-line-no">083</span><span id="line-83"> // Currently we simply set the sub copy tasks by counting the table snapshot number, we can</span>
<span class="source-line-no">084</span><span id="line-84"> // calculate the real files' size for the percentage in the future.</span>
<span class="source-line-no">085</span><span id="line-85"> // backupCopier.setSubTaskPercntgInWholeTask(1f / numOfSnapshots);</span>
<span class="source-line-no">086</span><span id="line-86"> int res;</span>
<span class="source-line-no">087</span><span id="line-87"> ArrayList&lt;String&gt; argsList = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">088</span><span id="line-88"> argsList.add("-snapshot");</span>
<span class="source-line-no">089</span><span id="line-89"> argsList.add(backupInfo.getSnapshotName(table));</span>
<span class="source-line-no">090</span><span id="line-90"> argsList.add("-copy-to");</span>
<span class="source-line-no">091</span><span id="line-91"> argsList.add(backupInfo.getTableBackupDir(table));</span>
<span class="source-line-no">092</span><span id="line-92"> if (backupInfo.getBandwidth() &gt; -1) {</span>
<span class="source-line-no">093</span><span id="line-93"> argsList.add("-bandwidth");</span>
<span class="source-line-no">094</span><span id="line-94"> argsList.add(String.valueOf(backupInfo.getBandwidth()));</span>
<span class="source-line-no">095</span><span id="line-95"> }</span>
<span class="source-line-no">096</span><span id="line-96"> if (backupInfo.getWorkers() &gt; -1) {</span>
<span class="source-line-no">097</span><span id="line-97"> argsList.add("-mappers");</span>
<span class="source-line-no">098</span><span id="line-98"> argsList.add(String.valueOf(backupInfo.getWorkers()));</span>
<span class="source-line-no">099</span><span id="line-99"> }</span>
<span class="source-line-no">100</span><span id="line-100"> if (backupInfo.getNoChecksumVerify()) {</span>
<span class="source-line-no">101</span><span id="line-101"> argsList.add("-no-checksum-verify");</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"> String[] args = argsList.toArray(new String[0]);</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> String jobname = "Full-Backup_" + backupInfo.getBackupId() + "_" + table.getNameAsString();</span>
<span class="source-line-no">107</span><span id="line-107"> if (LOG.isDebugEnabled()) {</span>
<span class="source-line-no">108</span><span id="line-108"> LOG.debug("Setting snapshot copy job name to : " + jobname);</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"> conf.set(JOB_NAME_CONF_KEY, jobname);</span>
<span class="source-line-no">111</span><span id="line-111"></span>
<span class="source-line-no">112</span><span id="line-112"> LOG.debug("Copy snapshot " + args[1] + " to " + args[3]);</span>
<span class="source-line-no">113</span><span id="line-113"> res = copyService.copy(backupInfo, backupManager, conf, BackupType.FULL, args);</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> // if one snapshot export failed, do not continue for remained snapshots</span>
<span class="source-line-no">116</span><span id="line-116"> if (res != 0) {</span>
<span class="source-line-no">117</span><span id="line-117"> LOG.error("Exporting Snapshot " + args[1] + " failed with return code: " + res + ".");</span>
<span class="source-line-no">118</span><span id="line-118"></span>
<span class="source-line-no">119</span><span id="line-119"> throw new IOException("Failed of exporting snapshot " + args[1] + " to " + args[3]</span>
<span class="source-line-no">120</span><span id="line-120"> + " with reason code " + res);</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"></span>
<span class="source-line-no">123</span><span id="line-123"> conf.unset(JOB_NAME_CONF_KEY);</span>
<span class="source-line-no">124</span><span id="line-124"> LOG.info("Snapshot copy " + args[1] + " finished.");</span>
<span class="source-line-no">125</span><span id="line-125"> }</span>
<span class="source-line-no">126</span><span id="line-126"> }</span>
<span class="source-line-no">127</span><span id="line-127"></span>
<span class="source-line-no">128</span><span id="line-128"> /**</span>
<span class="source-line-no">129</span><span id="line-129"> * Backup request execution.</span>
<span class="source-line-no">130</span><span id="line-130"> * @throws IOException if the execution of the backup fails</span>
<span class="source-line-no">131</span><span id="line-131"> */</span>
<span class="source-line-no">132</span><span id="line-132"> @Override</span>
<span class="source-line-no">133</span><span id="line-133"> public void execute() throws IOException {</span>
<span class="source-line-no">134</span><span id="line-134"> try (Admin admin = conn.getAdmin()) {</span>
<span class="source-line-no">135</span><span id="line-135"> // Begin BACKUP</span>
<span class="source-line-no">136</span><span id="line-136"> beginBackup(backupManager, backupInfo);</span>
<span class="source-line-no">137</span><span id="line-137"> String savedStartCode;</span>
<span class="source-line-no">138</span><span id="line-138"> boolean firstBackup;</span>
<span class="source-line-no">139</span><span id="line-139"> // do snapshot for full table backup</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> savedStartCode = backupManager.readBackupStartCode();</span>
<span class="source-line-no">142</span><span id="line-142"> firstBackup = savedStartCode == null || Long.parseLong(savedStartCode) == 0L;</span>
<span class="source-line-no">143</span><span id="line-143"> if (firstBackup) {</span>
<span class="source-line-no">144</span><span id="line-144"> // This is our first backup. Let's put some marker to system table so that we can hold the</span>
<span class="source-line-no">145</span><span id="line-145"> // logs while we do the backup.</span>
<span class="source-line-no">146</span><span id="line-146"> backupManager.writeBackupStartCode(0L);</span>
<span class="source-line-no">147</span><span id="line-147"> }</span>
<span class="source-line-no">148</span><span id="line-148"> // We roll log here before we do the snapshot. It is possible there is duplicate data</span>
<span class="source-line-no">149</span><span id="line-149"> // in the log that is already in the snapshot. But if we do it after the snapshot, we</span>
<span class="source-line-no">150</span><span id="line-150"> // could have data loss.</span>
<span class="source-line-no">151</span><span id="line-151"> // A better approach is to do the roll log on each RS in the same global procedure as</span>
<span class="source-line-no">152</span><span id="line-152"> // the snapshot.</span>
<span class="source-line-no">153</span><span id="line-153"> LOG.info("Execute roll log procedure for full backup ...");</span>
<span class="source-line-no">154</span><span id="line-154"></span>
<span class="source-line-no">155</span><span id="line-155"> Map&lt;String, String&gt; props = new HashMap&lt;&gt;();</span>
<span class="source-line-no">156</span><span id="line-156"> props.put("backupRoot", backupInfo.getBackupRootDir());</span>
<span class="source-line-no">157</span><span id="line-157"> admin.execProcedure(LogRollMasterProcedureManager.ROLLLOG_PROCEDURE_SIGNATURE,</span>
<span class="source-line-no">158</span><span id="line-158"> LogRollMasterProcedureManager.ROLLLOG_PROCEDURE_NAME, props);</span>
<span class="source-line-no">159</span><span id="line-159"></span>
<span class="source-line-no">160</span><span id="line-160"> newTimestamps = backupManager.readRegionServerLastLogRollResult();</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> // SNAPSHOT_TABLES:</span>
<span class="source-line-no">163</span><span id="line-163"> backupInfo.setPhase(BackupPhase.SNAPSHOT);</span>
<span class="source-line-no">164</span><span id="line-164"> for (TableName tableName : tableList) {</span>
<span class="source-line-no">165</span><span id="line-165"> String snapshotName = "snapshot_" + Long.toString(EnvironmentEdgeManager.currentTime())</span>
<span class="source-line-no">166</span><span id="line-166"> + "_" + tableName.getNamespaceAsString() + "_" + tableName.getQualifierAsString();</span>
<span class="source-line-no">167</span><span id="line-167"></span>
<span class="source-line-no">168</span><span id="line-168"> snapshotTable(admin, tableName, snapshotName);</span>
<span class="source-line-no">169</span><span id="line-169"> backupInfo.setSnapshotName(tableName, snapshotName);</span>
<span class="source-line-no">170</span><span id="line-170"> }</span>
<span class="source-line-no">171</span><span id="line-171"></span>
<span class="source-line-no">172</span><span id="line-172"> // SNAPSHOT_COPY:</span>
<span class="source-line-no">173</span><span id="line-173"> // do snapshot copy</span>
<span class="source-line-no">174</span><span id="line-174"> LOG.debug("snapshot copy for " + backupId);</span>
<span class="source-line-no">175</span><span id="line-175"> snapshotCopy(backupInfo);</span>
<span class="source-line-no">176</span><span id="line-176"> // Updates incremental backup table set</span>
<span class="source-line-no">177</span><span id="line-177"> backupManager.addIncrementalBackupTableSet(backupInfo.getTables());</span>
<span class="source-line-no">178</span><span id="line-178"></span>
<span class="source-line-no">179</span><span id="line-179"> // BACKUP_COMPLETE:</span>
<span class="source-line-no">180</span><span id="line-180"> // set overall backup status: complete. Here we make sure to complete the backup.</span>
<span class="source-line-no">181</span><span id="line-181"> // After this checkpoint, even if entering cancel process, will let the backup finished</span>
<span class="source-line-no">182</span><span id="line-182"> backupInfo.setState(BackupState.COMPLETE);</span>
<span class="source-line-no">183</span><span id="line-183"> // The table list in backupInfo is good for both full backup and incremental backup.</span>
<span class="source-line-no">184</span><span id="line-184"> // For incremental backup, it contains the incremental backup table set.</span>
<span class="source-line-no">185</span><span id="line-185"> backupManager.writeRegionServerLogTimestamp(backupInfo.getTables(), newTimestamps);</span>
<span class="source-line-no">186</span><span id="line-186"></span>
<span class="source-line-no">187</span><span id="line-187"> Map&lt;TableName, Map&lt;String, Long&gt;&gt; newTableSetTimestampMap =</span>
<span class="source-line-no">188</span><span id="line-188"> backupManager.readLogTimestampMap();</span>
<span class="source-line-no">189</span><span id="line-189"></span>
<span class="source-line-no">190</span><span id="line-190"> backupInfo.setTableSetTimestampMap(newTableSetTimestampMap);</span>
<span class="source-line-no">191</span><span id="line-191"> Long newStartCode =</span>
<span class="source-line-no">192</span><span id="line-192"> BackupUtils.getMinValue(BackupUtils.getRSLogTimestampMins(newTableSetTimestampMap));</span>
<span class="source-line-no">193</span><span id="line-193"> backupManager.writeBackupStartCode(newStartCode);</span>
<span class="source-line-no">194</span><span id="line-194"></span>
<span class="source-line-no">195</span><span id="line-195"> // backup complete</span>
<span class="source-line-no">196</span><span id="line-196"> completeBackup(conn, backupInfo, BackupType.FULL, conf);</span>
<span class="source-line-no">197</span><span id="line-197"> } catch (Exception e) {</span>
<span class="source-line-no">198</span><span id="line-198"> failBackup(conn, backupInfo, backupManager, e, "Unexpected BackupException : ",</span>
<span class="source-line-no">199</span><span id="line-199"> BackupType.FULL, conf);</span>
<span class="source-line-no">200</span><span id="line-200"> throw new IOException(e);</span>
<span class="source-line-no">201</span><span id="line-201"> }</span>
<span class="source-line-no">202</span><span id="line-202"> }</span>
<span class="source-line-no">203</span><span id="line-203"></span>
<span class="source-line-no">204</span><span id="line-204"> protected void snapshotTable(Admin admin, TableName tableName, String snapshotName)</span>
<span class="source-line-no">205</span><span id="line-205"> throws IOException {</span>
<span class="source-line-no">206</span><span id="line-206"> int maxAttempts = conf.getInt(BACKUP_MAX_ATTEMPTS_KEY, DEFAULT_BACKUP_MAX_ATTEMPTS);</span>
<span class="source-line-no">207</span><span id="line-207"> int pause = conf.getInt(BACKUP_ATTEMPTS_PAUSE_MS_KEY, DEFAULT_BACKUP_ATTEMPTS_PAUSE_MS);</span>
<span class="source-line-no">208</span><span id="line-208"> int attempts = 0;</span>
<span class="source-line-no">209</span><span id="line-209"></span>
<span class="source-line-no">210</span><span id="line-210"> while (attempts++ &lt; maxAttempts) {</span>
<span class="source-line-no">211</span><span id="line-211"> try {</span>
<span class="source-line-no">212</span><span id="line-212"> admin.snapshot(snapshotName, tableName);</span>
<span class="source-line-no">213</span><span id="line-213"> return;</span>
<span class="source-line-no">214</span><span id="line-214"> } catch (IOException ee) {</span>
<span class="source-line-no">215</span><span id="line-215"> LOG.warn("Snapshot attempt " + attempts + " failed for table " + tableName</span>
<span class="source-line-no">216</span><span id="line-216"> + ", sleeping for " + pause + "ms", ee);</span>
<span class="source-line-no">217</span><span id="line-217"> if (attempts &lt; maxAttempts) {</span>
<span class="source-line-no">218</span><span id="line-218"> try {</span>
<span class="source-line-no">219</span><span id="line-219"> Thread.sleep(pause);</span>
<span class="source-line-no">220</span><span id="line-220"> } catch (InterruptedException e) {</span>
<span class="source-line-no">221</span><span id="line-221"> Thread.currentThread().interrupt();</span>
<span class="source-line-no">222</span><span id="line-222"> break;</span>
<span class="source-line-no">223</span><span id="line-223"> }</span>
<span class="source-line-no">224</span><span id="line-224"> }</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>
<span class="source-line-no">227</span><span id="line-227"> throw new IOException("Failed to snapshot table " + tableName);</span>
<span class="source-line-no">228</span><span id="line-228"> }</span>
<span class="source-line-no">229</span><span id="line-229">}</span>
</pre>
</div>
</main>
</body>
</html>