Google Git
Sign in
apache / hbase-site / 6be7f1c569b0f0f64151e4687d98bbf050cb369a / . / devapidocs / src-html / org / apache / hadoop / hbase / logging / Log4jUtils.html
blob: 9a9659d277fbd87dc108bb2eba5fea458fa89ada [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> * 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.logging;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.File;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.reflect.InvocationTargetException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.lang.reflect.Method;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Set;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * A bridge class for operating on log4j, such as changing log level, etc.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p/&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Will call the methods in {@link InternalLog4jUtils} to actually operate on the log4j stuff.<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a>
<span class="sourceLineNo">033</span>public final class Log4jUtils {<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> private static final String INTERNAL_UTILS_CLASS_NAME =<a name="line.35"></a>
<span class="sourceLineNo">036</span> "org.apache.hadoop.hbase.logging.InternalLog4jUtils";<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> private Log4jUtils() {<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> // load class when calling to avoid introducing class not found exception on log4j when loading<a name="line.41"></a>
<span class="sourceLineNo">042</span> // this class even without calling any of the methods below.<a name="line.42"></a>
<span class="sourceLineNo">043</span> private static Method getMethod(String methodName, Class&lt;?&gt;... args) {<a name="line.43"></a>
<span class="sourceLineNo">044</span> try {<a name="line.44"></a>
<span class="sourceLineNo">045</span> Class&lt;?&gt; clazz = Class.forName(INTERNAL_UTILS_CLASS_NAME);<a name="line.45"></a>
<span class="sourceLineNo">046</span> return clazz.getDeclaredMethod(methodName, args);<a name="line.46"></a>
<span class="sourceLineNo">047</span> } catch (ClassNotFoundException | NoSuchMethodException e) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> throw new AssertionError("should not happen", e);<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span> }<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private static void throwUnchecked(Throwable throwable) {<a name="line.52"></a>
<span class="sourceLineNo">053</span> if (throwable instanceof RuntimeException) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> throw (RuntimeException) throwable;<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span> if (throwable instanceof Error) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> throw (Error) throwable;<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> private static void invoke(Method method, Object... args) throws AssertionError {<a name="line.61"></a>
<span class="sourceLineNo">062</span> try {<a name="line.62"></a>
<span class="sourceLineNo">063</span> method.invoke(null, args);<a name="line.63"></a>
<span class="sourceLineNo">064</span> } catch (IllegalAccessException e) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> throw new AssertionError("should not happen", e);<a name="line.65"></a>
<span class="sourceLineNo">066</span> } catch (InvocationTargetException e) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> throwUnchecked(e.getCause());<a name="line.67"></a>
<span class="sourceLineNo">068</span> throw new AssertionError("should not happen", e.getCause());<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<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> public static void setAllLevels(String loggerName, String levelName) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> Method method = getMethod("setAllLevels", String.class, String.class);<a name="line.73"></a>
<span class="sourceLineNo">074</span> invoke(method, loggerName, levelName);<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> public static void setLogLevel(String loggerName, String levelName) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> Method method = getMethod("setLogLevel", String.class, String.class);<a name="line.78"></a>
<span class="sourceLineNo">079</span> invoke(method, loggerName, levelName);<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> public static void setRootLevel(String levelName) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> Method method = getMethod("setRootLevel", String.class);<a name="line.83"></a>
<span class="sourceLineNo">084</span> invoke(method, levelName);<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> public static String getEffectiveLevel(String loggerName) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> Method method = getMethod("getEffectiveLevel", String.class);<a name="line.88"></a>
<span class="sourceLineNo">089</span> try {<a name="line.89"></a>
<span class="sourceLineNo">090</span> return (String) method.invoke(null, loggerName);<a name="line.90"></a>
<span class="sourceLineNo">091</span> } catch (IllegalAccessException e) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> throw new AssertionError("should not happen", e);<a name="line.92"></a>
<span class="sourceLineNo">093</span> } catch (InvocationTargetException e) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> throwUnchecked(e.getCause());<a name="line.94"></a>
<span class="sourceLineNo">095</span> throw new AssertionError("should not happen", e.getCause());<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<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> @SuppressWarnings("unchecked")<a name="line.99"></a>
<span class="sourceLineNo">100</span> public static Set&lt;File&gt; getActiveLogFiles() throws IOException {<a name="line.100"></a>
<span class="sourceLineNo">101</span> Method method = getMethod("getActiveLogFiles");<a name="line.101"></a>
<span class="sourceLineNo">102</span> try {<a name="line.102"></a>
<span class="sourceLineNo">103</span> return (Set&lt;File&gt;) method.invoke(null);<a name="line.103"></a>
<span class="sourceLineNo">104</span> } catch (IllegalAccessException e) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> throw new AssertionError("should not happen", e);<a name="line.105"></a>
<span class="sourceLineNo">106</span> } catch (InvocationTargetException e) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> Throwable cause = e.getCause();<a name="line.107"></a>
<span class="sourceLineNo">108</span> throwUnchecked(cause);<a name="line.108"></a>
<span class="sourceLineNo">109</span> if (cause instanceof IOException) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> throw (IOException) cause;<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span> throw new AssertionError("should not happen", cause);<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> /**<a name="line.116"></a>
<span class="sourceLineNo">117</span> * Disables Zk- and HBase client logging<a name="line.117"></a>
<span class="sourceLineNo">118</span> */<a name="line.118"></a>
<span class="sourceLineNo">119</span> public static void disableZkAndClientLoggers() {<a name="line.119"></a>
<span class="sourceLineNo">120</span> // disable zookeeper log to avoid it mess up command output<a name="line.120"></a>
<span class="sourceLineNo">121</span> setLogLevel("org.apache.zookeeper", "OFF");<a name="line.121"></a>
<span class="sourceLineNo">122</span> // disable hbase zookeeper tool log to avoid it mess up command output<a name="line.122"></a>
<span class="sourceLineNo">123</span> setLogLevel("org.apache.hadoop.hbase.zookeeper", "OFF");<a name="line.123"></a>
<span class="sourceLineNo">124</span> // disable hbase client log to avoid it mess up command output<a name="line.124"></a>
<span class="sourceLineNo">125</span> setLogLevel("org.apache.hadoop.hbase.client", "OFF");<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> /**<a name="line.128"></a>
<span class="sourceLineNo">129</span> * Switches the logger for the given class to DEBUG level.<a name="line.129"></a>
<span class="sourceLineNo">130</span> * @param clazz The class for which to switch to debug logging.<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> public static void enableDebug(Class&lt;?&gt; clazz) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> setLogLevel(clazz.getName(), "DEBUG");<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span>}<a name="line.135"></a>
</pre>
</div>
</body>
</html>