| <!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.Serializable;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.nio.charset.StandardCharsets;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.concurrent.atomic.AtomicBoolean;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.concurrent.atomic.AtomicLong;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.Appender;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.Core;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Filter;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.Layout;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.appender.ManagerFactory;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.appender.OutputStreamManager;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.appender.rolling.FileSize;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.Property;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span>/**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Log4j2 appender to be used when running UTs.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p/><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * The main point here is to limit the total output size to prevent eating all the space of our ci<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * system when something wrong in our code.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <p/><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * See HBASE-26947 for more details.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>@Plugin(name = HBaseTestAppender.PLUGIN_NAME, category = Core.CATEGORY_NAME,<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>public final class HBaseTestAppender extends AbstractOutputStreamAppender<OutputStreamManager> {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> public static final String PLUGIN_NAME = "HBaseTest";<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> private static final HBaseTestManagerFactory FACTORY = new HBaseTestManagerFactory();<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public static class Builder<B extends Builder<B>> extends AbstractOutputStreamAppender.Builder<B><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> implements org.apache.logging.log4j.core.util.Builder<HBaseTestAppender> {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> @PluginBuilderAttribute<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> @Required<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private Target target;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> @PluginBuilderAttribute<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> @Required<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private String maxSize;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public B setTarget(Target target) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> this.target = target;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> return asBuilder();<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> public B setMaxSize(String maxSize) {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> this.maxSize = maxSize;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> return asBuilder();<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> @Override<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> public HBaseTestAppender build() {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> long size = FileSize.parse(maxSize, -1);<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> if (size <= 0) {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> LOGGER.error("Invalid maxSize {}", size);<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> Layout<? extends Serializable> layout = getOrCreateLayout(StandardCharsets.UTF_8);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> OutputStreamManager manager =<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> OutputStreamManager.getManager(target.name(), FACTORY, new FactoryData(target, layout));<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> return new HBaseTestAppender(getName(), layout, getFilter(), isIgnoreExceptions(),<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> isImmediateFlush(), getPropertyArray(), manager, size);<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> /**<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Data to pass to factory method.Unable to instantiate<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> private static class FactoryData {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> private final Target target;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> private final Layout<? extends Serializable> layout;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public FactoryData(Target target, Layout<? extends Serializable> layout) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> this.target = target;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> this.layout = layout;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> /**<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * Factory to create the Appender.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> private static class HBaseTestManagerFactory<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> implements ManagerFactory<HBaseTestOutputStreamManager, FactoryData> {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> /**<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Create an OutputStreamManager.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param name The name of the entity to manage.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param data The data required to create the entity.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @return The OutputStreamManager<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> @Override<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> public HBaseTestOutputStreamManager createManager(final String name, final FactoryData data) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return new HBaseTestOutputStreamManager(data.target, data.layout);<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> }<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> @PluginBuilderFactory<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public static <B extends Builder<B>> B newBuilder() {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> return new Builder<B>().asBuilder();<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> private final long maxSize;<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> private final AtomicLong size = new AtomicLong(0);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> private final AtomicBoolean stop = new AtomicBoolean(false);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> private HBaseTestAppender(String name, Layout<? extends Serializable> layout, Filter filter,<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> boolean ignoreExceptions, boolean immediateFlush, Property[] properties,<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> OutputStreamManager manager, long maxSize) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> super(name, layout, filter, ignoreExceptions, immediateFlush, properties, manager);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> this.maxSize = maxSize;<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> @Override<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> public void append(LogEvent event) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> if (stop.get()) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> return;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> // for accounting, here we always convert the event to byte array first<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> // this will effect performance a bit but it is OK since this is for UT only<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> byte[] bytes = getLayout().toByteArray(event);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> if (bytes == null || bytes.length == 0) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> return;<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> long sizeAfterAppend = size.addAndGet(bytes.length);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> if (sizeAfterAppend >= maxSize) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> // stop logging if the log size exceeded the limit<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> if (stop.compareAndSet(false, true)) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> LOGGER.error("Log size exceeded the limit {}, will stop logging to prevent eating"<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> + " too much disk space", maxSize);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> return;<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> super.append(event);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span>}<a name="line.160"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
