| <!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.util, class: ServerCommandLine"> |
| <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.util;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import static org.apache.hadoop.hbase.util.Threads.isNonDaemonThreadRunning;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">import java.lang.management.ManagementFactory;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.lang.management.RuntimeMXBean;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.Arrays;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.HashSet;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.Locale;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.util.Map.Entry;</span> |
| <span class="source-line-no">028</span><span id="line-28">import java.util.Set;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.conf.Configured;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.HBaseConfiguration;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.util.Tool;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.util.ToolRunner;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.slf4j.Logger;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableSet;</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41">/**</span> |
| <span class="source-line-no">042</span><span id="line-42"> * Base class for command lines that start up various HBase daemons.</span> |
| <span class="source-line-no">043</span><span id="line-43"> */</span> |
| <span class="source-line-no">044</span><span id="line-44">@InterfaceAudience.Private</span> |
| <span class="source-line-no">045</span><span id="line-45">public abstract class ServerCommandLine extends Configured implements Tool {</span> |
| <span class="source-line-no">046</span><span id="line-46"> private static final Logger LOG = LoggerFactory.getLogger(ServerCommandLine.class);</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> private static final Set<String> DEFAULT_SKIP_WORDS =</span> |
| <span class="source-line-no">049</span><span id="line-49"> ImmutableSet.of("secret", "passwd", "password", "credential");</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> /**</span> |
| <span class="source-line-no">052</span><span id="line-52"> * Implementing subclasses should return a usage string to print out.</span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54"> protected abstract String getUsage();</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> /**</span> |
| <span class="source-line-no">057</span><span id="line-57"> * Print usage information for this command line.</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @param message if not null, print this message before the usage info.</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> protected void usage(String message) {</span> |
| <span class="source-line-no">061</span><span id="line-61"> if (message != null) {</span> |
| <span class="source-line-no">062</span><span id="line-62"> System.err.println(message);</span> |
| <span class="source-line-no">063</span><span id="line-63"> System.err.println("");</span> |
| <span class="source-line-no">064</span><span id="line-64"> }</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> System.err.println(getUsage());</span> |
| <span class="source-line-no">067</span><span id="line-67"> }</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> /**</span> |
| <span class="source-line-no">070</span><span id="line-70"> * Log information about the currently running JVM.</span> |
| <span class="source-line-no">071</span><span id="line-71"> */</span> |
| <span class="source-line-no">072</span><span id="line-72"> public static void logJVMInfo() {</span> |
| <span class="source-line-no">073</span><span id="line-73"> // Print out vm stats before starting up.</span> |
| <span class="source-line-no">074</span><span id="line-74"> RuntimeMXBean runtime = ManagementFactory.getRuntimeMXBean();</span> |
| <span class="source-line-no">075</span><span id="line-75"> if (runtime != null) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> LOG.info("vmName=" + runtime.getVmName() + ", vmVendor=" + runtime.getVmVendor()</span> |
| <span class="source-line-no">077</span><span id="line-77"> + ", vmVersion=" + runtime.getVmVersion());</span> |
| <span class="source-line-no">078</span><span id="line-78"> LOG.info("vmInputArguments=" + runtime.getInputArguments());</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"></span> |
| <span class="source-line-no">082</span><span id="line-82"> /**</span> |
| <span class="source-line-no">083</span><span id="line-83"> * Print into log some of the important hbase attributes.</span> |
| <span class="source-line-no">084</span><span id="line-84"> */</span> |
| <span class="source-line-no">085</span><span id="line-85"> private static void logHBaseConfigs(Configuration conf) {</span> |
| <span class="source-line-no">086</span><span id="line-86"> final String[] keys = new String[] {</span> |
| <span class="source-line-no">087</span><span id="line-87"> // Expand this list as you see fit.</span> |
| <span class="source-line-no">088</span><span id="line-88"> "hbase.tmp.dir", HConstants.HBASE_DIR, HConstants.CLUSTER_DISTRIBUTED,</span> |
| <span class="source-line-no">089</span><span id="line-89"> HConstants.ZOOKEEPER_QUORUM,</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> };</span> |
| <span class="source-line-no">092</span><span id="line-92"> for (String key : keys) {</span> |
| <span class="source-line-no">093</span><span id="line-93"> LOG.info(key + ": " + conf.get(key));</span> |
| <span class="source-line-no">094</span><span id="line-94"> }</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> /**</span> |
| <span class="source-line-no">098</span><span id="line-98"> * Logs information about the currently running JVM process including the environment variables.</span> |
| <span class="source-line-no">099</span><span id="line-99"> * Logging of env vars can be disabled by setting {@code "hbase.envvars.logging.disabled"} to</span> |
| <span class="source-line-no">100</span><span id="line-100"> * {@code "true"}.</span> |
| <span class="source-line-no">101</span><span id="line-101"> * <p></span> |
| <span class="source-line-no">102</span><span id="line-102"> * If enabled, you can also exclude environment variables containing certain substrings by setting</span> |
| <span class="source-line-no">103</span><span id="line-103"> * {@code "hbase.envvars.logging.skipwords"} to comma separated list of such substrings.</span> |
| <span class="source-line-no">104</span><span id="line-104"> */</span> |
| <span class="source-line-no">105</span><span id="line-105"> public static void logProcessInfo(Configuration conf) {</span> |
| <span class="source-line-no">106</span><span id="line-106"> logHBaseConfigs(conf);</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> // log environment variables unless asked not to</span> |
| <span class="source-line-no">109</span><span id="line-109"> if (conf == null || !conf.getBoolean("hbase.envvars.logging.disabled", false)) {</span> |
| <span class="source-line-no">110</span><span id="line-110"> Set<String> skipWords = new HashSet<>(DEFAULT_SKIP_WORDS);</span> |
| <span class="source-line-no">111</span><span id="line-111"> if (conf != null) {</span> |
| <span class="source-line-no">112</span><span id="line-112"> String[] confSkipWords = conf.getStrings("hbase.envvars.logging.skipwords");</span> |
| <span class="source-line-no">113</span><span id="line-113"> if (confSkipWords != null) {</span> |
| <span class="source-line-no">114</span><span id="line-114"> skipWords.addAll(Arrays.asList(confSkipWords));</span> |
| <span class="source-line-no">115</span><span id="line-115"> }</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"></span> |
| <span class="source-line-no">118</span><span id="line-118"> nextEnv: for (Entry<String, String> entry : System.getenv().entrySet()) {</span> |
| <span class="source-line-no">119</span><span id="line-119"> String key = entry.getKey().toLowerCase(Locale.ROOT);</span> |
| <span class="source-line-no">120</span><span id="line-120"> String value = entry.getValue().toLowerCase(Locale.ROOT);</span> |
| <span class="source-line-no">121</span><span id="line-121"> // exclude variables which may contain skip words</span> |
| <span class="source-line-no">122</span><span id="line-122"> for (String skipWord : skipWords) {</span> |
| <span class="source-line-no">123</span><span id="line-123"> if (key.contains(skipWord) || value.contains(skipWord)) continue nextEnv;</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</span> |
| <span class="source-line-no">125</span><span id="line-125"> LOG.info("env:" + entry);</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> // and JVM info</span> |
| <span class="source-line-no">130</span><span id="line-130"> logJVMInfo();</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> /**</span> |
| <span class="source-line-no">134</span><span id="line-134"> * Parse and run the given command line. This will exit the JVM with the exit code returned from</span> |
| <span class="source-line-no">135</span><span id="line-135"> * <code>run()</code>. If return code is 0, wait for atmost 30 seconds for all non-daemon threads</span> |
| <span class="source-line-no">136</span><span id="line-136"> * to quit, otherwise exit the jvm</span> |
| <span class="source-line-no">137</span><span id="line-137"> */</span> |
| <span class="source-line-no">138</span><span id="line-138"> public void doMain(String args[]) {</span> |
| <span class="source-line-no">139</span><span id="line-139"> try {</span> |
| <span class="source-line-no">140</span><span id="line-140"> int ret = ToolRunner.run(HBaseConfiguration.create(), this, args);</span> |
| <span class="source-line-no">141</span><span id="line-141"> if (ret != 0) {</span> |
| <span class="source-line-no">142</span><span id="line-142"> System.exit(ret);</span> |
| <span class="source-line-no">143</span><span id="line-143"> }</span> |
| <span class="source-line-no">144</span><span id="line-144"> // Return code is 0 here.</span> |
| <span class="source-line-no">145</span><span id="line-145"> boolean forceStop = false;</span> |
| <span class="source-line-no">146</span><span id="line-146"> long startTime = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">147</span><span id="line-147"> while (isNonDaemonThreadRunning()) {</span> |
| <span class="source-line-no">148</span><span id="line-148"> if (EnvironmentEdgeManager.currentTime() - startTime > 30 * 1000) {</span> |
| <span class="source-line-no">149</span><span id="line-149"> forceStop = true;</span> |
| <span class="source-line-no">150</span><span id="line-150"> break;</span> |
| <span class="source-line-no">151</span><span id="line-151"> }</span> |
| <span class="source-line-no">152</span><span id="line-152"> Thread.sleep(1000);</span> |
| <span class="source-line-no">153</span><span id="line-153"> }</span> |
| <span class="source-line-no">154</span><span id="line-154"> if (forceStop) {</span> |
| <span class="source-line-no">155</span><span id="line-155"> LOG.error("Failed to stop all non-daemon threads, so terminating JVM");</span> |
| <span class="source-line-no">156</span><span id="line-156"> System.exit(-1);</span> |
| <span class="source-line-no">157</span><span id="line-157"> }</span> |
| <span class="source-line-no">158</span><span id="line-158"> } catch (Exception e) {</span> |
| <span class="source-line-no">159</span><span id="line-159"> LOG.error("Failed to run", e);</span> |
| <span class="source-line-no">160</span><span id="line-160"> System.exit(-1);</span> |
| <span class="source-line-no">161</span><span id="line-161"> }</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
