| <!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: TableBackupClient"> |
| <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 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.Collections;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.HashSet;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.List;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.Map;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.Objects;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.util.Set;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.fs.FileStatus;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.backup.BackupInfo;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.backup.BackupInfo.BackupPhase;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.backup.BackupInfo.BackupState;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.backup.BackupRequest;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.backup.BackupRestoreConstants;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.backup.BackupType;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.backup.HBackupFileSystem;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.backup.impl.BackupManifest.BackupImage;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.client.Admin;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.client.Connection;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.util.CommonFSUtils;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.slf4j.Logger;</span> |
| <span class="source-line-no">047</span><span id="line-47">import org.slf4j.LoggerFactory;</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"> * Base class for backup operation. Concrete implementation for full and incremental backup are</span> |
| <span class="source-line-no">051</span><span id="line-51"> * delegated to corresponding sub-classes: {@link FullTableBackupClient} and</span> |
| <span class="source-line-no">052</span><span id="line-52"> * {@link IncrementalTableBackupClient}</span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54">@InterfaceAudience.Private</span> |
| <span class="source-line-no">055</span><span id="line-55">public abstract class TableBackupClient {</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 BACKUP_CLIENT_IMPL_CLASS = "backup.client.impl.class";</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> public static final String BACKUP_TEST_MODE_STAGE = "backup.test.mode.stage";</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> private static final Logger LOG = LoggerFactory.getLogger(TableBackupClient.class);</span> |
| <span class="source-line-no">062</span><span id="line-62"></span> |
| <span class="source-line-no">063</span><span id="line-63"> protected Configuration conf;</span> |
| <span class="source-line-no">064</span><span id="line-64"> protected Connection conn;</span> |
| <span class="source-line-no">065</span><span id="line-65"> protected String backupId;</span> |
| <span class="source-line-no">066</span><span id="line-66"> protected List<TableName> tableList;</span> |
| <span class="source-line-no">067</span><span id="line-67"> protected Map<String, Long> newTimestamps = null;</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> protected BackupManager backupManager;</span> |
| <span class="source-line-no">070</span><span id="line-70"> protected BackupInfo backupInfo;</span> |
| <span class="source-line-no">071</span><span id="line-71"> protected FileSystem fs;</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> public TableBackupClient() {</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"> public TableBackupClient(final Connection conn, final String backupId, BackupRequest request)</span> |
| <span class="source-line-no">077</span><span id="line-77"> throws IOException {</span> |
| <span class="source-line-no">078</span><span id="line-78"> init(conn, backupId, request);</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"> public void init(final Connection conn, final String backupId, BackupRequest request)</span> |
| <span class="source-line-no">082</span><span id="line-82"> throws IOException {</span> |
| <span class="source-line-no">083</span><span id="line-83"> if (request.getBackupType() == BackupType.FULL) {</span> |
| <span class="source-line-no">084</span><span id="line-84"> backupManager = new BackupManager(conn, conn.getConfiguration());</span> |
| <span class="source-line-no">085</span><span id="line-85"> } else {</span> |
| <span class="source-line-no">086</span><span id="line-86"> backupManager = new IncrementalBackupManager(conn, conn.getConfiguration());</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"> this.backupId = backupId;</span> |
| <span class="source-line-no">089</span><span id="line-89"> this.tableList = request.getTableList();</span> |
| <span class="source-line-no">090</span><span id="line-90"> this.conn = conn;</span> |
| <span class="source-line-no">091</span><span id="line-91"> this.conf = conn.getConfiguration();</span> |
| <span class="source-line-no">092</span><span id="line-92"> this.fs = CommonFSUtils.getCurrentFileSystem(conf);</span> |
| <span class="source-line-no">093</span><span id="line-93"> backupInfo = backupManager.createBackupInfo(backupId, request.getBackupType(), tableList,</span> |
| <span class="source-line-no">094</span><span id="line-94"> request.getTargetRootDir(), request.getTotalTasks(), request.getBandwidth(),</span> |
| <span class="source-line-no">095</span><span id="line-95"> request.getNoChecksumVerify());</span> |
| <span class="source-line-no">096</span><span id="line-96"> if (tableList == null || tableList.isEmpty()) {</span> |
| <span class="source-line-no">097</span><span id="line-97"> this.tableList = new ArrayList<>(backupInfo.getTables());</span> |
| <span class="source-line-no">098</span><span id="line-98"> }</span> |
| <span class="source-line-no">099</span><span id="line-99"> // Start new session</span> |
| <span class="source-line-no">100</span><span id="line-100"> backupManager.startBackupSession();</span> |
| <span class="source-line-no">101</span><span id="line-101"> }</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"> * Begin the overall backup.</span> |
| <span class="source-line-no">105</span><span id="line-105"> * @param backupInfo backup info</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @throws IOException exception</span> |
| <span class="source-line-no">107</span><span id="line-107"> */</span> |
| <span class="source-line-no">108</span><span id="line-108"> protected void beginBackup(BackupManager backupManager, BackupInfo backupInfo)</span> |
| <span class="source-line-no">109</span><span id="line-109"> throws IOException {</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> BackupSystemTable.snapshot(conn);</span> |
| <span class="source-line-no">112</span><span id="line-112"> backupManager.setBackupInfo(backupInfo);</span> |
| <span class="source-line-no">113</span><span id="line-113"> // set the start timestamp of the overall backup</span> |
| <span class="source-line-no">114</span><span id="line-114"> long startTs = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">115</span><span id="line-115"> backupInfo.setStartTs(startTs);</span> |
| <span class="source-line-no">116</span><span id="line-116"> // set overall backup status: ongoing</span> |
| <span class="source-line-no">117</span><span id="line-117"> backupInfo.setState(BackupState.RUNNING);</span> |
| <span class="source-line-no">118</span><span id="line-118"> backupInfo.setPhase(BackupPhase.REQUEST);</span> |
| <span class="source-line-no">119</span><span id="line-119"> LOG.info("Backup " + backupInfo.getBackupId() + " started at " + startTs + ".");</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> backupManager.updateBackupInfo(backupInfo);</span> |
| <span class="source-line-no">122</span><span id="line-122"> if (LOG.isDebugEnabled()) {</span> |
| <span class="source-line-no">123</span><span id="line-123"> LOG.debug("Backup session " + backupInfo.getBackupId() + " has been started.");</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"></span> |
| <span class="source-line-no">127</span><span id="line-127"> protected String getMessage(Exception e) {</span> |
| <span class="source-line-no">128</span><span id="line-128"> String msg = e.getMessage();</span> |
| <span class="source-line-no">129</span><span id="line-129"> if (msg == null || msg.equals("")) {</span> |
| <span class="source-line-no">130</span><span id="line-130"> msg = e.getClass().getName();</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</span> |
| <span class="source-line-no">132</span><span id="line-132"> return msg;</span> |
| <span class="source-line-no">133</span><span id="line-133"> }</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> /**</span> |
| <span class="source-line-no">136</span><span id="line-136"> * Delete HBase snapshot for backup.</span> |
| <span class="source-line-no">137</span><span id="line-137"> * @param backupInfo backup info</span> |
| <span class="source-line-no">138</span><span id="line-138"> * @throws IOException exception</span> |
| <span class="source-line-no">139</span><span id="line-139"> */</span> |
| <span class="source-line-no">140</span><span id="line-140"> protected static void deleteSnapshots(final Connection conn, BackupInfo backupInfo,</span> |
| <span class="source-line-no">141</span><span id="line-141"> Configuration conf) throws IOException {</span> |
| <span class="source-line-no">142</span><span id="line-142"> LOG.debug("Trying to delete snapshot for full backup.");</span> |
| <span class="source-line-no">143</span><span id="line-143"> for (String snapshotName : backupInfo.getSnapshotNames()) {</span> |
| <span class="source-line-no">144</span><span id="line-144"> if (snapshotName == null) {</span> |
| <span class="source-line-no">145</span><span id="line-145"> continue;</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147"> LOG.debug("Trying to delete snapshot: " + snapshotName);</span> |
| <span class="source-line-no">148</span><span id="line-148"></span> |
| <span class="source-line-no">149</span><span id="line-149"> try (Admin admin = conn.getAdmin()) {</span> |
| <span class="source-line-no">150</span><span id="line-150"> admin.deleteSnapshot(snapshotName);</span> |
| <span class="source-line-no">151</span><span id="line-151"> }</span> |
| <span class="source-line-no">152</span><span id="line-152"> LOG.debug("Deleting the snapshot " + snapshotName + " for backup " + backupInfo.getBackupId()</span> |
| <span class="source-line-no">153</span><span id="line-153"> + " succeeded.");</span> |
| <span class="source-line-no">154</span><span id="line-154"> }</span> |
| <span class="source-line-no">155</span><span id="line-155"> }</span> |
| <span class="source-line-no">156</span><span id="line-156"></span> |
| <span class="source-line-no">157</span><span id="line-157"> /**</span> |
| <span class="source-line-no">158</span><span id="line-158"> * Clean up directories with prefix "exportSnapshot-", which are generated when exporting</span> |
| <span class="source-line-no">159</span><span id="line-159"> * snapshots.</span> |
| <span class="source-line-no">160</span><span id="line-160"> * @throws IOException exception</span> |
| <span class="source-line-no">161</span><span id="line-161"> */</span> |
| <span class="source-line-no">162</span><span id="line-162"> protected static void cleanupExportSnapshotLog(Configuration conf) throws IOException {</span> |
| <span class="source-line-no">163</span><span id="line-163"> FileSystem fs = CommonFSUtils.getCurrentFileSystem(conf);</span> |
| <span class="source-line-no">164</span><span id="line-164"> Path stagingDir = new Path(</span> |
| <span class="source-line-no">165</span><span id="line-165"> conf.get(BackupRestoreConstants.CONF_STAGING_ROOT, fs.getWorkingDirectory().toString()));</span> |
| <span class="source-line-no">166</span><span id="line-166"> FileStatus[] files = CommonFSUtils.listStatus(fs, stagingDir);</span> |
| <span class="source-line-no">167</span><span id="line-167"> if (files == null) {</span> |
| <span class="source-line-no">168</span><span id="line-168"> return;</span> |
| <span class="source-line-no">169</span><span id="line-169"> }</span> |
| <span class="source-line-no">170</span><span id="line-170"> for (FileStatus file : files) {</span> |
| <span class="source-line-no">171</span><span id="line-171"> if (file.getPath().getName().startsWith("exportSnapshot-")) {</span> |
| <span class="source-line-no">172</span><span id="line-172"> LOG.debug("Delete log files of exporting snapshot: " + file.getPath().getName());</span> |
| <span class="source-line-no">173</span><span id="line-173"> if (CommonFSUtils.delete(fs, file.getPath(), true) == false) {</span> |
| <span class="source-line-no">174</span><span id="line-174"> LOG.warn("Can not delete " + file.getPath());</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176"> }</span> |
| <span class="source-line-no">177</span><span id="line-177"> }</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"></span> |
| <span class="source-line-no">180</span><span id="line-180"> /**</span> |
| <span class="source-line-no">181</span><span id="line-181"> * Clean up the uncompleted data at target directory if the ongoing backup has already entered the</span> |
| <span class="source-line-no">182</span><span id="line-182"> * copy phase.</span> |
| <span class="source-line-no">183</span><span id="line-183"> */</span> |
| <span class="source-line-no">184</span><span id="line-184"> protected static void cleanupTargetDir(BackupInfo backupInfo, Configuration conf) {</span> |
| <span class="source-line-no">185</span><span id="line-185"> try {</span> |
| <span class="source-line-no">186</span><span id="line-186"> // clean up the uncompleted data at target directory if the ongoing backup has already entered</span> |
| <span class="source-line-no">187</span><span id="line-187"> // the copy phase</span> |
| <span class="source-line-no">188</span><span id="line-188"> LOG.debug("Trying to cleanup up target dir. Current backup phase: " + backupInfo.getPhase());</span> |
| <span class="source-line-no">189</span><span id="line-189"> if (</span> |
| <span class="source-line-no">190</span><span id="line-190"> backupInfo.getPhase().equals(BackupPhase.SNAPSHOTCOPY)</span> |
| <span class="source-line-no">191</span><span id="line-191"> || backupInfo.getPhase().equals(BackupPhase.INCREMENTAL_COPY)</span> |
| <span class="source-line-no">192</span><span id="line-192"> || backupInfo.getPhase().equals(BackupPhase.STORE_MANIFEST)</span> |
| <span class="source-line-no">193</span><span id="line-193"> ) {</span> |
| <span class="source-line-no">194</span><span id="line-194"> FileSystem outputFs = FileSystem.get(new Path(backupInfo.getBackupRootDir()).toUri(), conf);</span> |
| <span class="source-line-no">195</span><span id="line-195"></span> |
| <span class="source-line-no">196</span><span id="line-196"> // now treat one backup as a transaction, clean up data that has been partially copied at</span> |
| <span class="source-line-no">197</span><span id="line-197"> // table level</span> |
| <span class="source-line-no">198</span><span id="line-198"> for (TableName table : backupInfo.getTables()) {</span> |
| <span class="source-line-no">199</span><span id="line-199"> Path targetDirPath = new Path(HBackupFileSystem</span> |
| <span class="source-line-no">200</span><span id="line-200"> .getTableBackupDir(backupInfo.getBackupRootDir(), backupInfo.getBackupId(), table));</span> |
| <span class="source-line-no">201</span><span id="line-201"> if (outputFs.delete(targetDirPath, true)) {</span> |
| <span class="source-line-no">202</span><span id="line-202"> LOG.debug(</span> |
| <span class="source-line-no">203</span><span id="line-203"> "Cleaning up uncompleted backup data at " + targetDirPath.toString() + " done.");</span> |
| <span class="source-line-no">204</span><span id="line-204"> } else {</span> |
| <span class="source-line-no">205</span><span id="line-205"> LOG.debug("No data has been copied to " + targetDirPath.toString() + ".");</span> |
| <span class="source-line-no">206</span><span id="line-206"> }</span> |
| <span class="source-line-no">207</span><span id="line-207"></span> |
| <span class="source-line-no">208</span><span id="line-208"> Path tableDir = targetDirPath.getParent();</span> |
| <span class="source-line-no">209</span><span id="line-209"> FileStatus[] backups = CommonFSUtils.listStatus(outputFs, tableDir);</span> |
| <span class="source-line-no">210</span><span id="line-210"> if (backups == null || backups.length == 0) {</span> |
| <span class="source-line-no">211</span><span id="line-211"> outputFs.delete(tableDir, true);</span> |
| <span class="source-line-no">212</span><span id="line-212"> LOG.debug(tableDir.toString() + " is empty, remove it.");</span> |
| <span class="source-line-no">213</span><span id="line-213"> }</span> |
| <span class="source-line-no">214</span><span id="line-214"> }</span> |
| <span class="source-line-no">215</span><span id="line-215"> }</span> |
| <span class="source-line-no">216</span><span id="line-216"></span> |
| <span class="source-line-no">217</span><span id="line-217"> } catch (IOException e1) {</span> |
| <span class="source-line-no">218</span><span id="line-218"> LOG.error("Cleaning up uncompleted backup data of " + backupInfo.getBackupId() + " at "</span> |
| <span class="source-line-no">219</span><span id="line-219"> + backupInfo.getBackupRootDir() + " failed due to " + e1.getMessage() + ".");</span> |
| <span class="source-line-no">220</span><span id="line-220"> }</span> |
| <span class="source-line-no">221</span><span id="line-221"> }</span> |
| <span class="source-line-no">222</span><span id="line-222"></span> |
| <span class="source-line-no">223</span><span id="line-223"> /**</span> |
| <span class="source-line-no">224</span><span id="line-224"> * Fail the overall backup.</span> |
| <span class="source-line-no">225</span><span id="line-225"> * @param backupInfo backup info</span> |
| <span class="source-line-no">226</span><span id="line-226"> * @param e exception</span> |
| <span class="source-line-no">227</span><span id="line-227"> * @throws IOException exception</span> |
| <span class="source-line-no">228</span><span id="line-228"> */</span> |
| <span class="source-line-no">229</span><span id="line-229"> protected void failBackup(Connection conn, BackupInfo backupInfo, BackupManager backupManager,</span> |
| <span class="source-line-no">230</span><span id="line-230"> Exception e, String msg, BackupType type, Configuration conf) throws IOException {</span> |
| <span class="source-line-no">231</span><span id="line-231"> try {</span> |
| <span class="source-line-no">232</span><span id="line-232"> LOG.error(msg + getMessage(e), e);</span> |
| <span class="source-line-no">233</span><span id="line-233"> // If this is a cancel exception, then we've already cleaned.</span> |
| <span class="source-line-no">234</span><span id="line-234"> // set the failure timestamp of the overall backup</span> |
| <span class="source-line-no">235</span><span id="line-235"> backupInfo.setCompleteTs(EnvironmentEdgeManager.currentTime());</span> |
| <span class="source-line-no">236</span><span id="line-236"> // set failure message</span> |
| <span class="source-line-no">237</span><span id="line-237"> backupInfo.setFailedMsg(e.getMessage());</span> |
| <span class="source-line-no">238</span><span id="line-238"> // set overall backup status: failed</span> |
| <span class="source-line-no">239</span><span id="line-239"> backupInfo.setState(BackupState.FAILED);</span> |
| <span class="source-line-no">240</span><span id="line-240"> // compose the backup failed data</span> |
| <span class="source-line-no">241</span><span id="line-241"> String backupFailedData = "BackupId=" + backupInfo.getBackupId() + ",startts="</span> |
| <span class="source-line-no">242</span><span id="line-242"> + backupInfo.getStartTs() + ",failedts=" + backupInfo.getCompleteTs() + ",failedphase="</span> |
| <span class="source-line-no">243</span><span id="line-243"> + backupInfo.getPhase() + ",failedmessage=" + backupInfo.getFailedMsg();</span> |
| <span class="source-line-no">244</span><span id="line-244"> LOG.error(backupFailedData);</span> |
| <span class="source-line-no">245</span><span id="line-245"> cleanupAndRestoreBackupSystem(conn, backupInfo, conf);</span> |
| <span class="source-line-no">246</span><span id="line-246"> // If backup session is updated to FAILED state - means we</span> |
| <span class="source-line-no">247</span><span id="line-247"> // processed recovery already.</span> |
| <span class="source-line-no">248</span><span id="line-248"> backupManager.updateBackupInfo(backupInfo);</span> |
| <span class="source-line-no">249</span><span id="line-249"> backupManager.finishBackupSession();</span> |
| <span class="source-line-no">250</span><span id="line-250"> LOG.error("Backup " + backupInfo.getBackupId() + " failed.");</span> |
| <span class="source-line-no">251</span><span id="line-251"> } catch (IOException ee) {</span> |
| <span class="source-line-no">252</span><span id="line-252"> LOG.error("Please run backup repair tool manually to restore backup system integrity");</span> |
| <span class="source-line-no">253</span><span id="line-253"> throw ee;</span> |
| <span class="source-line-no">254</span><span id="line-254"> }</span> |
| <span class="source-line-no">255</span><span id="line-255"> }</span> |
| <span class="source-line-no">256</span><span id="line-256"></span> |
| <span class="source-line-no">257</span><span id="line-257"> public static void cleanupAndRestoreBackupSystem(Connection conn, BackupInfo backupInfo,</span> |
| <span class="source-line-no">258</span><span id="line-258"> Configuration conf) throws IOException {</span> |
| <span class="source-line-no">259</span><span id="line-259"> BackupType type = backupInfo.getType();</span> |
| <span class="source-line-no">260</span><span id="line-260"> // if full backup, then delete HBase snapshots if there already are snapshots taken</span> |
| <span class="source-line-no">261</span><span id="line-261"> // and also clean up export snapshot log files if exist</span> |
| <span class="source-line-no">262</span><span id="line-262"> if (type == BackupType.FULL) {</span> |
| <span class="source-line-no">263</span><span id="line-263"> deleteSnapshots(conn, backupInfo, conf);</span> |
| <span class="source-line-no">264</span><span id="line-264"> cleanupExportSnapshotLog(conf);</span> |
| <span class="source-line-no">265</span><span id="line-265"> }</span> |
| <span class="source-line-no">266</span><span id="line-266"> BackupSystemTable.restoreFromSnapshot(conn);</span> |
| <span class="source-line-no">267</span><span id="line-267"> BackupSystemTable.deleteSnapshot(conn);</span> |
| <span class="source-line-no">268</span><span id="line-268"> // clean up the uncompleted data at target directory if the ongoing backup has already entered</span> |
| <span class="source-line-no">269</span><span id="line-269"> // the copy phase</span> |
| <span class="source-line-no">270</span><span id="line-270"> // For incremental backup, DistCp logs will be cleaned with the targetDir.</span> |
| <span class="source-line-no">271</span><span id="line-271"> cleanupTargetDir(backupInfo, conf);</span> |
| <span class="source-line-no">272</span><span id="line-272"> }</span> |
| <span class="source-line-no">273</span><span id="line-273"></span> |
| <span class="source-line-no">274</span><span id="line-274"> /**</span> |
| <span class="source-line-no">275</span><span id="line-275"> * Creates a manifest based on the provided info, and store it in the backup-specific directory.</span> |
| <span class="source-line-no">276</span><span id="line-276"> * @param backupInfo The current backup info</span> |
| <span class="source-line-no">277</span><span id="line-277"> * @throws IOException exception</span> |
| <span class="source-line-no">278</span><span id="line-278"> */</span> |
| <span class="source-line-no">279</span><span id="line-279"> protected void addManifest(BackupInfo backupInfo, BackupType type, Configuration conf)</span> |
| <span class="source-line-no">280</span><span id="line-280"> throws IOException {</span> |
| <span class="source-line-no">281</span><span id="line-281"> // set the overall backup phase : store manifest</span> |
| <span class="source-line-no">282</span><span id="line-282"> backupInfo.setPhase(BackupPhase.STORE_MANIFEST);</span> |
| <span class="source-line-no">283</span><span id="line-283"></span> |
| <span class="source-line-no">284</span><span id="line-284"> BackupManifest manifest = new BackupManifest(backupInfo);</span> |
| <span class="source-line-no">285</span><span id="line-285"> if (type == BackupType.INCREMENTAL) {</span> |
| <span class="source-line-no">286</span><span id="line-286"> // set the table region server start and end timestamps for incremental backup</span> |
| <span class="source-line-no">287</span><span id="line-287"> manifest.setIncrTimestampMap(backupInfo.getIncrTimestampMap());</span> |
| <span class="source-line-no">288</span><span id="line-288"> }</span> |
| <span class="source-line-no">289</span><span id="line-289"> List<BackupImage> ancestors = getAncestors(backupInfo);</span> |
| <span class="source-line-no">290</span><span id="line-290"> for (BackupImage image : ancestors) {</span> |
| <span class="source-line-no">291</span><span id="line-291"> manifest.addDependentImage(image);</span> |
| <span class="source-line-no">292</span><span id="line-292"> }</span> |
| <span class="source-line-no">293</span><span id="line-293"> manifest.store(conf);</span> |
| <span class="source-line-no">294</span><span id="line-294"> }</span> |
| <span class="source-line-no">295</span><span id="line-295"></span> |
| <span class="source-line-no">296</span><span id="line-296"> /**</span> |
| <span class="source-line-no">297</span><span id="line-297"> * Gets the direct ancestors of the currently being created backup.</span> |
| <span class="source-line-no">298</span><span id="line-298"> * @param backupInfo The backup info for the backup being created</span> |
| <span class="source-line-no">299</span><span id="line-299"> */</span> |
| <span class="source-line-no">300</span><span id="line-300"> protected List<BackupImage> getAncestors(BackupInfo backupInfo) throws IOException {</span> |
| <span class="source-line-no">301</span><span id="line-301"> LOG.debug("Getting the direct ancestors of the current backup {}", backupInfo.getBackupId());</span> |
| <span class="source-line-no">302</span><span id="line-302"></span> |
| <span class="source-line-no">303</span><span id="line-303"> // Full backups do not have ancestors</span> |
| <span class="source-line-no">304</span><span id="line-304"> if (backupInfo.getType() == BackupType.FULL) {</span> |
| <span class="source-line-no">305</span><span id="line-305"> LOG.debug("Current backup is a full backup, no direct ancestor for it.");</span> |
| <span class="source-line-no">306</span><span id="line-306"> return Collections.emptyList();</span> |
| <span class="source-line-no">307</span><span id="line-307"> }</span> |
| <span class="source-line-no">308</span><span id="line-308"></span> |
| <span class="source-line-no">309</span><span id="line-309"> List<BackupImage> ancestors = new ArrayList<>();</span> |
| <span class="source-line-no">310</span><span id="line-310"> Set<TableName> tablesToCover = new HashSet<>(backupInfo.getTables());</span> |
| <span class="source-line-no">311</span><span id="line-311"></span> |
| <span class="source-line-no">312</span><span id="line-312"> // Go over the backup history list from newest to oldest</span> |
| <span class="source-line-no">313</span><span id="line-313"> List<BackupInfo> allHistoryList = backupManager.getBackupHistory(true);</span> |
| <span class="source-line-no">314</span><span id="line-314"> for (BackupInfo backup : allHistoryList) {</span> |
| <span class="source-line-no">315</span><span id="line-315"> // If the image has a different rootDir, it cannot be an ancestor.</span> |
| <span class="source-line-no">316</span><span id="line-316"> if (!Objects.equals(backup.getBackupRootDir(), backupInfo.getBackupRootDir())) {</span> |
| <span class="source-line-no">317</span><span id="line-317"> continue;</span> |
| <span class="source-line-no">318</span><span id="line-318"> }</span> |
| <span class="source-line-no">319</span><span id="line-319"></span> |
| <span class="source-line-no">320</span><span id="line-320"> BackupImage.Builder builder = BackupImage.newBuilder();</span> |
| <span class="source-line-no">321</span><span id="line-321"> BackupImage image = builder.withBackupId(backup.getBackupId()).withType(backup.getType())</span> |
| <span class="source-line-no">322</span><span id="line-322"> .withRootDir(backup.getBackupRootDir()).withTableList(backup.getTableNames())</span> |
| <span class="source-line-no">323</span><span id="line-323"> .withStartTime(backup.getStartTs()).withCompleteTime(backup.getCompleteTs()).build();</span> |
| <span class="source-line-no">324</span><span id="line-324"></span> |
| <span class="source-line-no">325</span><span id="line-325"> // The ancestors consist of the most recent FULL backups that cover the list of tables</span> |
| <span class="source-line-no">326</span><span id="line-326"> // required in the new backup and all INCREMENTAL backups that came after one of those FULL</span> |
| <span class="source-line-no">327</span><span id="line-327"> // backups.</span> |
| <span class="source-line-no">328</span><span id="line-328"> if (backup.getType().equals(BackupType.INCREMENTAL)) {</span> |
| <span class="source-line-no">329</span><span id="line-329"> ancestors.add(image);</span> |
| <span class="source-line-no">330</span><span id="line-330"> LOG.debug("Dependent incremental backup image: {BackupID={}}", image.getBackupId());</span> |
| <span class="source-line-no">331</span><span id="line-331"> } else {</span> |
| <span class="source-line-no">332</span><span id="line-332"> if (tablesToCover.removeAll(new HashSet<>(image.getTableNames()))) {</span> |
| <span class="source-line-no">333</span><span id="line-333"> ancestors.add(image);</span> |
| <span class="source-line-no">334</span><span id="line-334"> LOG.debug("Dependent full backup image: {BackupID={}}", image.getBackupId());</span> |
| <span class="source-line-no">335</span><span id="line-335"></span> |
| <span class="source-line-no">336</span><span id="line-336"> if (tablesToCover.isEmpty()) {</span> |
| <span class="source-line-no">337</span><span id="line-337"> LOG.debug("Got {} ancestors for the current backup.", ancestors.size());</span> |
| <span class="source-line-no">338</span><span id="line-338"> return Collections.unmodifiableList(ancestors);</span> |
| <span class="source-line-no">339</span><span id="line-339"> }</span> |
| <span class="source-line-no">340</span><span id="line-340"> }</span> |
| <span class="source-line-no">341</span><span id="line-341"> }</span> |
| <span class="source-line-no">342</span><span id="line-342"> }</span> |
| <span class="source-line-no">343</span><span id="line-343"></span> |
| <span class="source-line-no">344</span><span id="line-344"> throw new IllegalStateException(</span> |
| <span class="source-line-no">345</span><span id="line-345"> "Unable to find full backup that contains tables: " + tablesToCover);</span> |
| <span class="source-line-no">346</span><span id="line-346"> }</span> |
| <span class="source-line-no">347</span><span id="line-347"></span> |
| <span class="source-line-no">348</span><span id="line-348"> /**</span> |
| <span class="source-line-no">349</span><span id="line-349"> * Get backup request meta data dir as string.</span> |
| <span class="source-line-no">350</span><span id="line-350"> * @param backupInfo backup info</span> |
| <span class="source-line-no">351</span><span id="line-351"> * @return meta data dir</span> |
| <span class="source-line-no">352</span><span id="line-352"> */</span> |
| <span class="source-line-no">353</span><span id="line-353"> protected String obtainBackupMetaDataStr(BackupInfo backupInfo) {</span> |
| <span class="source-line-no">354</span><span id="line-354"> StringBuilder sb = new StringBuilder();</span> |
| <span class="source-line-no">355</span><span id="line-355"> sb.append("type=" + backupInfo.getType() + ",tablelist=");</span> |
| <span class="source-line-no">356</span><span id="line-356"> for (TableName table : backupInfo.getTables()) {</span> |
| <span class="source-line-no">357</span><span id="line-357"> sb.append(table + ";");</span> |
| <span class="source-line-no">358</span><span id="line-358"> }</span> |
| <span class="source-line-no">359</span><span id="line-359"> if (sb.lastIndexOf(";") > 0) {</span> |
| <span class="source-line-no">360</span><span id="line-360"> sb.delete(sb.lastIndexOf(";"), sb.lastIndexOf(";") + 1);</span> |
| <span class="source-line-no">361</span><span id="line-361"> }</span> |
| <span class="source-line-no">362</span><span id="line-362"> sb.append(",targetRootDir=" + backupInfo.getBackupRootDir());</span> |
| <span class="source-line-no">363</span><span id="line-363"></span> |
| <span class="source-line-no">364</span><span id="line-364"> return sb.toString();</span> |
| <span class="source-line-no">365</span><span id="line-365"> }</span> |
| <span class="source-line-no">366</span><span id="line-366"></span> |
| <span class="source-line-no">367</span><span id="line-367"> /**</span> |
| <span class="source-line-no">368</span><span id="line-368"> * Complete the overall backup.</span> |
| <span class="source-line-no">369</span><span id="line-369"> * @param backupInfo backup info</span> |
| <span class="source-line-no">370</span><span id="line-370"> * @throws IOException exception</span> |
| <span class="source-line-no">371</span><span id="line-371"> */</span> |
| <span class="source-line-no">372</span><span id="line-372"> protected void completeBackup(final Connection conn, BackupInfo backupInfo, BackupType type,</span> |
| <span class="source-line-no">373</span><span id="line-373"> Configuration conf) throws IOException {</span> |
| <span class="source-line-no">374</span><span id="line-374"> // set the complete timestamp of the overall backup</span> |
| <span class="source-line-no">375</span><span id="line-375"> backupInfo.setCompleteTs(EnvironmentEdgeManager.currentTime());</span> |
| <span class="source-line-no">376</span><span id="line-376"> // set overall backup status: complete</span> |
| <span class="source-line-no">377</span><span id="line-377"> backupInfo.setState(BackupState.COMPLETE);</span> |
| <span class="source-line-no">378</span><span id="line-378"> backupInfo.setProgress(100);</span> |
| <span class="source-line-no">379</span><span id="line-379"> // add and store the manifest for the backup</span> |
| <span class="source-line-no">380</span><span id="line-380"> addManifest(backupInfo, type, conf);</span> |
| <span class="source-line-no">381</span><span id="line-381"></span> |
| <span class="source-line-no">382</span><span id="line-382"> // compose the backup complete data</span> |
| <span class="source-line-no">383</span><span id="line-383"> String backupCompleteData =</span> |
| <span class="source-line-no">384</span><span id="line-384"> obtainBackupMetaDataStr(backupInfo) + ",startts=" + backupInfo.getStartTs() + ",completets="</span> |
| <span class="source-line-no">385</span><span id="line-385"> + backupInfo.getCompleteTs() + ",bytescopied=" + backupInfo.getTotalBytesCopied();</span> |
| <span class="source-line-no">386</span><span id="line-386"> if (LOG.isDebugEnabled()) {</span> |
| <span class="source-line-no">387</span><span id="line-387"> LOG.debug("Backup " + backupInfo.getBackupId() + " finished: " + backupCompleteData);</span> |
| <span class="source-line-no">388</span><span id="line-388"> }</span> |
| <span class="source-line-no">389</span><span id="line-389"></span> |
| <span class="source-line-no">390</span><span id="line-390"> // when full backup is done:</span> |
| <span class="source-line-no">391</span><span id="line-391"> // - delete HBase snapshot</span> |
| <span class="source-line-no">392</span><span id="line-392"> // - clean up directories with prefix "exportSnapshot-", which are generated when exporting</span> |
| <span class="source-line-no">393</span><span id="line-393"> // snapshots</span> |
| <span class="source-line-no">394</span><span id="line-394"> // incremental backups use distcp, which handles cleaning up its own directories</span> |
| <span class="source-line-no">395</span><span id="line-395"> if (type == BackupType.FULL) {</span> |
| <span class="source-line-no">396</span><span id="line-396"> deleteSnapshots(conn, backupInfo, conf);</span> |
| <span class="source-line-no">397</span><span id="line-397"> cleanupExportSnapshotLog(conf);</span> |
| <span class="source-line-no">398</span><span id="line-398"> }</span> |
| <span class="source-line-no">399</span><span id="line-399"> BackupSystemTable.deleteSnapshot(conn);</span> |
| <span class="source-line-no">400</span><span id="line-400"> backupManager.updateBackupInfo(backupInfo);</span> |
| <span class="source-line-no">401</span><span id="line-401"></span> |
| <span class="source-line-no">402</span><span id="line-402"> // Finish active session</span> |
| <span class="source-line-no">403</span><span id="line-403"> backupManager.finishBackupSession();</span> |
| <span class="source-line-no">404</span><span id="line-404"></span> |
| <span class="source-line-no">405</span><span id="line-405"> LOG.info("Backup " + backupInfo.getBackupId() + " completed.");</span> |
| <span class="source-line-no">406</span><span id="line-406"> }</span> |
| <span class="source-line-no">407</span><span id="line-407"></span> |
| <span class="source-line-no">408</span><span id="line-408"> /**</span> |
| <span class="source-line-no">409</span><span id="line-409"> * Backup request execution.</span> |
| <span class="source-line-no">410</span><span id="line-410"> * @throws IOException if the execution of the backup fails</span> |
| <span class="source-line-no">411</span><span id="line-411"> */</span> |
| <span class="source-line-no">412</span><span id="line-412"> public abstract void execute() throws IOException;</span> |
| <span class="source-line-no">413</span><span id="line-413"></span> |
| <span class="source-line-no">414</span><span id="line-414"> protected Stage getTestStage() {</span> |
| <span class="source-line-no">415</span><span id="line-415"> return Stage.valueOf("stage_" + conf.getInt(BACKUP_TEST_MODE_STAGE, 0));</span> |
| <span class="source-line-no">416</span><span id="line-416"> }</span> |
| <span class="source-line-no">417</span><span id="line-417"></span> |
| <span class="source-line-no">418</span><span id="line-418"> protected void failStageIf(Stage stage) throws IOException {</span> |
| <span class="source-line-no">419</span><span id="line-419"> Stage current = getTestStage();</span> |
| <span class="source-line-no">420</span><span id="line-420"> if (current == stage) {</span> |
| <span class="source-line-no">421</span><span id="line-421"> throw new IOException("Failed stage " + stage + " in testing");</span> |
| <span class="source-line-no">422</span><span id="line-422"> }</span> |
| <span class="source-line-no">423</span><span id="line-423"> }</span> |
| <span class="source-line-no">424</span><span id="line-424"></span> |
| <span class="source-line-no">425</span><span id="line-425"> public enum Stage {</span> |
| <span class="source-line-no">426</span><span id="line-426"> stage_0,</span> |
| <span class="source-line-no">427</span><span id="line-427"> stage_1,</span> |
| <span class="source-line-no">428</span><span id="line-428"> stage_2,</span> |
| <span class="source-line-no">429</span><span id="line-429"> stage_3,</span> |
| <span class="source-line-no">430</span><span id="line-430"> stage_4</span> |
| <span class="source-line-no">431</span><span id="line-431"> }</span> |
| <span class="source-line-no">432</span><span id="line-432">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
