| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.backup.impl;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.HashMap;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.conf.Configuration;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.fs.FileStatus;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.fs.FileSystem;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.fs.Path;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.TableName;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.backup.BackupInfo;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.backup.BackupInfo.BackupPhase;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.backup.BackupInfo.BackupState;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.backup.BackupRequest;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.backup.BackupRestoreConstants;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.backup.BackupType;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.backup.HBackupFileSystem;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.backup.impl.BackupManifest.BackupImage;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.util.CommonFSUtils;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.slf4j.Logger;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.slf4j.LoggerFactory;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span>/**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Base class for backup operation. Concrete implementation for full and incremental backup are<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * delegated to corresponding sub-classes: {@link FullTableBackupClient} and<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * {@link IncrementalTableBackupClient}<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>@InterfaceAudience.Private<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>public abstract class TableBackupClient {<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public static final String BACKUP_CLIENT_IMPL_CLASS = "backup.client.impl.class";<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public static final String BACKUP_TEST_MODE_STAGE = "backup.test.mode.stage";<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private static final Logger LOG = LoggerFactory.getLogger(TableBackupClient.class);<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> protected Configuration conf;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> protected Connection conn;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> protected String backupId;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> protected List<TableName> tableList;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> protected Map<String, Long> newTimestamps = null;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> protected BackupManager backupManager;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> protected BackupInfo backupInfo;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> protected FileSystem fs;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> public TableBackupClient() {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> }<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> public TableBackupClient(final Connection conn, final String backupId, BackupRequest request)<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> throws IOException {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> init(conn, backupId, request);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public void init(final Connection conn, final String backupId, BackupRequest request)<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> throws IOException {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> if (request.getBackupType() == BackupType.FULL) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> backupManager = new BackupManager(conn, conn.getConfiguration());<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> } else {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> backupManager = new IncrementalBackupManager(conn, conn.getConfiguration());<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> this.backupId = backupId;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> this.tableList = request.getTableList();<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> this.conn = conn;<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> this.conf = conn.getConfiguration();<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> this.fs = CommonFSUtils.getCurrentFileSystem(conf);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> backupInfo = backupManager.createBackupInfo(backupId, request.getBackupType(), tableList,<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> request.getTargetRootDir(), request.getTotalTasks(), request.getBandwidth());<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> if (tableList == null || tableList.isEmpty()) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> this.tableList = new ArrayList<>(backupInfo.getTables());<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> // Start new session<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> backupManager.startBackupSession();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> /**<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Begin the overall backup.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param backupInfo backup info<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @throws IOException exception<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> protected void beginBackup(BackupManager backupManager, BackupInfo backupInfo)<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> throws IOException {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> BackupSystemTable.snapshot(conn);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> backupManager.setBackupInfo(backupInfo);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> // set the start timestamp of the overall backup<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> long startTs = EnvironmentEdgeManager.currentTime();<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> backupInfo.setStartTs(startTs);<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> // set overall backup status: ongoing<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> backupInfo.setState(BackupState.RUNNING);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> backupInfo.setPhase(BackupPhase.REQUEST);<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> LOG.info("Backup " + backupInfo.getBackupId() + " started at " + startTs + ".");<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> backupManager.updateBackupInfo(backupInfo);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> if (LOG.isDebugEnabled()) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> LOG.debug("Backup session " + backupInfo.getBackupId() + " has been started.");<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> protected String getMessage(Exception e) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> String msg = e.getMessage();<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> if (msg == null || msg.equals("")) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> msg = e.getClass().getName();<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> }<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> return msg;<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> }<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> /**<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * Delete HBase snapshot for backup.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param backupInfo backup info<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @throws IOException exception<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> protected static void deleteSnapshots(final Connection conn, BackupInfo backupInfo,<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> Configuration conf) throws IOException {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> LOG.debug("Trying to delete snapshot for full backup.");<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> for (String snapshotName : backupInfo.getSnapshotNames()) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> if (snapshotName == null) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> continue;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> LOG.debug("Trying to delete snapshot: " + snapshotName);<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> try (Admin admin = conn.getAdmin()) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> admin.deleteSnapshot(snapshotName);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> LOG.debug("Deleting the snapshot " + snapshotName + " for backup " + backupInfo.getBackupId()<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> + " succeeded.");<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> /**<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * Clean up directories with prefix "exportSnapshot-", which are generated when exporting<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * snapshots.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @throws IOException exception<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> protected static void cleanupExportSnapshotLog(Configuration conf) throws IOException {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> FileSystem fs = CommonFSUtils.getCurrentFileSystem(conf);<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> Path stagingDir = new Path(<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> conf.get(BackupRestoreConstants.CONF_STAGING_ROOT, fs.getWorkingDirectory().toString()));<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> FileStatus[] files = CommonFSUtils.listStatus(fs, stagingDir);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> if (files == null) {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> for (FileStatus file : files) {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> if (file.getPath().getName().startsWith("exportSnapshot-")) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> LOG.debug("Delete log files of exporting snapshot: " + file.getPath().getName());<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> if (CommonFSUtils.delete(fs, file.getPath(), true) == false) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> LOG.warn("Can not delete " + file.getPath());<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> /**<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * Clean up the uncompleted data at target directory if the ongoing backup has already entered the<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * copy phase.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> */<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> protected static void cleanupTargetDir(BackupInfo backupInfo, Configuration conf) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> try {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> // clean up the uncompleted data at target directory if the ongoing backup has already entered<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> // the copy phase<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> LOG.debug("Trying to cleanup up target dir. Current backup phase: " + backupInfo.getPhase());<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> if (<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> backupInfo.getPhase().equals(BackupPhase.SNAPSHOTCOPY)<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> || backupInfo.getPhase().equals(BackupPhase.INCREMENTAL_COPY)<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> || backupInfo.getPhase().equals(BackupPhase.STORE_MANIFEST)<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> ) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> FileSystem outputFs = FileSystem.get(new Path(backupInfo.getBackupRootDir()).toUri(), conf);<a name="line.190"></a> |
| <span class="sourceLineNo">191</span><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> // now treat one backup as a transaction, clean up data that has been partially copied at<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> // table level<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> for (TableName table : backupInfo.getTables()) {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> Path targetDirPath = new Path(HBackupFileSystem<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> .getTableBackupDir(backupInfo.getBackupRootDir(), backupInfo.getBackupId(), table));<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> if (outputFs.delete(targetDirPath, true)) {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> LOG.debug(<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> "Cleaning up uncompleted backup data at " + targetDirPath.toString() + " done.");<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> } else {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> LOG.debug("No data has been copied to " + targetDirPath.toString() + ".");<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> }<a name="line.202"></a> |
| <span class="sourceLineNo">203</span><a name="line.203"></a> |
| <span class="sourceLineNo">204</span> Path tableDir = targetDirPath.getParent();<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> FileStatus[] backups = CommonFSUtils.listStatus(outputFs, tableDir);<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> if (backups == null || backups.length == 0) {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> outputFs.delete(tableDir, true);<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> LOG.debug(tableDir.toString() + " is empty, remove it.");<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> }<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span><a name="line.212"></a> |
| <span class="sourceLineNo">213</span> } catch (IOException e1) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> LOG.error("Cleaning up uncompleted backup data of " + backupInfo.getBackupId() + " at "<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> + backupInfo.getBackupRootDir() + " failed due to " + e1.getMessage() + ".");<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> }<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> /**<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * Fail the overall backup.<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * @param backupInfo backup info<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * @param e exception<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @throws IOException exception<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> */<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> protected void failBackup(Connection conn, BackupInfo backupInfo, BackupManager backupManager,<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> Exception e, String msg, BackupType type, Configuration conf) throws IOException {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> try {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> LOG.error(msg + getMessage(e), e);<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> // If this is a cancel exception, then we've already cleaned.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> // set the failure timestamp of the overall backup<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> backupInfo.setCompleteTs(EnvironmentEdgeManager.currentTime());<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> // set failure message<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> backupInfo.setFailedMsg(e.getMessage());<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> // set overall backup status: failed<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> backupInfo.setState(BackupState.FAILED);<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> // compose the backup failed data<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> String backupFailedData = "BackupId=" + backupInfo.getBackupId() + ",startts="<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> + backupInfo.getStartTs() + ",failedts=" + backupInfo.getCompleteTs() + ",failedphase="<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> + backupInfo.getPhase() + ",failedmessage=" + backupInfo.getFailedMsg();<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> LOG.error(backupFailedData);<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> cleanupAndRestoreBackupSystem(conn, backupInfo, conf);<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> // If backup session is updated to FAILED state - means we<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> // processed recovery already.<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> backupManager.updateBackupInfo(backupInfo);<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> backupManager.finishBackupSession();<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> LOG.error("Backup " + backupInfo.getBackupId() + " failed.");<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> } catch (IOException ee) {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> LOG.error("Please run backup repair tool manually to restore backup system integrity");<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> throw ee;<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> public static void cleanupAndRestoreBackupSystem(Connection conn, BackupInfo backupInfo,<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> Configuration conf) throws IOException {<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> BackupType type = backupInfo.getType();<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> // if full backup, then delete HBase snapshots if there already are snapshots taken<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> // and also clean up export snapshot log files if exist<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> if (type == BackupType.FULL) {<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> deleteSnapshots(conn, backupInfo, conf);<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> cleanupExportSnapshotLog(conf);<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> BackupSystemTable.restoreFromSnapshot(conn);<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> BackupSystemTable.deleteSnapshot(conn);<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> // clean up the uncompleted data at target directory if the ongoing backup has already entered<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> // the copy phase<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> // For incremental backup, DistCp logs will be cleaned with the targetDir.<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> cleanupTargetDir(backupInfo, conf);<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> /**<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * Add manifest for the current backup. The manifest is stored within the table backup directory.<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * @param backupInfo The current backup info<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * @throws IOException exception<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> */<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> protected void addManifest(BackupInfo backupInfo, BackupManager backupManager, BackupType type,<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> Configuration conf) throws IOException {<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> // set the overall backup phase : store manifest<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> backupInfo.setPhase(BackupPhase.STORE_MANIFEST);<a name="line.278"></a> |
| <span class="sourceLineNo">279</span><a name="line.279"></a> |
| <span class="sourceLineNo">280</span> BackupManifest manifest;<a name="line.280"></a> |
| <span class="sourceLineNo">281</span><a name="line.281"></a> |
| <span class="sourceLineNo">282</span> // Since we have each table's backup in its own directory structure,<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> // we'll store its manifest with the table directory.<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> for (TableName table : backupInfo.getTables()) {<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> manifest = new BackupManifest(backupInfo, table);<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> ArrayList<BackupImage> ancestors = backupManager.getAncestors(backupInfo, table);<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> for (BackupImage image : ancestors) {<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> manifest.addDependentImage(image);<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> }<a name="line.289"></a> |
| <span class="sourceLineNo">290</span><a name="line.290"></a> |
| <span class="sourceLineNo">291</span> if (type == BackupType.INCREMENTAL) {<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> // We'll store the log timestamps for this table only in its manifest.<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> Map<TableName, Map<String, Long>> tableTimestampMap = new HashMap<>();<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> tableTimestampMap.put(table, backupInfo.getIncrTimestampMap().get(table));<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> manifest.setIncrTimestampMap(tableTimestampMap);<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> ArrayList<BackupImage> ancestorss = backupManager.getAncestors(backupInfo);<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> for (BackupImage image : ancestorss) {<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> manifest.addDependentImage(image);<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> }<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> }<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> manifest.store(conf);<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> }<a name="line.302"></a> |
| <span class="sourceLineNo">303</span><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> // For incremental backup, we store a overall manifest in<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> // <backup-root-dir>/WALs/<backup-id><a name="line.305"></a> |
| <span class="sourceLineNo">306</span> // This is used when created the next incremental backup<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> if (type == BackupType.INCREMENTAL) {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> manifest = new BackupManifest(backupInfo);<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> // set the table region server start and end timestamps for incremental backup<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> manifest.setIncrTimestampMap(backupInfo.getIncrTimestampMap());<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> ArrayList<BackupImage> ancestors = backupManager.getAncestors(backupInfo);<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> for (BackupImage image : ancestors) {<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> manifest.addDependentImage(image);<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> }<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> manifest.store(conf);<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> }<a name="line.317"></a> |
| <span class="sourceLineNo">318</span><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> /**<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * Get backup request meta data dir as string.<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * @param backupInfo backup info<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * @return meta data dir<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> */<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> protected String obtainBackupMetaDataStr(BackupInfo backupInfo) {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> StringBuilder sb = new StringBuilder();<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> sb.append("type=" + backupInfo.getType() + ",tablelist=");<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> for (TableName table : backupInfo.getTables()) {<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> sb.append(table + ";");<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> if (sb.lastIndexOf(";") > 0) {<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> sb.delete(sb.lastIndexOf(";"), sb.lastIndexOf(";") + 1);<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> }<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> sb.append(",targetRootDir=" + backupInfo.getBackupRootDir());<a name="line.333"></a> |
| <span class="sourceLineNo">334</span><a name="line.334"></a> |
| <span class="sourceLineNo">335</span> return sb.toString();<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> }<a name="line.336"></a> |
| <span class="sourceLineNo">337</span><a name="line.337"></a> |
| <span class="sourceLineNo">338</span> /**<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * Complete the overall backup.<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * @param backupInfo backup info<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * @throws IOException exception<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> */<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> protected void completeBackup(final Connection conn, BackupInfo backupInfo,<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> BackupManager backupManager, BackupType type, Configuration conf) throws IOException {<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> // set the complete timestamp of the overall backup<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> backupInfo.setCompleteTs(EnvironmentEdgeManager.currentTime());<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> // set overall backup status: complete<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> backupInfo.setState(BackupState.COMPLETE);<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> backupInfo.setProgress(100);<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> // add and store the manifest for the backup<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> addManifest(backupInfo, backupManager, type, conf);<a name="line.351"></a> |
| <span class="sourceLineNo">352</span><a name="line.352"></a> |
| <span class="sourceLineNo">353</span> // compose the backup complete data<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> String backupCompleteData =<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> obtainBackupMetaDataStr(backupInfo) + ",startts=" + backupInfo.getStartTs() + ",completets="<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> + backupInfo.getCompleteTs() + ",bytescopied=" + backupInfo.getTotalBytesCopied();<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> if (LOG.isDebugEnabled()) {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> LOG.debug("Backup " + backupInfo.getBackupId() + " finished: " + backupCompleteData);<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> }<a name="line.359"></a> |
| <span class="sourceLineNo">360</span><a name="line.360"></a> |
| <span class="sourceLineNo">361</span> // when full backup is done:<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> // - delete HBase snapshot<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> // - clean up directories with prefix "exportSnapshot-", which are generated when exporting<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> // snapshots<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> // incremental backups use distcp, which handles cleaning up its own directories<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> if (type == BackupType.FULL) {<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> deleteSnapshots(conn, backupInfo, conf);<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> cleanupExportSnapshotLog(conf);<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> }<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> BackupSystemTable.deleteSnapshot(conn);<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> backupManager.updateBackupInfo(backupInfo);<a name="line.371"></a> |
| <span class="sourceLineNo">372</span><a name="line.372"></a> |
| <span class="sourceLineNo">373</span> // Finish active session<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> backupManager.finishBackupSession();<a name="line.374"></a> |
| <span class="sourceLineNo">375</span><a name="line.375"></a> |
| <span class="sourceLineNo">376</span> LOG.info("Backup " + backupInfo.getBackupId() + " completed.");<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> }<a name="line.377"></a> |
| <span class="sourceLineNo">378</span><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> /**<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * Backup request execution.<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * @throws IOException if the execution of the backup fails<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> */<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> public abstract void execute() throws IOException;<a name="line.383"></a> |
| <span class="sourceLineNo">384</span><a name="line.384"></a> |
| <span class="sourceLineNo">385</span> protected Stage getTestStage() {<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> return Stage.valueOf("stage_" + conf.getInt(BACKUP_TEST_MODE_STAGE, 0));<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> }<a name="line.387"></a> |
| <span class="sourceLineNo">388</span><a name="line.388"></a> |
| <span class="sourceLineNo">389</span> protected void failStageIf(Stage stage) throws IOException {<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> Stage current = getTestStage();<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> if (current == stage) {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> throw new IOException("Failed stage " + stage + " in testing");<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> }<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span><a name="line.395"></a> |
| <span class="sourceLineNo">396</span> public enum Stage {<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> stage_0,<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> stage_1,<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> stage_2,<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> stage_3,<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> stage_4<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span>}<a name="line.403"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
