blob: 516352e14a408edff37ae919002329227d01103b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one 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.status;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.Closeable;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Queue;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.ConcurrentLinkedQueue;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.CopyOnWriteArrayList;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.concurrent.locks.Lock;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.concurrent.locks.ReadWriteLock;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.concurrent.locks.ReentrantLock;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.concurrent.locks.ReentrantReadWriteLock;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.Level;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.Marker;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.message.Message;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.message.MessageFactory;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.message.ParameterizedNoReferenceMessageFactory;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.logging.log4j.simple.SimpleLogger;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.logging.log4j.simple.SimpleLoggerContext;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.logging.log4j.spi.AbstractLogger;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.logging.log4j.util.Constants;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.logging.log4j.util.Strings;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>/**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Records events that occur in the logging system. By default, only error messages are logged to {@link System#err}.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * Normally, the Log4j StatusLogger is configured via the root {@code &lt;Configuration status="LEVEL"/&gt;} node in a Log4j<a name="line.46"></a>
<span class="sourceLineNo">047</span> * configuration file. However, this can be overridden via a system property named<a name="line.47"></a>
<span class="sourceLineNo">048</span> * "{@value SimpleLoggerContext#SYSTEM_PREFIX}StatusLogger.level" and will work with any Log4j provider.<a name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @see SimpleLogger<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @see SimpleLoggerContext<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span>public final class StatusLogger extends AbstractLogger {<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * System property that can be configured with the number of entries in the queue. Once the limit is reached older<a name="line.56"></a>
<span class="sourceLineNo">057</span> * entries will be removed as new entries are added.<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> public static final String MAX_STATUS_ENTRIES = "log4j2.status.entries";<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * System property that can be configured with the {@link Level} name to use as the default level for<a name="line.62"></a>
<span class="sourceLineNo">063</span> * {@link StatusListener}s.<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> public static final String DEFAULT_STATUS_LISTENER_LEVEL = "log4j2.StatusLogger.level";<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * System property that can be configured with a date-time format string to use as the format for timestamps<a name="line.68"></a>
<span class="sourceLineNo">069</span> * in the status logger output. See {@link java.text.SimpleDateFormat} for supported formats.<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @since 2.11.0<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> public static final String STATUS_DATE_FORMAT = "log4j2.StatusLogger.DateFormat";<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> private static final long serialVersionUID = 2L;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> private static final String NOT_AVAIL = "?";<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> private static final PropertiesUtil PROPS = new PropertiesUtil("log4j2.StatusLogger.properties");<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> private static final int MAX_ENTRIES = PROPS.getIntegerProperty(MAX_STATUS_ENTRIES, 200);<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> private static final String DEFAULT_STATUS_LEVEL = PROPS.getStringProperty(DEFAULT_STATUS_LISTENER_LEVEL);<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> // LOG4J2-1176: normal parameterized message remembers param object, causing memory leaks.<a name="line.84"></a>
<span class="sourceLineNo">085</span> private static final StatusLogger STATUS_LOGGER = new StatusLogger(StatusLogger.class.getName(),<a name="line.85"></a>
<span class="sourceLineNo">086</span> ParameterizedNoReferenceMessageFactory.INSTANCE);<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> private final SimpleLogger logger;<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> private final Collection&lt;StatusListener&gt; listeners = new CopyOnWriteArrayList&lt;&gt;();<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> @SuppressWarnings("NonSerializableFieldInSerializableClass")<a name="line.92"></a>
<span class="sourceLineNo">093</span> // ReentrantReadWriteLock is Serializable<a name="line.93"></a>
<span class="sourceLineNo">094</span> private final ReadWriteLock listenersLock = new ReentrantReadWriteLock();<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> private final Queue&lt;StatusData&gt; messages = new BoundedQueue&lt;&gt;(MAX_ENTRIES);<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> @SuppressWarnings("NonSerializableFieldInSerializableClass")<a name="line.98"></a>
<span class="sourceLineNo">099</span> // ReentrantLock is Serializable<a name="line.99"></a>
<span class="sourceLineNo">100</span> private final Lock msgLock = new ReentrantLock();<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> private int listenersLevel;<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> private StatusLogger(final String name, final MessageFactory messageFactory) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> super(name, messageFactory);<a name="line.105"></a>
<span class="sourceLineNo">106</span> final String dateFormat = PROPS.getStringProperty(STATUS_DATE_FORMAT, Strings.EMPTY);<a name="line.106"></a>
<span class="sourceLineNo">107</span> final boolean showDateTime = !Strings.isEmpty(dateFormat);<a name="line.107"></a>
<span class="sourceLineNo">108</span> this.logger = new SimpleLogger("StatusLogger", Level.ERROR, false, true, showDateTime, false,<a name="line.108"></a>
<span class="sourceLineNo">109</span> dateFormat, messageFactory, PROPS, System.err);<a name="line.109"></a>
<span class="sourceLineNo">110</span> this.listenersLevel = Level.toLevel(DEFAULT_STATUS_LEVEL, Level.WARN).intLevel();<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> // LOG4J2-1813 if system property "log4j2.debug" is defined, print all status logging<a name="line.112"></a>
<span class="sourceLineNo">113</span> if (isDebugPropertyEnabled()) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> logger.setLevel(Level.TRACE);<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> // LOG4J2-1813 if system property "log4j2.debug" is defined, print all status logging<a name="line.118"></a>
<span class="sourceLineNo">119</span> private boolean isDebugPropertyEnabled() {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return PropertiesUtil.getProperties().getBooleanProperty(Constants.LOG4J2_DEBUG, false, true);<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> /**<a name="line.123"></a>
<span class="sourceLineNo">124</span> * Retrieve the StatusLogger.<a name="line.124"></a>
<span class="sourceLineNo">125</span> *<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @return The StatusLogger.<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> public static StatusLogger getLogger() {<a name="line.128"></a>
<span class="sourceLineNo">129</span> return STATUS_LOGGER;<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> public void setLevel(final Level level) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> logger.setLevel(level);<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> /**<a name="line.136"></a>
<span class="sourceLineNo">137</span> * Registers a new listener.<a name="line.137"></a>
<span class="sourceLineNo">138</span> *<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @param listener The StatusListener to register.<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> public void registerListener(final StatusListener listener) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> listenersLock.writeLock().lock();<a name="line.142"></a>
<span class="sourceLineNo">143</span> try {<a name="line.143"></a>
<span class="sourceLineNo">144</span> listeners.add(listener);<a name="line.144"></a>
<span class="sourceLineNo">145</span> final Level lvl = listener.getStatusLevel();<a name="line.145"></a>
<span class="sourceLineNo">146</span> if (listenersLevel &lt; lvl.intLevel()) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> listenersLevel = lvl.intLevel();<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span> } finally {<a name="line.149"></a>
<span class="sourceLineNo">150</span> listenersLock.writeLock().unlock();<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><a name="line.153"></a>
<span class="sourceLineNo">154</span> /**<a name="line.154"></a>
<span class="sourceLineNo">155</span> * Removes a StatusListener.<a name="line.155"></a>
<span class="sourceLineNo">156</span> *<a name="line.156"></a>
<span class="sourceLineNo">157</span> * @param listener The StatusListener to remove.<a name="line.157"></a>
<span class="sourceLineNo">158</span> */<a name="line.158"></a>
<span class="sourceLineNo">159</span> public void removeListener(final StatusListener listener) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> closeSilently(listener);<a name="line.160"></a>
<span class="sourceLineNo">161</span> listenersLock.writeLock().lock();<a name="line.161"></a>
<span class="sourceLineNo">162</span> try {<a name="line.162"></a>
<span class="sourceLineNo">163</span> listeners.remove(listener);<a name="line.163"></a>
<span class="sourceLineNo">164</span> int lowest = Level.toLevel(DEFAULT_STATUS_LEVEL, Level.WARN).intLevel();<a name="line.164"></a>
<span class="sourceLineNo">165</span> for (final StatusListener statusListener : listeners) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> final int level = statusListener.getStatusLevel().intLevel();<a name="line.166"></a>
<span class="sourceLineNo">167</span> if (lowest &lt; level) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> lowest = level;<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span> listenersLevel = lowest;<a name="line.171"></a>
<span class="sourceLineNo">172</span> } finally {<a name="line.172"></a>
<span class="sourceLineNo">173</span> listenersLock.writeLock().unlock();<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> public void updateListenerLevel(final Level status) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> if (status.intLevel() &gt; listenersLevel) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> listenersLevel = status.intLevel();<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><a name="line.182"></a>
<span class="sourceLineNo">183</span> /**<a name="line.183"></a>
<span class="sourceLineNo">184</span> * Returns a thread safe Iterable for the StatusListener.<a name="line.184"></a>
<span class="sourceLineNo">185</span> *<a name="line.185"></a>
<span class="sourceLineNo">186</span> * @return An Iterable for the list of StatusListeners.<a name="line.186"></a>
<span class="sourceLineNo">187</span> */<a name="line.187"></a>
<span class="sourceLineNo">188</span> public Iterable&lt;StatusListener&gt; getListeners() {<a name="line.188"></a>
<span class="sourceLineNo">189</span> return listeners;<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> /**<a name="line.192"></a>
<span class="sourceLineNo">193</span> * Clears the list of status events and listeners.<a name="line.193"></a>
<span class="sourceLineNo">194</span> */<a name="line.194"></a>
<span class="sourceLineNo">195</span> public void reset() {<a name="line.195"></a>
<span class="sourceLineNo">196</span> listenersLock.writeLock().lock();<a name="line.196"></a>
<span class="sourceLineNo">197</span> try {<a name="line.197"></a>
<span class="sourceLineNo">198</span> for (final StatusListener listener : listeners) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> closeSilently(listener);<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span> } finally {<a name="line.201"></a>
<span class="sourceLineNo">202</span> listeners.clear();<a name="line.202"></a>
<span class="sourceLineNo">203</span> listenersLock.writeLock().unlock();<a name="line.203"></a>
<span class="sourceLineNo">204</span> // note this should certainly come after the unlock to avoid unnecessary nested locking<a name="line.204"></a>
<span class="sourceLineNo">205</span> clear();<a name="line.205"></a>
<span class="sourceLineNo">206</span> }<a name="line.206"></a>
<span class="sourceLineNo">207</span> }<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> private static void closeSilently(final Closeable resource) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> try {<a name="line.210"></a>
<span class="sourceLineNo">211</span> resource.close();<a name="line.211"></a>
<span class="sourceLineNo">212</span> } catch (final IOException ignored) {<a name="line.212"></a>
<span class="sourceLineNo">213</span> // ignored<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span> /**<a name="line.217"></a>
<span class="sourceLineNo">218</span> * Returns a List of all events as StatusData objects.<a name="line.218"></a>
<span class="sourceLineNo">219</span> *<a name="line.219"></a>
<span class="sourceLineNo">220</span> * @return The list of StatusData objects.<a name="line.220"></a>
<span class="sourceLineNo">221</span> */<a name="line.221"></a>
<span class="sourceLineNo">222</span> public List&lt;StatusData&gt; getStatusData() {<a name="line.222"></a>
<span class="sourceLineNo">223</span> msgLock.lock();<a name="line.223"></a>
<span class="sourceLineNo">224</span> try {<a name="line.224"></a>
<span class="sourceLineNo">225</span> return new ArrayList&lt;&gt;(messages);<a name="line.225"></a>
<span class="sourceLineNo">226</span> } finally {<a name="line.226"></a>
<span class="sourceLineNo">227</span> msgLock.unlock();<a name="line.227"></a>
<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span> /**<a name="line.231"></a>
<span class="sourceLineNo">232</span> * Clears the list of status events.<a name="line.232"></a>
<span class="sourceLineNo">233</span> */<a name="line.233"></a>
<span class="sourceLineNo">234</span> public void clear() {<a name="line.234"></a>
<span class="sourceLineNo">235</span> msgLock.lock();<a name="line.235"></a>
<span class="sourceLineNo">236</span> try {<a name="line.236"></a>
<span class="sourceLineNo">237</span> messages.clear();<a name="line.237"></a>
<span class="sourceLineNo">238</span> } finally {<a name="line.238"></a>
<span class="sourceLineNo">239</span> msgLock.unlock();<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> @Override<a name="line.243"></a>
<span class="sourceLineNo">244</span> public Level getLevel() {<a name="line.244"></a>
<span class="sourceLineNo">245</span> return logger.getLevel();<a name="line.245"></a>
<span class="sourceLineNo">246</span> }<a name="line.246"></a>
<span class="sourceLineNo">247</span><a name="line.247"></a>
<span class="sourceLineNo">248</span> /**<a name="line.248"></a>
<span class="sourceLineNo">249</span> * Adds an event.<a name="line.249"></a>
<span class="sourceLineNo">250</span> *<a name="line.250"></a>
<span class="sourceLineNo">251</span> * @param marker The Marker<a name="line.251"></a>
<span class="sourceLineNo">252</span> * @param fqcn The fully qualified class name of the &lt;b&gt;caller&lt;/b&gt;<a name="line.252"></a>
<span class="sourceLineNo">253</span> * @param level The logging level<a name="line.253"></a>
<span class="sourceLineNo">254</span> * @param msg The message associated with the event.<a name="line.254"></a>
<span class="sourceLineNo">255</span> * @param t A Throwable or null.<a name="line.255"></a>
<span class="sourceLineNo">256</span> */<a name="line.256"></a>
<span class="sourceLineNo">257</span> @Override<a name="line.257"></a>
<span class="sourceLineNo">258</span> public void logMessage(final String fqcn, final Level level, final Marker marker, final Message msg,<a name="line.258"></a>
<span class="sourceLineNo">259</span> final Throwable t) {<a name="line.259"></a>
<span class="sourceLineNo">260</span> StackTraceElement element = null;<a name="line.260"></a>
<span class="sourceLineNo">261</span> if (fqcn != null) {<a name="line.261"></a>
<span class="sourceLineNo">262</span> element = getStackTraceElement(fqcn, Thread.currentThread().getStackTrace());<a name="line.262"></a>
<span class="sourceLineNo">263</span> }<a name="line.263"></a>
<span class="sourceLineNo">264</span> final StatusData data = new StatusData(element, level, msg, t, null);<a name="line.264"></a>
<span class="sourceLineNo">265</span> msgLock.lock();<a name="line.265"></a>
<span class="sourceLineNo">266</span> try {<a name="line.266"></a>
<span class="sourceLineNo">267</span> messages.add(data);<a name="line.267"></a>
<span class="sourceLineNo">268</span> } finally {<a name="line.268"></a>
<span class="sourceLineNo">269</span> msgLock.unlock();<a name="line.269"></a>
<span class="sourceLineNo">270</span> }<a name="line.270"></a>
<span class="sourceLineNo">271</span> // LOG4J2-1813 if system property "log4j2.debug" is defined, all status logging is enabled<a name="line.271"></a>
<span class="sourceLineNo">272</span> if (isDebugPropertyEnabled()) {<a name="line.272"></a>
<span class="sourceLineNo">273</span> logger.logMessage(fqcn, level, marker, msg, t);<a name="line.273"></a>
<span class="sourceLineNo">274</span> } else {<a name="line.274"></a>
<span class="sourceLineNo">275</span> if (listeners.size() &gt; 0) {<a name="line.275"></a>
<span class="sourceLineNo">276</span> for (final StatusListener listener : listeners) {<a name="line.276"></a>
<span class="sourceLineNo">277</span> if (data.getLevel().isMoreSpecificThan(listener.getStatusLevel())) {<a name="line.277"></a>
<span class="sourceLineNo">278</span> listener.log(data);<a name="line.278"></a>
<span class="sourceLineNo">279</span> }<a name="line.279"></a>
<span class="sourceLineNo">280</span> }<a name="line.280"></a>
<span class="sourceLineNo">281</span> } else {<a name="line.281"></a>
<span class="sourceLineNo">282</span> logger.logMessage(fqcn, level, marker, msg, t);<a name="line.282"></a>
<span class="sourceLineNo">283</span> }<a name="line.283"></a>
<span class="sourceLineNo">284</span> }<a name="line.284"></a>
<span class="sourceLineNo">285</span> }<a name="line.285"></a>
<span class="sourceLineNo">286</span><a name="line.286"></a>
<span class="sourceLineNo">287</span> private StackTraceElement getStackTraceElement(final String fqcn, final StackTraceElement[] stackTrace) {<a name="line.287"></a>
<span class="sourceLineNo">288</span> if (fqcn == null) {<a name="line.288"></a>
<span class="sourceLineNo">289</span> return null;<a name="line.289"></a>
<span class="sourceLineNo">290</span> }<a name="line.290"></a>
<span class="sourceLineNo">291</span> boolean next = false;<a name="line.291"></a>
<span class="sourceLineNo">292</span> for (final StackTraceElement element : stackTrace) {<a name="line.292"></a>
<span class="sourceLineNo">293</span> final String className = element.getClassName();<a name="line.293"></a>
<span class="sourceLineNo">294</span> if (next &amp;&amp; !fqcn.equals(className)) {<a name="line.294"></a>
<span class="sourceLineNo">295</span> return element;<a name="line.295"></a>
<span class="sourceLineNo">296</span> }<a name="line.296"></a>
<span class="sourceLineNo">297</span> if (fqcn.equals(className)) {<a name="line.297"></a>
<span class="sourceLineNo">298</span> next = true;<a name="line.298"></a>
<span class="sourceLineNo">299</span> } else if (NOT_AVAIL.equals(className)) {<a name="line.299"></a>
<span class="sourceLineNo">300</span> break;<a name="line.300"></a>
<span class="sourceLineNo">301</span> }<a name="line.301"></a>
<span class="sourceLineNo">302</span> }<a name="line.302"></a>
<span class="sourceLineNo">303</span> return null;<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> @Override<a name="line.306"></a>
<span class="sourceLineNo">307</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Throwable t) {<a name="line.307"></a>
<span class="sourceLineNo">308</span> return isEnabled(level, marker);<a name="line.308"></a>
<span class="sourceLineNo">309</span> }<a name="line.309"></a>
<span class="sourceLineNo">310</span><a name="line.310"></a>
<span class="sourceLineNo">311</span> @Override<a name="line.311"></a>
<span class="sourceLineNo">312</span> public boolean isEnabled(final Level level, final Marker marker, final String message) {<a name="line.312"></a>
<span class="sourceLineNo">313</span> return isEnabled(level, marker);<a name="line.313"></a>
<span class="sourceLineNo">314</span> }<a name="line.314"></a>
<span class="sourceLineNo">315</span><a name="line.315"></a>
<span class="sourceLineNo">316</span> @Override<a name="line.316"></a>
<span class="sourceLineNo">317</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object... params) {<a name="line.317"></a>
<span class="sourceLineNo">318</span> return isEnabled(level, marker);<a name="line.318"></a>
<span class="sourceLineNo">319</span> }<a name="line.319"></a>
<span class="sourceLineNo">320</span><a name="line.320"></a>
<span class="sourceLineNo">321</span> @Override<a name="line.321"></a>
<span class="sourceLineNo">322</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0) {<a name="line.322"></a>
<span class="sourceLineNo">323</span> return isEnabled(level, marker);<a name="line.323"></a>
<span class="sourceLineNo">324</span> }<a name="line.324"></a>
<span class="sourceLineNo">325</span><a name="line.325"></a>
<span class="sourceLineNo">326</span> @Override<a name="line.326"></a>
<span class="sourceLineNo">327</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0,<a name="line.327"></a>
<span class="sourceLineNo">328</span> final Object p1) {<a name="line.328"></a>
<span class="sourceLineNo">329</span> return isEnabled(level, marker);<a name="line.329"></a>
<span class="sourceLineNo">330</span> }<a name="line.330"></a>
<span class="sourceLineNo">331</span><a name="line.331"></a>
<span class="sourceLineNo">332</span> @Override<a name="line.332"></a>
<span class="sourceLineNo">333</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0,<a name="line.333"></a>
<span class="sourceLineNo">334</span> final Object p1, final Object p2) {<a name="line.334"></a>
<span class="sourceLineNo">335</span> return isEnabled(level, marker);<a name="line.335"></a>
<span class="sourceLineNo">336</span> }<a name="line.336"></a>
<span class="sourceLineNo">337</span><a name="line.337"></a>
<span class="sourceLineNo">338</span> @Override<a name="line.338"></a>
<span class="sourceLineNo">339</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0,<a name="line.339"></a>
<span class="sourceLineNo">340</span> final Object p1, final Object p2, final Object p3) {<a name="line.340"></a>
<span class="sourceLineNo">341</span> return isEnabled(level, marker);<a name="line.341"></a>
<span class="sourceLineNo">342</span> }<a name="line.342"></a>
<span class="sourceLineNo">343</span><a name="line.343"></a>
<span class="sourceLineNo">344</span> @Override<a name="line.344"></a>
<span class="sourceLineNo">345</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0,<a name="line.345"></a>
<span class="sourceLineNo">346</span> final Object p1, final Object p2, final Object p3,<a name="line.346"></a>
<span class="sourceLineNo">347</span> final Object p4) {<a name="line.347"></a>
<span class="sourceLineNo">348</span> return isEnabled(level, marker);<a name="line.348"></a>
<span class="sourceLineNo">349</span> }<a name="line.349"></a>
<span class="sourceLineNo">350</span><a name="line.350"></a>
<span class="sourceLineNo">351</span> @Override<a name="line.351"></a>
<span class="sourceLineNo">352</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0,<a name="line.352"></a>
<span class="sourceLineNo">353</span> final Object p1, final Object p2, final Object p3,<a name="line.353"></a>
<span class="sourceLineNo">354</span> final Object p4, final Object p5) {<a name="line.354"></a>
<span class="sourceLineNo">355</span> return isEnabled(level, marker);<a name="line.355"></a>
<span class="sourceLineNo">356</span> }<a name="line.356"></a>
<span class="sourceLineNo">357</span><a name="line.357"></a>
<span class="sourceLineNo">358</span> @Override<a name="line.358"></a>
<span class="sourceLineNo">359</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0,<a name="line.359"></a>
<span class="sourceLineNo">360</span> final Object p1, final Object p2, final Object p3,<a name="line.360"></a>
<span class="sourceLineNo">361</span> final Object p4, final Object p5, final Object p6) {<a name="line.361"></a>
<span class="sourceLineNo">362</span> return isEnabled(level, marker);<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> @Override<a name="line.365"></a>
<span class="sourceLineNo">366</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0,<a name="line.366"></a>
<span class="sourceLineNo">367</span> final Object p1, final Object p2, final Object p3,<a name="line.367"></a>
<span class="sourceLineNo">368</span> final Object p4, final Object p5, final Object p6,<a name="line.368"></a>
<span class="sourceLineNo">369</span> final Object p7) {<a name="line.369"></a>
<span class="sourceLineNo">370</span> return isEnabled(level, marker);<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> @Override<a name="line.373"></a>
<span class="sourceLineNo">374</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0,<a name="line.374"></a>
<span class="sourceLineNo">375</span> final Object p1, final Object p2, final Object p3,<a name="line.375"></a>
<span class="sourceLineNo">376</span> final Object p4, final Object p5, final Object p6,<a name="line.376"></a>
<span class="sourceLineNo">377</span> final Object p7, final Object p8) {<a name="line.377"></a>
<span class="sourceLineNo">378</span> return isEnabled(level, marker);<a name="line.378"></a>
<span class="sourceLineNo">379</span> }<a name="line.379"></a>
<span class="sourceLineNo">380</span><a name="line.380"></a>
<span class="sourceLineNo">381</span> @Override<a name="line.381"></a>
<span class="sourceLineNo">382</span> public boolean isEnabled(final Level level, final Marker marker, final String message, final Object p0,<a name="line.382"></a>
<span class="sourceLineNo">383</span> final Object p1, final Object p2, final Object p3,<a name="line.383"></a>
<span class="sourceLineNo">384</span> final Object p4, final Object p5, final Object p6,<a name="line.384"></a>
<span class="sourceLineNo">385</span> final Object p7, final Object p8, final Object p9) {<a name="line.385"></a>
<span class="sourceLineNo">386</span> return isEnabled(level, marker);<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 isEnabled(final Level level, final Marker marker, final CharSequence message, final Throwable t) {<a name="line.390"></a>
<span class="sourceLineNo">391</span> return isEnabled(level, marker);<a name="line.391"></a>
<span class="sourceLineNo">392</span> }<a name="line.392"></a>
<span class="sourceLineNo">393</span><a name="line.393"></a>
<span class="sourceLineNo">394</span> @Override<a name="line.394"></a>
<span class="sourceLineNo">395</span> public boolean isEnabled(final Level level, final Marker marker, final Object message, final Throwable t) {<a name="line.395"></a>
<span class="sourceLineNo">396</span> return isEnabled(level, marker);<a name="line.396"></a>
<span class="sourceLineNo">397</span> }<a name="line.397"></a>
<span class="sourceLineNo">398</span><a name="line.398"></a>
<span class="sourceLineNo">399</span> @Override<a name="line.399"></a>
<span class="sourceLineNo">400</span> public boolean isEnabled(final Level level, final Marker marker, final Message message, final Throwable t) {<a name="line.400"></a>
<span class="sourceLineNo">401</span> return isEnabled(level, marker);<a name="line.401"></a>
<span class="sourceLineNo">402</span> }<a name="line.402"></a>
<span class="sourceLineNo">403</span><a name="line.403"></a>
<span class="sourceLineNo">404</span> @Override<a name="line.404"></a>
<span class="sourceLineNo">405</span> public boolean isEnabled(final Level level, final Marker marker) {<a name="line.405"></a>
<span class="sourceLineNo">406</span> // LOG4J2-1813 if system property "log4j2.debug" is defined, all status logging is enabled<a name="line.406"></a>
<span class="sourceLineNo">407</span> if (isDebugPropertyEnabled()) {<a name="line.407"></a>
<span class="sourceLineNo">408</span> return true;<a name="line.408"></a>
<span class="sourceLineNo">409</span> }<a name="line.409"></a>
<span class="sourceLineNo">410</span> if (listeners.size() &gt; 0) {<a name="line.410"></a>
<span class="sourceLineNo">411</span> return listenersLevel &gt;= level.intLevel();<a name="line.411"></a>
<span class="sourceLineNo">412</span> }<a name="line.412"></a>
<span class="sourceLineNo">413</span> return logger.isEnabled(level, marker);<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> /**<a name="line.416"></a>
<span class="sourceLineNo">417</span> * Queues for status events.<a name="line.417"></a>
<span class="sourceLineNo">418</span> *<a name="line.418"></a>
<span class="sourceLineNo">419</span> * @param &lt;E&gt; Object type to be stored in the queue.<a name="line.419"></a>
<span class="sourceLineNo">420</span> */<a name="line.420"></a>
<span class="sourceLineNo">421</span> private class BoundedQueue&lt;E&gt; extends ConcurrentLinkedQueue&lt;E&gt; {<a name="line.421"></a>
<span class="sourceLineNo">422</span><a name="line.422"></a>
<span class="sourceLineNo">423</span> private static final long serialVersionUID = -3945953719763255337L;<a name="line.423"></a>
<span class="sourceLineNo">424</span><a name="line.424"></a>
<span class="sourceLineNo">425</span> private final int size;<a name="line.425"></a>
<span class="sourceLineNo">426</span><a name="line.426"></a>
<span class="sourceLineNo">427</span> BoundedQueue(final int size) {<a name="line.427"></a>
<span class="sourceLineNo">428</span> this.size = size;<a name="line.428"></a>
<span class="sourceLineNo">429</span> }<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> @Override<a name="line.431"></a>
<span class="sourceLineNo">432</span> public boolean add(final E object) {<a name="line.432"></a>
<span class="sourceLineNo">433</span> super.add(object);<a name="line.433"></a>
<span class="sourceLineNo">434</span> while (messages.size() &gt; size) {<a name="line.434"></a>
<span class="sourceLineNo">435</span> messages.poll();<a name="line.435"></a>
<span class="sourceLineNo">436</span> }<a name="line.436"></a>
<span class="sourceLineNo">437</span> return size &gt; 0;<a name="line.437"></a>
<span class="sourceLineNo">438</span> }<a name="line.438"></a>
<span class="sourceLineNo">439</span> }<a name="line.439"></a>
<span class="sourceLineNo">440</span>}<a name="line.440"></a>
</pre>
</div>
</body>
</html>