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