| <!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 or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.appender;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.util.ArrayList;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.List;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Map;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.concurrent.BlockingQueue;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.concurrent.TimeUnit;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.concurrent.TransferQueue;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.concurrent.atomic.AtomicLong;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.AbstractLogEvent;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.Appender;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.Core;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.Filter;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.async.ArrayBlockingQueueFactory;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.async.AsyncQueueFullMessageUtil;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.async.AsyncQueueFullPolicy;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.async.AsyncQueueFullPolicyFactory;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.async.BlockingQueueFactory;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.async.DiscardingAsyncQueueFullPolicy;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.async.EventRoute;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.async.InternalAsyncUtil;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.config.AppenderControl;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.config.AppenderRef;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.config.ConfigurationException;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.config.Property;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.logging.log4j.core.config.plugins.PluginAliases;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import org.apache.logging.log4j.core.filter.AbstractFilterable;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import org.apache.logging.log4j.core.impl.Log4jLogEvent;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import org.apache.logging.log4j.core.util.Log4jThread;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>import org.apache.logging.log4j.spi.AbstractLogger;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span>/**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Appends to one or more Appenders asynchronously. You can configure an AsyncAppender with one or more Appenders and an<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Appender to append to if the queue is full. The AsyncAppender does not allow a filter to be specified on the Appender<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * references.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span>@Plugin(name = "Async", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.62"></a> |
| <span class="sourceLineNo">063</span>public final class AsyncAppender extends AbstractAppender {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private static final int DEFAULT_QUEUE_SIZE = 1024;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private static final LogEvent SHUTDOWN_LOG_EVENT = new AbstractLogEvent() {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private static final long serialVersionUID = -1761035149477086330L;<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> private static final AtomicLong THREAD_SEQUENCE = new AtomicLong(1);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> private final BlockingQueue<LogEvent> queue;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private final int queueSize;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> private final boolean blocking;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> private final long shutdownTimeout;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> private final Configuration config;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> private final AppenderRef[] appenderRefs;<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> private final String errorRef;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> private final boolean includeLocation;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> private AppenderControl errorAppender;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private AsyncThread thread;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private AsyncQueueFullPolicy asyncQueueFullPolicy;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private AsyncAppender(final String name, final Filter filter, final AppenderRef[] appenderRefs,<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> final String errorRef, final int queueSize, final boolean blocking, final boolean ignoreExceptions,<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> final long shutdownTimeout, final Configuration config, final boolean includeLocation,<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> final BlockingQueueFactory<LogEvent> blockingQueueFactory, final Property[] properties) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> super(name, filter, null, ignoreExceptions, properties);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> this.queue = blockingQueueFactory.create(queueSize);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> this.queueSize = queueSize;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> this.blocking = blocking;<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> this.shutdownTimeout = shutdownTimeout;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> this.config = config;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> this.appenderRefs = appenderRefs;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> this.errorRef = errorRef;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> this.includeLocation = includeLocation;<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> @Override<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> public void start() {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> final Map<String, Appender> map = config.getAppenders();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> final List<AppenderControl> appenders = new ArrayList<>();<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> for (final AppenderRef appenderRef : appenderRefs) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> final Appender appender = map.get(appenderRef.getRef());<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> if (appender != null) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> appenders.add(new AppenderControl(appender, appenderRef.getLevel(), appenderRef.getFilter()));<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> } else {<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> LOGGER.error("No appender named {} was configured", appenderRef);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> }<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> }<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> if (errorRef != null) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> final Appender appender = map.get(errorRef);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> if (appender != null) {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> errorAppender = new AppenderControl(appender, null, null);<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> } else {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> LOGGER.error("Unable to set up error Appender. No appender named {} was configured", errorRef);<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> if (appenders.size() > 0) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> thread = new AsyncThread(appenders, queue);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> thread.setName("AsyncAppender-" + getName());<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> } else if (errorRef == null) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> throw new ConfigurationException("No appenders are available for AsyncAppender " + getName());<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> asyncQueueFullPolicy = AsyncQueueFullPolicyFactory.create();<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> thread.start();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> super.start();<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> }<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> @Override<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> setStopping();<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> super.stop(timeout, timeUnit, false);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> LOGGER.trace("AsyncAppender stopping. Queue still has {} events.", queue.size());<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> thread.shutdown();<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> try {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> thread.join(shutdownTimeout);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> } catch (final InterruptedException ex) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> LOGGER.warn("Interrupted while stopping AsyncAppender {}", getName());<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> LOGGER.trace("AsyncAppender stopped. Queue has {} events.", queue.size());<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> if (DiscardingAsyncQueueFullPolicy.getDiscardCount(asyncQueueFullPolicy) > 0) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> LOGGER.trace("AsyncAppender: {} discarded {} events.", asyncQueueFullPolicy,<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> DiscardingAsyncQueueFullPolicy.getDiscardCount(asyncQueueFullPolicy));<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> setStopped();<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return true;<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> /**<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * Actual writing occurs here.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> *<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @param logEvent The LogEvent.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> */<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> @Override<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> public void append(final LogEvent logEvent) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> if (!isStarted()) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> throw new IllegalStateException("AsyncAppender " + getName() + " is not active");<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> final Log4jLogEvent memento = Log4jLogEvent.createMemento(logEvent, includeLocation);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> InternalAsyncUtil.makeMessageImmutable(logEvent.getMessage());<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> if (!transfer(memento)) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> if (blocking) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> if (AbstractLogger.getRecursionDepth() > 1) { // LOG4J2-1518, LOG4J2-2031<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> // If queue is full AND we are in a recursive call, call appender directly to prevent deadlock<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> AsyncQueueFullMessageUtil.logWarningToStatusLogger();<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> logMessageInCurrentThread(logEvent);<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> } else {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> // delegate to the event router (which may discard, enqueue and block, or log in current thread)<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> final EventRoute route = asyncQueueFullPolicy.getRoute(thread.getId(), memento.getLevel());<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> route.logMessage(this, memento);<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> } else {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> error("Appender " + getName() + " is unable to write primary appenders. queue is full");<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> logToErrorAppenderIfNecessary(false, memento);<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> }<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> private boolean transfer(final LogEvent memento) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> return queue instanceof TransferQueue<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> ? ((TransferQueue<LogEvent>) queue).tryTransfer(memento)<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> : queue.offer(memento);<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> }<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> /**<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * FOR INTERNAL USE ONLY.<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> *<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * @param logEvent the event to log<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> */<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> public void logMessageInCurrentThread(final LogEvent logEvent) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> logEvent.setEndOfBatch(queue.isEmpty());<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> final boolean appendSuccessful = thread.callAppenders(logEvent);<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> logToErrorAppenderIfNecessary(appendSuccessful, logEvent);<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> /**<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * FOR INTERNAL USE ONLY.<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> *<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * @param logEvent the event to log<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> */<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> public void logMessageInBackgroundThread(final LogEvent logEvent) {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> try {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> // wait for free slots in the queue<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> queue.put(logEvent);<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> } catch (final InterruptedException e) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> final boolean appendSuccessful = handleInterruptedException(logEvent);<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> logToErrorAppenderIfNecessary(appendSuccessful, logEvent);<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> }<a name="line.212"></a> |
| <span class="sourceLineNo">213</span><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> // LOG4J2-1049: Some applications use Thread.interrupt() to send<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> // messages between application threads. This does not necessarily<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> // mean that the queue is full. To prevent dropping a log message,<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> // quickly try to offer the event to the queue again.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> // (Yes, this means there is a possibility the same event is logged twice.)<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> //<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> // Finally, catching the InterruptedException means the<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> // interrupted flag has been cleared on the current thread.<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> // This may interfere with the application's expectation of<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> // being interrupted, so when we are done, we set the interrupted<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> // flag again.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> private boolean handleInterruptedException(final LogEvent memento) {<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> final boolean appendSuccessful = queue.offer(memento);<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> if (!appendSuccessful) {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> LOGGER.warn("Interrupted while waiting for a free slot in the AsyncAppender LogEvent-queue {}",<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> getName());<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> }<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> // set the interrupted flag again.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> Thread.currentThread().interrupt();<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> return appendSuccessful;<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> }<a name="line.234"></a> |
| <span class="sourceLineNo">235</span><a name="line.235"></a> |
| <span class="sourceLineNo">236</span> private void logToErrorAppenderIfNecessary(final boolean appendSuccessful, final LogEvent logEvent) {<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> if (!appendSuccessful && errorAppender != null) {<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> errorAppender.callAppender(logEvent);<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> }<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> }<a name="line.240"></a> |
| <span class="sourceLineNo">241</span><a name="line.241"></a> |
| <span class="sourceLineNo">242</span> /**<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * Create an AsyncAppender. This method is retained for backwards compatibility. New code should use the<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * {@link Builder} instead. This factory will use {@link ArrayBlockingQueueFactory} by default as was the behavior<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * pre-2.7.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> *<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @param appenderRefs The Appenders to reference.<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * @param errorRef An optional Appender to write to if the queue is full or other errors occur.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @param blocking True if the Appender should wait when the queue is full. The default is true.<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * @param shutdownTimeout How many milliseconds the Appender should wait to flush outstanding log events<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * in the queue on shutdown. The default is zero which means to wait forever.<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * @param size The size of the event queue. The default is 128.<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * @param name The name of the Appender.<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * @param includeLocation whether to include location information. The default is false.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * @param filter The Filter or null.<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * @param config The Configuration.<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * @param ignoreExceptions If {@code "true"} (default) exceptions encountered when appending events are logged;<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * otherwise they are propagated to the caller.<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * @return The AsyncAppender.<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * @deprecated use {@link Builder} instead<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> */<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> @Deprecated<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> public static AsyncAppender createAppender(final AppenderRef[] appenderRefs, final String errorRef,<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> final boolean blocking, final long shutdownTimeout, final int size,<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> final String name, final boolean includeLocation, final Filter filter,<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> final Configuration config, final boolean ignoreExceptions) {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> if (name == null) {<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> LOGGER.error("No name provided for AsyncAppender");<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> return null;<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> }<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> if (appenderRefs == null) {<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> LOGGER.error("No appender references provided to AsyncAppender {}", name);<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> }<a name="line.273"></a> |
| <span class="sourceLineNo">274</span><a name="line.274"></a> |
| <span class="sourceLineNo">275</span> return new AsyncAppender(name, filter, appenderRefs, errorRef, size, blocking, ignoreExceptions,<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> shutdownTimeout, config, includeLocation, new ArrayBlockingQueueFactory<LogEvent>(), null);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> }<a name="line.277"></a> |
| <span class="sourceLineNo">278</span><a name="line.278"></a> |
| <span class="sourceLineNo">279</span> @PluginBuilderFactory<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> public static Builder newBuilder() {<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> return new Builder();<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> }<a name="line.282"></a> |
| <span class="sourceLineNo">283</span><a name="line.283"></a> |
| <span class="sourceLineNo">284</span> public static class Builder<B extends Builder<B>> extends AbstractFilterable.Builder<B><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> implements org.apache.logging.log4j.core.util.Builder<AsyncAppender> {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span><a name="line.286"></a> |
| <span class="sourceLineNo">287</span> @PluginElement("AppenderRef")<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> @Required(message = "No appender references provided to AsyncAppender")<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> private AppenderRef[] appenderRefs;<a name="line.289"></a> |
| <span class="sourceLineNo">290</span><a name="line.290"></a> |
| <span class="sourceLineNo">291</span> @PluginBuilderAttribute<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> @PluginAliases("error-ref")<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> private String errorRef;<a name="line.293"></a> |
| <span class="sourceLineNo">294</span><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> @PluginBuilderAttribute<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> private boolean blocking = true;<a name="line.296"></a> |
| <span class="sourceLineNo">297</span><a name="line.297"></a> |
| <span class="sourceLineNo">298</span> @PluginBuilderAttribute<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> private long shutdownTimeout = 0L;<a name="line.299"></a> |
| <span class="sourceLineNo">300</span><a name="line.300"></a> |
| <span class="sourceLineNo">301</span> @PluginBuilderAttribute<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> private int bufferSize = DEFAULT_QUEUE_SIZE;<a name="line.302"></a> |
| <span class="sourceLineNo">303</span><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> @PluginBuilderAttribute<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> @Required(message = "No name provided for AsyncAppender")<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> private String name;<a name="line.306"></a> |
| <span class="sourceLineNo">307</span><a name="line.307"></a> |
| <span class="sourceLineNo">308</span> @PluginBuilderAttribute<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> private boolean includeLocation = false;<a name="line.309"></a> |
| <span class="sourceLineNo">310</span><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> @PluginConfiguration<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> private Configuration configuration;<a name="line.312"></a> |
| <span class="sourceLineNo">313</span><a name="line.313"></a> |
| <span class="sourceLineNo">314</span> @PluginBuilderAttribute<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> private boolean ignoreExceptions = true;<a name="line.315"></a> |
| <span class="sourceLineNo">316</span><a name="line.316"></a> |
| <span class="sourceLineNo">317</span> @PluginElement(BlockingQueueFactory.ELEMENT_TYPE)<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> private BlockingQueueFactory<LogEvent> blockingQueueFactory = new ArrayBlockingQueueFactory<>();<a name="line.318"></a> |
| <span class="sourceLineNo">319</span><a name="line.319"></a> |
| <span class="sourceLineNo">320</span> public Builder setAppenderRefs(final AppenderRef[] appenderRefs) {<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> this.appenderRefs = appenderRefs;<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> return this;<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> }<a name="line.323"></a> |
| <span class="sourceLineNo">324</span><a name="line.324"></a> |
| <span class="sourceLineNo">325</span> public Builder setErrorRef(final String errorRef) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> this.errorRef = errorRef;<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> return this;<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> public Builder setBlocking(final boolean blocking) {<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> this.blocking = blocking;<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> return this;<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> }<a name="line.333"></a> |
| <span class="sourceLineNo">334</span><a name="line.334"></a> |
| <span class="sourceLineNo">335</span> public Builder setShutdownTimeout(final long shutdownTimeout) {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> this.shutdownTimeout = shutdownTimeout;<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> return this;<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> }<a name="line.338"></a> |
| <span class="sourceLineNo">339</span><a name="line.339"></a> |
| <span class="sourceLineNo">340</span> public Builder setBufferSize(final int bufferSize) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> this.bufferSize = bufferSize;<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> return this;<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> }<a name="line.343"></a> |
| <span class="sourceLineNo">344</span><a name="line.344"></a> |
| <span class="sourceLineNo">345</span> public Builder setName(final String name) {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> this.name = name;<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> return this;<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> public Builder setIncludeLocation(final boolean includeLocation) {<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> this.includeLocation = includeLocation;<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> return this;<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> }<a name="line.353"></a> |
| <span class="sourceLineNo">354</span><a name="line.354"></a> |
| <span class="sourceLineNo">355</span> public Builder setConfiguration(final Configuration configuration) {<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> this.configuration = configuration;<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> return this;<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> }<a name="line.358"></a> |
| <span class="sourceLineNo">359</span><a name="line.359"></a> |
| <span class="sourceLineNo">360</span> public Builder setIgnoreExceptions(final boolean ignoreExceptions) {<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> this.ignoreExceptions = ignoreExceptions;<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> return this;<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> }<a name="line.363"></a> |
| <span class="sourceLineNo">364</span><a name="line.364"></a> |
| <span class="sourceLineNo">365</span> public Builder setBlockingQueueFactory(final BlockingQueueFactory<LogEvent> blockingQueueFactory) {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> this.blockingQueueFactory = blockingQueueFactory;<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> return this;<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> }<a name="line.368"></a> |
| <span class="sourceLineNo">369</span><a name="line.369"></a> |
| <span class="sourceLineNo">370</span> @Override<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> public AsyncAppender build() {<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> return new AsyncAppender(name, getFilter(), appenderRefs, errorRef, bufferSize, blocking, ignoreExceptions,<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> shutdownTimeout, configuration, includeLocation, blockingQueueFactory, getPropertyArray());<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> }<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> }<a name="line.375"></a> |
| <span class="sourceLineNo">376</span><a name="line.376"></a> |
| <span class="sourceLineNo">377</span> /**<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * Thread that calls the Appenders.<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> */<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> private class AsyncThread extends Log4jThread {<a name="line.380"></a> |
| <span class="sourceLineNo">381</span><a name="line.381"></a> |
| <span class="sourceLineNo">382</span> private volatile boolean shutdown = false;<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> private final List<AppenderControl> appenders;<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> private final BlockingQueue<LogEvent> queue;<a name="line.384"></a> |
| <span class="sourceLineNo">385</span><a name="line.385"></a> |
| <span class="sourceLineNo">386</span> public AsyncThread(final List<AppenderControl> appenders, final BlockingQueue<LogEvent> queue) {<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> super("AsyncAppender-" + THREAD_SEQUENCE.getAndIncrement());<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> this.appenders = appenders;<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> this.queue = queue;<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> setDaemon(true);<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> }<a name="line.391"></a> |
| <span class="sourceLineNo">392</span><a name="line.392"></a> |
| <span class="sourceLineNo">393</span> @Override<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> public void run() {<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> while (!shutdown) {<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> LogEvent event;<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> try {<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> event = queue.take();<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> if (event == SHUTDOWN_LOG_EVENT) {<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> shutdown = true;<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> continue;<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> } catch (final InterruptedException ex) {<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> break; // LOG4J2-830<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> event.setEndOfBatch(queue.isEmpty());<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> final boolean success = callAppenders(event);<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> if (!success && errorAppender != null) {<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> try {<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> errorAppender.callAppender(event);<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> } catch (final Exception ex) {<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> // Silently accept the error.<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> }<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> }<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> }<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> // Process any remaining items in the queue.<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> LOGGER.trace("AsyncAppender.AsyncThread shutting down. Processing remaining {} queue events.",<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> queue.size());<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> int count = 0;<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> int ignored = 0;<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> while (!queue.isEmpty()) {<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> try {<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> final LogEvent event = queue.take();<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> if (event instanceof Log4jLogEvent) {<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> final Log4jLogEvent logEvent = (Log4jLogEvent) event;<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> logEvent.setEndOfBatch(queue.isEmpty());<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> callAppenders(logEvent);<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> count++;<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> } else {<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> ignored++;<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> LOGGER.trace("Ignoring event of class {}", event.getClass().getName());<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> }<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> } catch (final InterruptedException ex) {<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> // May have been interrupted to shut down.<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> // Here we ignore interrupts and try to process all remaining events.<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> }<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> }<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> LOGGER.trace("AsyncAppender.AsyncThread stopped. Queue has {} events remaining. "<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> + "Processed {} and ignored {} events since shutdown started.", queue.size(), count, ignored);<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> }<a name="line.440"></a> |
| <span class="sourceLineNo">441</span><a name="line.441"></a> |
| <span class="sourceLineNo">442</span> /**<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> * Calls {@link AppenderControl#callAppender(LogEvent) callAppender} on all registered {@code AppenderControl}<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * objects, and returns {@code true} if at least one appender call was successful, {@code false} otherwise. Any<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * exceptions are silently ignored.<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> *<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * @param event the event to forward to the registered appenders<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * @return {@code true} if at least one appender call succeeded, {@code false} otherwise<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> */<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> boolean callAppenders(final LogEvent event) {<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> boolean success = false;<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> for (final AppenderControl control : appenders) {<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> try {<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> control.callAppender(event);<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> success = true;<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> } catch (final Exception ex) {<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> // If no appender is successful the error appender will get it.<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> }<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> }<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> return success;<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> }<a name="line.461"></a> |
| <span class="sourceLineNo">462</span><a name="line.462"></a> |
| <span class="sourceLineNo">463</span> public void shutdown() {<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> shutdown = true;<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> if (queue.isEmpty()) {<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> queue.offer(SHUTDOWN_LOG_EVENT);<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> }<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> if (getState() == State.TIMED_WAITING || getState() == State.WAITING) {<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> this.interrupt(); // LOG4J2-1422: if underlying appender is stuck in wait/sleep/join/park call<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> }<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> }<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> }<a name="line.472"></a> |
| <span class="sourceLineNo">473</span><a name="line.473"></a> |
| <span class="sourceLineNo">474</span> /**<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> * Returns the names of the appenders that this asyncAppender delegates to as an array of Strings.<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> *<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * @return the names of the sink appenders<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> */<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> public String[] getAppenderRefStrings() {<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> final String[] result = new String[appenderRefs.length];<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> for (int i = 0; i < result.length; i++) {<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> result[i] = appenderRefs[i].getRef();<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> }<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> return result;<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> }<a name="line.485"></a> |
| <span class="sourceLineNo">486</span><a name="line.486"></a> |
| <span class="sourceLineNo">487</span> /**<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * Returns {@code true} if this AsyncAppender will take a snapshot of the stack with every log event to determine<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * the class and method where the logging call was made.<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> *<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> * @return {@code true} if location is included with every event, {@code false} otherwise<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> */<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> public boolean isIncludeLocation() {<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> return includeLocation;<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> }<a name="line.495"></a> |
| <span class="sourceLineNo">496</span><a name="line.496"></a> |
| <span class="sourceLineNo">497</span> /**<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * Returns {@code true} if this AsyncAppender will block when the queue is full, or {@code false} if events are<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * dropped when the queue is full.<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> *<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * @return whether this AsyncAppender will block or drop events when the queue is full.<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> */<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> public boolean isBlocking() {<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> return blocking;<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> }<a name="line.505"></a> |
| <span class="sourceLineNo">506</span><a name="line.506"></a> |
| <span class="sourceLineNo">507</span> /**<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> * Returns the name of the appender that any errors are logged to or {@code null}.<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> *<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * @return the name of the appender that any errors are logged to or {@code null}<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> */<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> public String getErrorRef() {<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> return errorRef;<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> }<a name="line.514"></a> |
| <span class="sourceLineNo">515</span><a name="line.515"></a> |
| <span class="sourceLineNo">516</span> public int getQueueCapacity() {<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> return queueSize;<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> }<a name="line.518"></a> |
| <span class="sourceLineNo">519</span><a name="line.519"></a> |
| <span class="sourceLineNo">520</span> public int getQueueRemainingCapacity() {<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> return queue.remainingCapacity();<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> }<a name="line.522"></a> |
| <span class="sourceLineNo">523</span><a name="line.523"></a> |
| <span class="sourceLineNo">524</span> /**<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> * Returns the number of elements in the queue.<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> *<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> * @return the number of elements in the queue.<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> * @since 2.11.1<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> */<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> public int getQueueSize() {<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> return queue.size();<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> }<a name="line.532"></a> |
| <span class="sourceLineNo">533</span>}<a name="line.533"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
