| <!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, class: HealthChecker"> |
| <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;</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 org.apache.hadoop.util.Shell.ExitCodeException;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.util.Shell.ShellCommandExecutor;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.slf4j.Logger;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * A utility for executing an external script that checks the health of the node. An example script</span> |
| <span class="source-line-no">029</span><span id="line-29"> * can be found at <tt>src/main/sh/healthcheck/healthcheck.sh</tt> in the <tt>hbase-examples</tt></span> |
| <span class="source-line-no">030</span><span id="line-30"> * module.</span> |
| <span class="source-line-no">031</span><span id="line-31"> */</span> |
| <span class="source-line-no">032</span><span id="line-32">class HealthChecker {</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34"> private static final Logger LOG = LoggerFactory.getLogger(HealthChecker.class);</span> |
| <span class="source-line-no">035</span><span id="line-35"> private ShellCommandExecutor shexec = null;</span> |
| <span class="source-line-no">036</span><span id="line-36"> private String exceptionStackTrace;</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38"> /** Pattern used for searching in the output of the node health script */</span> |
| <span class="source-line-no">039</span><span id="line-39"> static private final String ERROR_PATTERN = "ERROR";</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41"> private String healthCheckScript;</span> |
| <span class="source-line-no">042</span><span id="line-42"> private long scriptTimeout;</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> enum HealthCheckerExitStatus {</span> |
| <span class="source-line-no">045</span><span id="line-45"> SUCCESS,</span> |
| <span class="source-line-no">046</span><span id="line-46"> TIMED_OUT,</span> |
| <span class="source-line-no">047</span><span id="line-47"> FAILED_WITH_EXIT_CODE,</span> |
| <span class="source-line-no">048</span><span id="line-48"> FAILED_WITH_EXCEPTION,</span> |
| <span class="source-line-no">049</span><span id="line-49"> FAILED</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"> /**</span> |
| <span class="source-line-no">053</span><span id="line-53"> * Initialize.</span> |
| <span class="source-line-no">054</span><span id="line-54"> * @param location the location of the health script</span> |
| <span class="source-line-no">055</span><span id="line-55"> * @param timeout the timeout to be used for the health script</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 void init(String location, long timeout) {</span> |
| <span class="source-line-no">058</span><span id="line-58"> this.healthCheckScript = location;</span> |
| <span class="source-line-no">059</span><span id="line-59"> this.scriptTimeout = timeout;</span> |
| <span class="source-line-no">060</span><span id="line-60"> ArrayList<String> execScript = new ArrayList<>();</span> |
| <span class="source-line-no">061</span><span id="line-61"> execScript.add(healthCheckScript);</span> |
| <span class="source-line-no">062</span><span id="line-62"> this.shexec = new ShellCommandExecutor(execScript.toArray(new String[execScript.size()]), null,</span> |
| <span class="source-line-no">063</span><span id="line-63"> null, scriptTimeout);</span> |
| <span class="source-line-no">064</span><span id="line-64"> LOG.info("HealthChecker initialized with script at " + this.healthCheckScript + ", timeout="</span> |
| <span class="source-line-no">065</span><span id="line-65"> + timeout);</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> public HealthReport checkHealth() {</span> |
| <span class="source-line-no">069</span><span id="line-69"> HealthCheckerExitStatus status = HealthCheckerExitStatus.SUCCESS;</span> |
| <span class="source-line-no">070</span><span id="line-70"> try {</span> |
| <span class="source-line-no">071</span><span id="line-71"> // Calling this execute leaves around running executor threads.</span> |
| <span class="source-line-no">072</span><span id="line-72"> shexec.execute();</span> |
| <span class="source-line-no">073</span><span id="line-73"> } catch (ExitCodeException e) {</span> |
| <span class="source-line-no">074</span><span id="line-74"> // ignore the exit code of the script</span> |
| <span class="source-line-no">075</span><span id="line-75"> LOG.warn("Caught exception : " + e + ",exit code:" + e.getExitCode());</span> |
| <span class="source-line-no">076</span><span id="line-76"> status = HealthCheckerExitStatus.FAILED_WITH_EXIT_CODE;</span> |
| <span class="source-line-no">077</span><span id="line-77"> } catch (IOException e) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> LOG.warn("Caught exception : " + e);</span> |
| <span class="source-line-no">079</span><span id="line-79"> status = HealthCheckerExitStatus.FAILED_WITH_EXCEPTION;</span> |
| <span class="source-line-no">080</span><span id="line-80"> exceptionStackTrace = org.apache.hadoop.util.StringUtils.stringifyException(e);</span> |
| <span class="source-line-no">081</span><span id="line-81"> } finally {</span> |
| <span class="source-line-no">082</span><span id="line-82"> if (shexec.isTimedOut()) {</span> |
| <span class="source-line-no">083</span><span id="line-83"> status = HealthCheckerExitStatus.TIMED_OUT;</span> |
| <span class="source-line-no">084</span><span id="line-84"> }</span> |
| <span class="source-line-no">085</span><span id="line-85"> if (status == HealthCheckerExitStatus.SUCCESS) {</span> |
| <span class="source-line-no">086</span><span id="line-86"> if (hasErrors(shexec.getOutput())) {</span> |
| <span class="source-line-no">087</span><span id="line-87"> status = HealthCheckerExitStatus.FAILED;</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"> }</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"> return new HealthReport(status, getHealthReport(status));</span> |
| <span class="source-line-no">092</span><span id="line-92"> }</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> private boolean hasErrors(String output) {</span> |
| <span class="source-line-no">095</span><span id="line-95"> String[] splits = output.split("\n");</span> |
| <span class="source-line-no">096</span><span id="line-96"> for (String split : splits) {</span> |
| <span class="source-line-no">097</span><span id="line-97"> if (split.startsWith(ERROR_PATTERN)) {</span> |
| <span class="source-line-no">098</span><span id="line-98"> return true;</span> |
| <span class="source-line-no">099</span><span id="line-99"> }</span> |
| <span class="source-line-no">100</span><span id="line-100"> }</span> |
| <span class="source-line-no">101</span><span id="line-101"> return false;</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"> private String getHealthReport(HealthCheckerExitStatus status) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> String healthReport = null;</span> |
| <span class="source-line-no">106</span><span id="line-106"> switch (status) {</span> |
| <span class="source-line-no">107</span><span id="line-107"> case SUCCESS:</span> |
| <span class="source-line-no">108</span><span id="line-108"> healthReport = "Server is healthy.";</span> |
| <span class="source-line-no">109</span><span id="line-109"> break;</span> |
| <span class="source-line-no">110</span><span id="line-110"> case TIMED_OUT:</span> |
| <span class="source-line-no">111</span><span id="line-111"> healthReport = "Health script timed out";</span> |
| <span class="source-line-no">112</span><span id="line-112"> break;</span> |
| <span class="source-line-no">113</span><span id="line-113"> case FAILED_WITH_EXCEPTION:</span> |
| <span class="source-line-no">114</span><span id="line-114"> healthReport = exceptionStackTrace;</span> |
| <span class="source-line-no">115</span><span id="line-115"> break;</span> |
| <span class="source-line-no">116</span><span id="line-116"> case FAILED_WITH_EXIT_CODE:</span> |
| <span class="source-line-no">117</span><span id="line-117"> healthReport = "Health script failed with exit code.";</span> |
| <span class="source-line-no">118</span><span id="line-118"> break;</span> |
| <span class="source-line-no">119</span><span id="line-119"> case FAILED:</span> |
| <span class="source-line-no">120</span><span id="line-120"> healthReport = shexec.getOutput();</span> |
| <span class="source-line-no">121</span><span id="line-121"> break;</span> |
| <span class="source-line-no">122</span><span id="line-122"> }</span> |
| <span class="source-line-no">123</span><span id="line-123"> return healthReport;</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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
