| <!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.async;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.util.concurrent.ThreadFactory;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.concurrent.TimeUnit;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.Level;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.AbstractLifeCycle;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.impl.Log4jLogEvent;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.impl.LogEventFactory;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.impl.MutableLogEvent;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.impl.ReusableLogEventFactory;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.jmx.RingBufferAdmin;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.util.Log4jThreadFactory;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.util.Throwables;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.message.ReusableMessage;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import com.lmax.disruptor.EventFactory;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import com.lmax.disruptor.EventTranslatorTwoArg;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import com.lmax.disruptor.ExceptionHandler;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import com.lmax.disruptor.RingBuffer;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import com.lmax.disruptor.Sequence;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import com.lmax.disruptor.SequenceReportingEventHandler;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import com.lmax.disruptor.TimeoutException;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import com.lmax.disruptor.WaitStrategy;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import com.lmax.disruptor.dsl.Disruptor;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import com.lmax.disruptor.dsl.ProducerType;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span>/**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Helper class decoupling the {@code AsyncLoggerConfig} class from the LMAX Disruptor library.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <p><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * {@code AsyncLoggerConfig} is a plugin, and will be loaded even if users do not configure any {@code <asyncLogger>} or<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * {@code <asyncRoot>} elements in the configuration. If {@code AsyncLoggerConfig} has inner classes that extend or<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * implement classes from the Disruptor library, a {@code NoClassDefFoundError} is thrown if the Disruptor jar is not in<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * the classpath when the PluginManager loads the {@code AsyncLoggerConfig} plugin from the pre-defined plugins<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * definition file.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <p><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * This class serves to make the dependency on the Disruptor optional, so that these classes are only loaded when the<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * {@code AsyncLoggerConfig} is actually used.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>public class AsyncLoggerConfigDisruptor extends AbstractLifeCycle implements AsyncLoggerConfigDelegate {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private static final int MAX_DRAIN_ATTEMPTS_BEFORE_SHUTDOWN = 200;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private static final int SLEEP_MILLIS_BETWEEN_DRAIN_ATTEMPTS = 50;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * RingBuffer events contain all information necessary to perform the work in a separate thread.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public static class Log4jEventWrapper {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public Log4jEventWrapper() {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> }<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public Log4jEventWrapper(final MutableLogEvent mutableLogEvent) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> event = mutableLogEvent;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> }<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private AsyncLoggerConfig loggerConfig;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> private LogEvent event;<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> * Release references held by ring buffer to allow objects to be garbage-collected.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> public void clear() {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> loggerConfig = null;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> if (event instanceof MutableLogEvent) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> ((MutableLogEvent) event).clear();<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> } else {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> event = null;<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><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> @Override<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> public String toString() {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> return String.valueOf(event);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> /**<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * EventHandler performs the work in a separate thread.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> private static class Log4jEventWrapperHandler implements SequenceReportingEventHandler<Log4jEventWrapper> {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> private static final int NOTIFY_PROGRESS_THRESHOLD = 50;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> private Sequence sequenceCallback;<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> private int counter;<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> @Override<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> public void setSequenceCallback(final Sequence sequenceCallback) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> this.sequenceCallback = sequenceCallback;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> @Override<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> public void onEvent(final Log4jEventWrapper event, final long sequence, final boolean endOfBatch)<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> throws Exception {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> event.event.setEndOfBatch(endOfBatch);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> event.loggerConfig.logToAsyncLoggerConfigsOnCurrentThread(event.event);<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> event.clear();<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> notifyIntermediateProgress(sequence);<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> /**<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * Notify the BatchEventProcessor that the sequence has progressed. Without this callback the sequence would not<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * be progressed until the batch has completely finished.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> private void notifyIntermediateProgress(final long sequence) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> if (++counter > NOTIFY_PROGRESS_THRESHOLD) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> sequenceCallback.set(sequence);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> counter = 0;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<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> /**<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * Factory used to populate the RingBuffer with events. These event objects are then re-used during the life of the<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * RingBuffer.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> */<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> private static final EventFactory<Log4jEventWrapper> FACTORY = new EventFactory<Log4jEventWrapper>() {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> @Override<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> public Log4jEventWrapper newInstance() {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return new Log4jEventWrapper();<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> };<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> /**<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * Factory used to populate the RingBuffer with events. These event objects are then re-used during the life of the<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * RingBuffer.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> private static final EventFactory<Log4jEventWrapper> MUTABLE_FACTORY = new EventFactory<Log4jEventWrapper>() {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> @Override<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> public Log4jEventWrapper newInstance() {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> return new Log4jEventWrapper(new MutableLogEvent());<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> };<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> * Object responsible for passing on data to a specific RingBuffer event.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> */<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> private static final EventTranslatorTwoArg<Log4jEventWrapper, LogEvent, AsyncLoggerConfig> TRANSLATOR =<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> new EventTranslatorTwoArg<Log4jEventWrapper, LogEvent, AsyncLoggerConfig>() {<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 translateTo(final Log4jEventWrapper ringBufferElement, final long sequence,<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> final LogEvent logEvent, final AsyncLoggerConfig loggerConfig) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> ringBufferElement.event = logEvent;<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> ringBufferElement.loggerConfig = loggerConfig;<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> };<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> /**<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * Object responsible for passing on data to a RingBuffer event with a MutableLogEvent.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> */<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> private static final EventTranslatorTwoArg<Log4jEventWrapper, LogEvent, AsyncLoggerConfig> MUTABLE_TRANSLATOR =<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> new EventTranslatorTwoArg<Log4jEventWrapper, LogEvent, AsyncLoggerConfig>() {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> @Override<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> public void translateTo(final Log4jEventWrapper ringBufferElement, final long sequence,<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> final LogEvent logEvent, final AsyncLoggerConfig loggerConfig) {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> ((MutableLogEvent) ringBufferElement.event).initFrom(logEvent);<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> ringBufferElement.loggerConfig = loggerConfig;<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> };<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> private int ringBufferSize;<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> private AsyncQueueFullPolicy asyncQueueFullPolicy;<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> private Boolean mutable = Boolean.FALSE;<a name="line.181"></a> |
| <span class="sourceLineNo">182</span><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> private volatile Disruptor<Log4jEventWrapper> disruptor;<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> private long backgroundThreadId; // LOG4J2-471<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> private EventFactory<Log4jEventWrapper> factory;<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> private EventTranslatorTwoArg<Log4jEventWrapper, LogEvent, AsyncLoggerConfig> translator;<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> private volatile boolean alreadyLoggedWarning = false;<a name="line.187"></a> |
| <span class="sourceLineNo">188</span><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> private final Object queueFullEnqueueLock = new Object();<a name="line.189"></a> |
| <span class="sourceLineNo">190</span><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> public AsyncLoggerConfigDisruptor() {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> // called from AsyncLoggerConfig constructor<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> @Override<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> public void setLogEventFactory(final LogEventFactory logEventFactory) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> // if any AsyncLoggerConfig uses a ReusableLogEventFactory<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> // then we need to populate our ringbuffer with MutableLogEvents<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> this.mutable = mutable || (logEventFactory instanceof ReusableLogEventFactory);<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> /**<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * Increases the reference count and creates and starts a new Disruptor and associated thread if none currently<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * exists.<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> *<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * @see #stop()<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> */<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> @Override<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> public synchronized void start() {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> if (disruptor != null) {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> LOGGER.trace("AsyncLoggerConfigDisruptor not starting new disruptor for this configuration, "<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> + "using existing object.");<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> return;<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> }<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> LOGGER.trace("AsyncLoggerConfigDisruptor creating new disruptor for this configuration.");<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> ringBufferSize = DisruptorUtil.calculateRingBufferSize("AsyncLoggerConfig.RingBufferSize");<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> final WaitStrategy waitStrategy = DisruptorUtil.createWaitStrategy("AsyncLoggerConfig.WaitStrategy");<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> final ThreadFactory threadFactory = new Log4jThreadFactory("AsyncLoggerConfig", true, Thread.NORM_PRIORITY) {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> @Override<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> public Thread newThread(final Runnable r) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> final Thread result = super.newThread(r);<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> backgroundThreadId = result.getId();<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> return result;<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> }<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> };<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> asyncQueueFullPolicy = AsyncQueueFullPolicyFactory.create();<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> translator = mutable ? MUTABLE_TRANSLATOR : TRANSLATOR;<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> factory = mutable ? MUTABLE_FACTORY : FACTORY;<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> disruptor = new Disruptor<>(factory, ringBufferSize, threadFactory, ProducerType.MULTI, waitStrategy);<a name="line.231"></a> |
| <span class="sourceLineNo">232</span><a name="line.232"></a> |
| <span class="sourceLineNo">233</span> final ExceptionHandler<Log4jEventWrapper> errorHandler = DisruptorUtil.getAsyncLoggerConfigExceptionHandler();<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> disruptor.setDefaultExceptionHandler(errorHandler);<a name="line.234"></a> |
| <span class="sourceLineNo">235</span><a name="line.235"></a> |
| <span class="sourceLineNo">236</span> final Log4jEventWrapperHandler[] handlers = {new Log4jEventWrapperHandler()};<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> disruptor.handleEventsWith(handlers);<a name="line.237"></a> |
| <span class="sourceLineNo">238</span><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> LOGGER.debug("Starting AsyncLoggerConfig disruptor for this configuration with ringbufferSize={}, "<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> + "waitStrategy={}, exceptionHandler={}...", disruptor.getRingBuffer().getBufferSize(), waitStrategy<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> .getClass().getSimpleName(), errorHandler);<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> disruptor.start();<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> super.start();<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> }<a name="line.244"></a> |
| <span class="sourceLineNo">245</span><a name="line.245"></a> |
| <span class="sourceLineNo">246</span> /**<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * Decreases the reference count. If the reference count reached zero, the Disruptor and its associated thread are<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * shut down and their references set to {@code null}.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> */<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> @Override<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> final Disruptor<Log4jEventWrapper> temp = disruptor;<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> if (temp == null) {<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> LOGGER.trace("AsyncLoggerConfigDisruptor: disruptor for this configuration already shut down.");<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> return true; // disruptor was already shut down by another thread<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> }<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> setStopping();<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> LOGGER.trace("AsyncLoggerConfigDisruptor: shutting down disruptor for this configuration.");<a name="line.258"></a> |
| <span class="sourceLineNo">259</span><a name="line.259"></a> |
| <span class="sourceLineNo">260</span> // We must guarantee that publishing to the RingBuffer has stopped before we call disruptor.shutdown().<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> disruptor = null; // client code fails with NPE if log after stop = OK<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> // Calling Disruptor.shutdown() will wait until all enqueued events are fully processed,<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> // but this waiting happens in a busy-spin. To avoid (postpone) wasting CPU,<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> // we sleep in short chunks, up to 10 seconds, waiting for the ringbuffer to drain.<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> for (int i = 0; hasBacklog(temp) && i < MAX_DRAIN_ATTEMPTS_BEFORE_SHUTDOWN; i++) {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> try {<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> Thread.sleep(SLEEP_MILLIS_BETWEEN_DRAIN_ATTEMPTS); // give up the CPU for a while<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> } catch (final InterruptedException e) { // ignored<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> }<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> }<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> try {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> // busy-spins until all events currently in the disruptor have been processed, or timeout<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> temp.shutdown(timeout, timeUnit);<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> } catch (final TimeoutException e) {<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> LOGGER.warn("AsyncLoggerConfigDisruptor: shutdown timed out after {} {}", timeout, timeUnit);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> temp.halt(); // give up on remaining log events, if any<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> }<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> LOGGER.trace("AsyncLoggerConfigDisruptor: disruptor has been shut down.");<a name="line.279"></a> |
| <span class="sourceLineNo">280</span><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> if (DiscardingAsyncQueueFullPolicy.getDiscardCount(asyncQueueFullPolicy) > 0) {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> LOGGER.trace("AsyncLoggerConfigDisruptor: {} discarded {} events.", asyncQueueFullPolicy,<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> DiscardingAsyncQueueFullPolicy.getDiscardCount(asyncQueueFullPolicy));<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> }<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> setStopped();<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> return true;<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> }<a name="line.287"></a> |
| <span class="sourceLineNo">288</span><a name="line.288"></a> |
| <span class="sourceLineNo">289</span> /**<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * Returns {@code true} if the specified disruptor still has unprocessed events.<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> */<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> private static boolean hasBacklog(final Disruptor<?> theDisruptor) {<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> final RingBuffer<?> ringBuffer = theDisruptor.getRingBuffer();<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> return !ringBuffer.hasAvailableCapacity(ringBuffer.getBufferSize());<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> }<a name="line.295"></a> |
| <span class="sourceLineNo">296</span><a name="line.296"></a> |
| <span class="sourceLineNo">297</span> @Override<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> public EventRoute getEventRoute(final Level logLevel) {<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> final int remainingCapacity = remainingDisruptorCapacity();<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> if (remainingCapacity < 0) {<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> return EventRoute.DISCARD;<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> }<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> return asyncQueueFullPolicy.getRoute(backgroundThreadId, logLevel);<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> }<a name="line.304"></a> |
| <span class="sourceLineNo">305</span><a name="line.305"></a> |
| <span class="sourceLineNo">306</span> private int remainingDisruptorCapacity() {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> final Disruptor<Log4jEventWrapper> temp = disruptor;<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> if (hasLog4jBeenShutDown(temp)) {<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> return -1;<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> }<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> return (int) temp.getRingBuffer().remainingCapacity();<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> }<a name="line.312"></a> |
| <span class="sourceLineNo">313</span><a name="line.313"></a> |
| <span class="sourceLineNo">314</span> /**<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * Returns {@code true} if the specified disruptor is null.<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> */<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> private boolean hasLog4jBeenShutDown(final Disruptor<Log4jEventWrapper> aDisruptor) {<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> if (aDisruptor == null) { // LOG4J2-639<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> LOGGER.warn("Ignoring log event after log4j was shut down");<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> return true;<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> }<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> return false;<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> @Override<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> public void enqueueEvent(final LogEvent event, final AsyncLoggerConfig asyncLoggerConfig) {<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> // LOG4J2-639: catch NPE if disruptor field was set to null after our check above<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> try {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> final LogEvent logEvent = prepareEvent(event);<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> enqueue(logEvent, asyncLoggerConfig);<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> } catch (final NullPointerException npe) {<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> // Note: NPE prevents us from adding a log event to the disruptor after it was shut down,<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> // which could cause the publishEvent method to hang and never return.<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> LOGGER.warn("Ignoring log event after log4j was shut down: {} [{}] {}", event.getLevel(),<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> event.getLoggerName(), event.getMessage().getFormattedMessage()<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> + (event.getThrown() == null ? "" : Throwables.toStringList(event.getThrown())));<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> }<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> private LogEvent prepareEvent(final LogEvent event) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> LogEvent logEvent = ensureImmutable(event);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> if (logEvent.getMessage() instanceof ReusableMessage) {<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> if (logEvent instanceof Log4jLogEvent) {<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> ((Log4jLogEvent) logEvent).makeMessageImmutable();<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> } else if (logEvent instanceof MutableLogEvent) {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> // MutableLogEvents need to be translated into the RingBuffer by the MUTABLE_TRANSLATOR.<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> // That translator calls MutableLogEvent.initFrom to copy the event, which will makeMessageImmutable the message.<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> if (translator != MUTABLE_TRANSLATOR) { // should not happen...<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> // TRANSLATOR expects an immutable LogEvent<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> logEvent = ((MutableLogEvent) logEvent).createMemento();<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> }<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> } else { // custom log event, with a ReusableMessage<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> showWarningAboutCustomLogEventWithReusableMessage(logEvent);<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> }<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> } else { // message is not a ReusableMessage; makeMessageImmutable it to prevent ConcurrentModificationExceptions<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> InternalAsyncUtil.makeMessageImmutable(logEvent.getMessage()); // LOG4J2-1988, LOG4J2-1914<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> }<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> return logEvent;<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> }<a name="line.359"></a> |
| <span class="sourceLineNo">360</span><a name="line.360"></a> |
| <span class="sourceLineNo">361</span> private void showWarningAboutCustomLogEventWithReusableMessage(final LogEvent logEvent) {<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> if (!alreadyLoggedWarning) {<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> LOGGER.warn("Custom log event of type {} contains a mutable message of type {}." +<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> " AsyncLoggerConfig does not know how to make an immutable copy of this message." +<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> " This may result in ConcurrentModificationExceptions or incorrect log messages" +<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> " if the application modifies objects in the message while" +<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> " the background thread is writing it to the appenders.",<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> logEvent.getClass().getName(), logEvent.getMessage().getClass().getName());<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> alreadyLoggedWarning = true;<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> }<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> }<a name="line.371"></a> |
| <span class="sourceLineNo">372</span><a name="line.372"></a> |
| <span class="sourceLineNo">373</span> private void enqueue(final LogEvent logEvent, final AsyncLoggerConfig asyncLoggerConfig) {<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> if (synchronizeEnqueueWhenQueueFull()) {<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> synchronized (queueFullEnqueueLock) {<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> disruptor.getRingBuffer().publishEvent(translator, logEvent, asyncLoggerConfig);<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> }<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> } else {<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> disruptor.getRingBuffer().publishEvent(translator, logEvent, asyncLoggerConfig);<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> }<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> }<a name="line.381"></a> |
| <span class="sourceLineNo">382</span><a name="line.382"></a> |
| <span class="sourceLineNo">383</span> private boolean synchronizeEnqueueWhenQueueFull() {<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> return DisruptorUtil.ASYNC_CONFIG_SYNCHRONIZE_ENQUEUE_WHEN_QUEUE_FULL<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> // Background thread must never block<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> && backgroundThreadId != Thread.currentThread().getId();<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> }<a name="line.387"></a> |
| <span class="sourceLineNo">388</span><a name="line.388"></a> |
| <span class="sourceLineNo">389</span> @Override<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> public boolean tryEnqueue(final LogEvent event, final AsyncLoggerConfig asyncLoggerConfig) {<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> final LogEvent logEvent = prepareEvent(event);<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> return disruptor.getRingBuffer().tryPublishEvent(translator, logEvent, asyncLoggerConfig);<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> }<a name="line.393"></a> |
| <span class="sourceLineNo">394</span><a name="line.394"></a> |
| <span class="sourceLineNo">395</span> private LogEvent ensureImmutable(final LogEvent event) {<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> LogEvent result = event;<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> if (event instanceof RingBufferLogEvent) {<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> // Deal with special case where both types of Async Loggers are used together:<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> // RingBufferLogEvents are created by the all-loggers-async type, but<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> // this event is also consumed by the some-loggers-async type (this class).<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> // The original event will be re-used and modified in an application thread later,<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> // so take a snapshot of it, which can be safely processed in the<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> // some-loggers-async background thread.<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> result = ((RingBufferLogEvent) event).createMemento();<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> return result;<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> }<a name="line.407"></a> |
| <span class="sourceLineNo">408</span><a name="line.408"></a> |
| <span class="sourceLineNo">409</span> /*<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * (non-Javadoc)<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> *<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> * @see org.apache.logging.log4j.core.async.AsyncLoggerConfigDelegate#createRingBufferAdmin(java.lang.String,<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> * java.lang.String)<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> */<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> @Override<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> public RingBufferAdmin createRingBufferAdmin(final String contextName, final String loggerConfigName) {<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> return RingBufferAdmin.forAsyncLoggerConfig(disruptor.getRingBuffer(), contextName, loggerConfigName);<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> }<a name="line.418"></a> |
| <span class="sourceLineNo">419</span>}<a name="line.419"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
