| <!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><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.filter;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.Queue;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.concurrent.ConcurrentLinkedQueue;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.concurrent.DelayQueue;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.concurrent.Delayed;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.concurrent.TimeUnit;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.Level;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.Marker;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.Filter;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.Logger;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.Node;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.message.Message;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * The <code>BurstFilter</code> is a logging filter that regulates logging traffic.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> *<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * Use this filter when you want to control the maximum burst of log statements that can be sent to an appender. The<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * filter is configured in the log4j configuration file. For example, the following configuration limits the number of<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * INFO level (as well as DEBUG and TRACE) log statements that can be sent to the console to a burst of 100 with an<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * average rate of 16 per second. WARN, ERROR and FATAL messages would continue to be delivered.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * </p><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <code><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * &lt;Console name="console"&gt;<br><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * &nbsp;&lt;PatternLayout pattern="%-5p %d{dd-MMM-yyyy HH:mm:ss} %x %t %m%n"/&gt;<br><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * &nbsp;&lt;filters&gt;<br><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * &nbsp;&nbsp;&lt;Burst level="INFO" rate="16" maxBurst="100"/&gt;<br><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * &nbsp;&lt;/filters&gt;<br><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * &lt;/Console&gt;<br><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * </code><br><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>@Plugin(name = "BurstFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>public final class BurstFilter extends AbstractFilter {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private static final long NANOS_IN_SECONDS = 1000000000;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private static final int DEFAULT_RATE = 10;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private static final int DEFAULT_RATE_MULTIPLE = 100;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private static final int HASH_SHIFT = 32;<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> * Level of messages to be filtered. Anything at or below this level will be<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * filtered out if <code>maxBurst</code> has been exceeded. The default is<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * WARN meaning any messages that are higher than warn will be logged<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * regardless of the size of a burst.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private final Level level;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> private final long burstInterval;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> private final DelayQueue<LogDelay> history = new DelayQueue<>();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> private final Queue<LogDelay> available = new ConcurrentLinkedQueue<>();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> static LogDelay createLogDelay(final long expireTime) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> return new LogDelay(expireTime);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> private BurstFilter(final Level level, final float rate, final long maxBurst, final Result onMatch,<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> final Result onMismatch) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> super(onMatch, onMismatch);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> this.level = level;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> this.burstInterval = (long) (NANOS_IN_SECONDS * (maxBurst / rate));<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> for (int i = 0; i < maxBurst; ++i) {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> available.add(createLogDelay(0));<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> @Override<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> final Object... params) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return filter(level);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> @Override<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> public Result filter(final Logger logger, final Level level, final Marker marker, final Object msg,<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> final Throwable t) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> return filter(level);<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 Result filter(final Logger logger, final Level level, final Marker marker, final Message msg,<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> final Throwable t) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> return filter(level);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> @Override<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> public Result filter(final LogEvent event) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return filter(event.getLevel());<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> @Override<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> final Object p0) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> return filter(level);<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> @Override<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> final Object p0, final Object p1) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> return filter(level);<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> @Override<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> final Object p0, final Object p1, final Object p2) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> return filter(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> @Override<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> final Object p0, final Object p1, final Object p2, final Object p3) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> return filter(level);<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> @Override<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> final Object p0, final Object p1, final Object p2, final Object p3,<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> final Object p4) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> return filter(level);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> @Override<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> final Object p0, final Object p1, final Object p2, final Object p3,<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> final Object p4, final Object p5) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> return filter(level);<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> @Override<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> final Object p0, final Object p1, final Object p2, final Object p3,<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> final Object p4, final Object p5, final Object p6) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return filter(level);<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> @Override<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> final Object p0, final Object p1, final Object p2, final Object p3,<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> final Object p4, final Object p5, final Object p6,<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> final Object p7) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> return filter(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> @Override<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> final Object p0, final Object p1, final Object p2, final Object p3,<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> final Object p4, final Object p5, final Object p6,<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> final Object p7, final Object p8) {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> return filter(level);<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> @Override<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> final Object p0, final Object p1, final Object p2, final Object p3,<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> final Object p4, final Object p5, final Object p6,<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> final Object p7, final Object p8, final Object p9) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> return filter(level);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<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> * Decide if we're going to log <code>event</code> based on whether the<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * maximum burst of log statements has been exceeded.<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> *<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * @param level The log level.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @return The onMatch value if the filter passes, onMismatch otherwise.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> */<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> private Result filter(final Level level) {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> if (this.level.isMoreSpecificThan(level)) {<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> LogDelay delay = history.poll();<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> while (delay != null) {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> available.add(delay);<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> delay = history.poll();<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> delay = available.poll();<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> if (delay != null) {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> delay.setDelay(burstInterval);<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> history.add(delay);<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> return onMatch;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> return onMismatch;<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> return onMatch;<a name="line.209"></a> |
| <span class="sourceLineNo">210</span><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> * Returns the number of available slots. Used for unit testing.<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * @return The number of available slots.<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> */<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> public int getAvailable() {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> return available.size();<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> /**<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * Clear the history. Used for unit testing.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> */<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> public void clear() {<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> for (final LogDelay delay : history) {<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> history.remove(delay);<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> available.add(delay);<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> @Override<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> public String toString() {<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> return "level=" + level.toString() + ", interval=" + burstInterval + ", max=" + history.size();<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> /**<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * Delay object to represent each log event that has occurred within the timespan.<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> *<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * Consider this class private, package visibility for testing.<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> */<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> private static class LogDelay implements Delayed {<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> LogDelay(final long expireTime) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> this.expireTime = expireTime;<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> private long expireTime;<a name="line.247"></a> |
| <span class="sourceLineNo">248</span><a name="line.248"></a> |
| <span class="sourceLineNo">249</span> public void setDelay(final long delay) {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> this.expireTime = delay + System.nanoTime();<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> @Override<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> public long getDelay(final TimeUnit timeUnit) {<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> return timeUnit.convert(expireTime - System.nanoTime(), TimeUnit.NANOSECONDS);<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> }<a name="line.256"></a> |
| <span class="sourceLineNo">257</span><a name="line.257"></a> |
| <span class="sourceLineNo">258</span> @Override<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> public int compareTo(final Delayed delayed) {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> final long diff = this.expireTime - ((LogDelay) delayed).expireTime;<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> return Long.signum(diff);<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span><a name="line.263"></a> |
| <span class="sourceLineNo">264</span> @Override<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> public boolean equals(final Object o) {<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> if (this == o) {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> return true;<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> if (o == null || getClass() != o.getClass()) {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> return false;<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> }<a name="line.271"></a> |
| <span class="sourceLineNo">272</span><a name="line.272"></a> |
| <span class="sourceLineNo">273</span> final LogDelay logDelay = (LogDelay) o;<a name="line.273"></a> |
| <span class="sourceLineNo">274</span><a name="line.274"></a> |
| <span class="sourceLineNo">275</span> if (expireTime != logDelay.expireTime) {<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> return false;<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> return true;<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> }<a name="line.280"></a> |
| <span class="sourceLineNo">281</span><a name="line.281"></a> |
| <span class="sourceLineNo">282</span> @Override<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> public int hashCode() {<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> return (int) (expireTime ^ (expireTime >>> HASH_SHIFT));<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><a name="line.287"></a> |
| <span class="sourceLineNo">288</span> @PluginBuilderFactory<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> public static Builder newBuilder() {<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> return new Builder();<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> }<a name="line.291"></a> |
| <span class="sourceLineNo">292</span><a name="line.292"></a> |
| <span class="sourceLineNo">293</span> public static class Builder extends AbstractFilterBuilder<Builder> implements org.apache.logging.log4j.core.util.Builder<BurstFilter> {<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 Level level = Level.WARN;<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 float rate = DEFAULT_RATE;<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 long maxBurst;<a name="line.302"></a> |
| <span class="sourceLineNo">303</span><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> /**<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * Sets the logging level to use.<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * @param level the logging level to use.<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * @return this<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> */<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> public Builder setLevel(final Level level) {<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> this.level = level;<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> return this;<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> * Sets the average number of events per second to allow.<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * @param rate the average number of events per second to allow. This must be a positive number.<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * @return this<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> */<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> public Builder setRate(final float rate) {<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> this.rate = rate;<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> return this;<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> }<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> * Sets the maximum number of events that can occur before events are filtered for exceeding the average rate.<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * @param maxBurst Sets the maximum number of events that can occur before events are filtered for exceeding the average rate.<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * The default is 10 times the rate.<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * @return this<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> */<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> public Builder setMaxBurst(final long maxBurst) {<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> this.maxBurst = maxBurst;<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> @Override<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> public BurstFilter build() {<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> if (this.rate <= 0) {<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> this.rate = DEFAULT_RATE;<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> }<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> if (this.maxBurst <= 0) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> this.maxBurst = (long) (this.rate * DEFAULT_RATE_MULTIPLE);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> return new BurstFilter(this.level, this.rate, this.maxBurst, this.getOnMatch(), this.getOnMismatch());<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> }<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> }<a name="line.345"></a> |
| <span class="sourceLineNo">346</span>}<a name="line.346"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
