Google Git
Sign in
apache / hbase-site / 8ac68d4b7a8449d1b079203ac526389e2358d31e / . / devapidocs / src-html / org / apache / hadoop / hbase / util / ServerCommandLine.html
blob: 5709c26ba210cb640ddf77e25602b8f7beb3570b [file] [log] [blame]
<!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> *<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a>
<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a>
<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a>
<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a>
<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a>
<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a>
<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a>
<span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.util;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.lang.management.ManagementFactory;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.management.RuntimeMXBean;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Arrays;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.HashSet;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Locale;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Map.Entry;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Set;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.HConstants;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.conf.Configuration;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.conf.Configured;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.HBaseConfiguration;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.util.Tool;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.util.ToolRunner;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.slf4j.Logger;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.slf4j.LoggerFactory;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>/**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Base class for command lines that start up various HBase daemons.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>@InterfaceAudience.Private<a name="line.43"></a>
<span class="sourceLineNo">044</span>public abstract class ServerCommandLine extends Configured implements Tool {<a name="line.44"></a>
<span class="sourceLineNo">045</span> private static final Logger LOG = LoggerFactory.getLogger(ServerCommandLine.class);<a name="line.45"></a>
<span class="sourceLineNo">046</span> @SuppressWarnings("serial")<a name="line.46"></a>
<span class="sourceLineNo">047</span> private static final Set&lt;String&gt; DEFAULT_SKIP_WORDS = new HashSet&lt;String&gt;() {<a name="line.47"></a>
<span class="sourceLineNo">048</span> {<a name="line.48"></a>
<span class="sourceLineNo">049</span> add("secret");<a name="line.49"></a>
<span class="sourceLineNo">050</span> add("passwd");<a name="line.50"></a>
<span class="sourceLineNo">051</span> add("password");<a name="line.51"></a>
<span class="sourceLineNo">052</span> add("credential");<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span> };<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Implementing subclasses should return a usage string to print out.<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> protected abstract String getUsage();<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Print usage information for this command line.<a name="line.62"></a>
<span class="sourceLineNo">063</span> *<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param message if not null, print this message before the usage info.<a name="line.64"></a>
<span class="sourceLineNo">065</span> */<a name="line.65"></a>
<span class="sourceLineNo">066</span> protected void usage(String message) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> if (message != null) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> System.err.println(message);<a name="line.68"></a>
<span class="sourceLineNo">069</span> System.err.println("");<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> System.err.println(getUsage());<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * Log information about the currently running JVM.<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> public static void logJVMInfo() {<a name="line.78"></a>
<span class="sourceLineNo">079</span> // Print out vm stats before starting up.<a name="line.79"></a>
<span class="sourceLineNo">080</span> RuntimeMXBean runtime = ManagementFactory.getRuntimeMXBean();<a name="line.80"></a>
<span class="sourceLineNo">081</span> if (runtime != null) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> LOG.info("vmName=" + runtime.getVmName() + ", vmVendor=" +<a name="line.82"></a>
<span class="sourceLineNo">083</span> runtime.getVmVendor() + ", vmVersion=" + runtime.getVmVersion());<a name="line.83"></a>
<span class="sourceLineNo">084</span> LOG.info("vmInputArguments=" + runtime.getInputArguments());<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * Print into log some of the important hbase attributes.<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> private static void logHBaseConfigs(Configuration conf) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> final String [] keys = new String [] {<a name="line.92"></a>
<span class="sourceLineNo">093</span> // Expand this list as you see fit.<a name="line.93"></a>
<span class="sourceLineNo">094</span> "hbase.tmp.dir",<a name="line.94"></a>
<span class="sourceLineNo">095</span> HConstants.HBASE_DIR,<a name="line.95"></a>
<span class="sourceLineNo">096</span> HConstants.CLUSTER_DISTRIBUTED,<a name="line.96"></a>
<span class="sourceLineNo">097</span> HConstants.ZOOKEEPER_QUORUM,<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> for (String key: keys) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> LOG.info(key + ": " + conf.get(key));<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> /**<a name="line.105"></a>
<span class="sourceLineNo">106</span> * Logs information about the currently running JVM process including<a name="line.106"></a>
<span class="sourceLineNo">107</span> * the environment variables. Logging of env vars can be disabled by<a name="line.107"></a>
<span class="sourceLineNo">108</span> * setting {@code "hbase.envvars.logging.disabled"} to {@code "true"}.<a name="line.108"></a>
<span class="sourceLineNo">109</span> * &lt;p&gt;If enabled, you can also exclude environment variables containing<a name="line.109"></a>
<span class="sourceLineNo">110</span> * certain substrings by setting {@code "hbase.envvars.logging.skipwords"}<a name="line.110"></a>
<span class="sourceLineNo">111</span> * to comma separated list of such substrings.<a name="line.111"></a>
<span class="sourceLineNo">112</span> */<a name="line.112"></a>
<span class="sourceLineNo">113</span> public static void logProcessInfo(Configuration conf) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> logHBaseConfigs(conf);<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> // log environment variables unless asked not to<a name="line.116"></a>
<span class="sourceLineNo">117</span> if (conf == null || !conf.getBoolean("hbase.envvars.logging.disabled", false)) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> Set&lt;String&gt; skipWords = new HashSet&lt;&gt;(DEFAULT_SKIP_WORDS);<a name="line.118"></a>
<span class="sourceLineNo">119</span> if (conf != null) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> String[] confSkipWords = conf.getStrings("hbase.envvars.logging.skipwords");<a name="line.120"></a>
<span class="sourceLineNo">121</span> if (confSkipWords != null) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> skipWords.addAll(Arrays.asList(confSkipWords));<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> nextEnv:<a name="line.126"></a>
<span class="sourceLineNo">127</span> for (Entry&lt;String, String&gt; entry : System.getenv().entrySet()) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> String key = entry.getKey().toLowerCase(Locale.ROOT);<a name="line.128"></a>
<span class="sourceLineNo">129</span> String value = entry.getValue().toLowerCase(Locale.ROOT);<a name="line.129"></a>
<span class="sourceLineNo">130</span> // exclude variables which may contain skip words<a name="line.130"></a>
<span class="sourceLineNo">131</span> for(String skipWord : skipWords) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> if (key.contains(skipWord) || value.contains(skipWord))<a name="line.132"></a>
<span class="sourceLineNo">133</span> continue nextEnv;<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span> LOG.info("env:"+entry);<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> // and JVM info<a name="line.139"></a>
<span class="sourceLineNo">140</span> logJVMInfo();<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> /**<a name="line.143"></a>
<span class="sourceLineNo">144</span> * Parse and run the given command line. This may exit the JVM if<a name="line.144"></a>
<span class="sourceLineNo">145</span> * a nonzero exit code is returned from &lt;code&gt;run()&lt;/code&gt;.<a name="line.145"></a>
<span class="sourceLineNo">146</span> */<a name="line.146"></a>
<span class="sourceLineNo">147</span> public void doMain(String args[]) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> try {<a name="line.148"></a>
<span class="sourceLineNo">149</span> int ret = ToolRunner.run(HBaseConfiguration.create(), this, args);<a name="line.149"></a>
<span class="sourceLineNo">150</span> if (ret != 0) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> System.exit(ret);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> } catch (Exception e) {<a name="line.153"></a>
<span class="sourceLineNo">154</span> LOG.error("Failed to run", e);<a name="line.154"></a>
<span class="sourceLineNo">155</span> System.exit(-1);<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span>}<a name="line.158"></a>
</pre>
</div>
</body>
</html>