| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.appender;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.util.ArrayList;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.List;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Map;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.concurrent.TimeUnit;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.LoggingException;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.Appender;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Core;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.Filter;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.AppenderControl;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.Property;<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.PluginAliases;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.util.Booleans;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.util.Constants;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span>/**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * The FailoverAppender will capture exceptions in an Appender and then route the event<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * to a different appender. Hopefully it is obvious that the Appenders must be configured<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * to not suppress exceptions for the FailoverAppender to work.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>@Plugin(name = "Failover", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public final class FailoverAppender extends AbstractAppender {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private static final int DEFAULT_INTERVAL_SECONDS = 60;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private final String primaryRef;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private final String[] failovers;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private final Configuration config;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private AppenderControl primary;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private final List<AppenderControl> failoverAppenders = new ArrayList<>();<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private final long intervalNanos;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private volatile long nextCheckNanos = 0;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private FailoverAppender(final String name, final Filter filter, final String primary, final String[] failovers,<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> final int intervalMillis, final Configuration config, final boolean ignoreExceptions,<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> final Property[] properties) {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> super(name, filter, null, ignoreExceptions, properties);<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> this.primaryRef = primary;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> this.failovers = failovers;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> this.config = config;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> this.intervalNanos = TimeUnit.MILLISECONDS.toNanos(intervalMillis);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> @Override<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> public void start() {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> final Map<String, Appender> map = config.getAppenders();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> int errors = 0;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> final Appender appender = map.get(primaryRef);<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> if (appender != null) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> primary = new AppenderControl(appender, null, null);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> } else {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> LOGGER.error("Unable to locate primary Appender " + primaryRef);<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> ++errors;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> for (final String name : failovers) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> final Appender foAppender = map.get(name);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> if (foAppender != null) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> failoverAppenders.add(new AppenderControl(foAppender, null, null));<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> } else {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> LOGGER.error("Failover appender " + name + " is not configured");<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> if (failoverAppenders.isEmpty()) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> LOGGER.error("No failover appenders are available");<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> ++errors;<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> if (errors == 0) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> super.start();<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * Handle the Log event.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param event The LogEvent.<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 append(final LogEvent event) {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> if (!isStarted()) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> error("FailoverAppender " + getName() + " did not start successfully");<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> return;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> final long localCheckNanos = nextCheckNanos;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> if (localCheckNanos == 0 || System.nanoTime() - localCheckNanos > 0) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> callAppender(event);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> } else {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> failover(event, null);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> }<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> private void callAppender(final LogEvent event) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> try {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> primary.callAppender(event);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> nextCheckNanos = 0;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> } catch (final Exception ex) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> nextCheckNanos = System.nanoTime() + intervalNanos;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> failover(event, ex);<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><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> private void failover(final LogEvent event, final Exception ex) {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> final RuntimeException re = ex != null ?<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> (ex instanceof LoggingException ? (LoggingException) ex : new LoggingException(ex)) : null;<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> boolean written = false;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> Exception failoverException = null;<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> for (final AppenderControl control : failoverAppenders) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> try {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> control.callAppender(event);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> written = true;<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> break;<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> } catch (final Exception fex) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> if (failoverException == null) {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> failoverException = fex;<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> }<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> if (!written && !ignoreExceptions()) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> if (re != null) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> throw re;<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> throw new LoggingException("Unable to write to failover appenders", failoverException);<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> @Override<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> public String toString() {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> final StringBuilder sb = new StringBuilder(getName());<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> sb.append(" primary=").append(primary).append(", failover={");<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> boolean first = true;<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> for (final String str : failovers) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> if (!first) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> sb.append(", ");<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> sb.append(str);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> first = false;<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> sb.append('}');<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> return sb.toString();<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> /**<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * Create a Failover Appender.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @param name The name of the Appender (required).<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * @param primary The name of the primary Appender (required).<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * @param failovers The name of one or more Appenders to fail over to (at least one is required).<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @param retryIntervalSeconds The retry interval in seconds.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @param config The current Configuration (passed by the Configuration when the appender is created).<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * @param filter A Filter (optional).<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * they are propagated to the caller.<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @return The FailoverAppender that was created.<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> */<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> @PluginFactory<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> public static FailoverAppender createAppender(<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> @PluginAttribute("name") final String name,<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> @PluginAttribute("primary") final String primary,<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> @PluginElement("Failovers") final String[] failovers,<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> @PluginAliases("retryInterval") // deprecated<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> @PluginAttribute("retryIntervalSeconds") final String retryIntervalSeconds,<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> @PluginConfiguration final Configuration config,<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> @PluginElement("Filter") final Filter filter,<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> @PluginAttribute("ignoreExceptions") final String ignore) {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> if (name == null) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> LOGGER.error("A name for the Appender must be specified");<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> return null;<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> if (primary == null) {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> LOGGER.error("A primary Appender must be specified");<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> return null;<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> if (failovers == null || failovers.length == 0) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> LOGGER.error("At least one failover Appender must be specified");<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> return null;<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> final int seconds = parseInt(retryIntervalSeconds, DEFAULT_INTERVAL_SECONDS);<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> int retryIntervalMillis;<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> if (seconds >= 0) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> retryIntervalMillis = seconds * Constants.MILLIS_IN_SECONDS;<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> } else {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> LOGGER.warn("Interval " + retryIntervalSeconds + " is less than zero. Using default");<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> retryIntervalMillis = DEFAULT_INTERVAL_SECONDS * Constants.MILLIS_IN_SECONDS;<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> }<a name="line.213"></a> |
| <span class="sourceLineNo">214</span><a name="line.214"></a> |
| <span class="sourceLineNo">215</span> final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);<a name="line.215"></a> |
| <span class="sourceLineNo">216</span><a name="line.216"></a> |
| <span class="sourceLineNo">217</span> return new FailoverAppender(name, filter, primary, failovers, retryIntervalMillis, config, ignoreExceptions, null);<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span>}<a name="line.219"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
