| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <FONT color="green">008</FONT> *<a name="line.8"></a> |
| <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <FONT color="green">010</FONT> *<a name="line.10"></a> |
| <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a> |
| <FONT color="green">016</FONT> */<a name="line.16"></a> |
| <FONT color="green">017</FONT> package org.apache.logging.log4j.core.appender;<a name="line.17"></a> |
| <FONT color="green">018</FONT> <a name="line.18"></a> |
| <FONT color="green">019</FONT> import org.apache.logging.log4j.LoggingException;<a name="line.19"></a> |
| <FONT color="green">020</FONT> import org.apache.logging.log4j.core.Appender;<a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.logging.log4j.core.Filter;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.logging.log4j.core.LogEvent;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.logging.log4j.core.config.AppenderControl;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.logging.log4j.core.config.Configuration;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.logging.log4j.core.config.plugins.PluginAttr;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.29"></a> |
| <FONT color="green">030</FONT> <a name="line.30"></a> |
| <FONT color="green">031</FONT> import java.util.ArrayList;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import java.util.List;<a name="line.32"></a> |
| <FONT color="green">033</FONT> import java.util.Map;<a name="line.33"></a> |
| <FONT color="green">034</FONT> <a name="line.34"></a> |
| <FONT color="green">035</FONT> /**<a name="line.35"></a> |
| <FONT color="green">036</FONT> * The FailoverAppender will capture exceptions in an Appender and then route the event<a name="line.36"></a> |
| <FONT color="green">037</FONT> * to a different appender. Hopefully it is obvious that the Appenders must be configured<a name="line.37"></a> |
| <FONT color="green">038</FONT> * to not suppress exceptions for the FailoverAppender to work.<a name="line.38"></a> |
| <FONT color="green">039</FONT> */<a name="line.39"></a> |
| <FONT color="green">040</FONT> @Plugin(name = "Failover", type = "Core", elementType = "appender", printObject = true)<a name="line.40"></a> |
| <FONT color="green">041</FONT> public final class FailoverAppender extends AppenderBase {<a name="line.41"></a> |
| <FONT color="green">042</FONT> <a name="line.42"></a> |
| <FONT color="green">043</FONT> private final String primaryRef;<a name="line.43"></a> |
| <FONT color="green">044</FONT> <a name="line.44"></a> |
| <FONT color="green">045</FONT> private final String[] failovers;<a name="line.45"></a> |
| <FONT color="green">046</FONT> <a name="line.46"></a> |
| <FONT color="green">047</FONT> private final Configuration config;<a name="line.47"></a> |
| <FONT color="green">048</FONT> <a name="line.48"></a> |
| <FONT color="green">049</FONT> private AppenderControl primary;<a name="line.49"></a> |
| <FONT color="green">050</FONT> <a name="line.50"></a> |
| <FONT color="green">051</FONT> private List<AppenderControl> failoverAppenders = new ArrayList<AppenderControl>();<a name="line.51"></a> |
| <FONT color="green">052</FONT> <a name="line.52"></a> |
| <FONT color="green">053</FONT> private FailoverAppender(String name, Filter filter, String primary, String[] failovers,<a name="line.53"></a> |
| <FONT color="green">054</FONT> Configuration config, boolean handleExceptions) {<a name="line.54"></a> |
| <FONT color="green">055</FONT> super(name, filter, null, handleExceptions);<a name="line.55"></a> |
| <FONT color="green">056</FONT> this.primaryRef = primary;<a name="line.56"></a> |
| <FONT color="green">057</FONT> this.failovers = failovers;<a name="line.57"></a> |
| <FONT color="green">058</FONT> this.config = config;<a name="line.58"></a> |
| <FONT color="green">059</FONT> }<a name="line.59"></a> |
| <FONT color="green">060</FONT> <a name="line.60"></a> |
| <FONT color="green">061</FONT> <a name="line.61"></a> |
| <FONT color="green">062</FONT> @Override<a name="line.62"></a> |
| <FONT color="green">063</FONT> public void start() {<a name="line.63"></a> |
| <FONT color="green">064</FONT> Map<String, Appender> map = config.getAppenders();<a name="line.64"></a> |
| <FONT color="green">065</FONT> int errors = 0;<a name="line.65"></a> |
| <FONT color="green">066</FONT> if (map.containsKey(primaryRef)) {<a name="line.66"></a> |
| <FONT color="green">067</FONT> primary = new AppenderControl(map.get(primaryRef), null, null);<a name="line.67"></a> |
| <FONT color="green">068</FONT> } else {<a name="line.68"></a> |
| <FONT color="green">069</FONT> LOGGER.error("Unable to locate primary Appender " + primaryRef);<a name="line.69"></a> |
| <FONT color="green">070</FONT> ++errors;<a name="line.70"></a> |
| <FONT color="green">071</FONT> }<a name="line.71"></a> |
| <FONT color="green">072</FONT> for (String name : failovers) {<a name="line.72"></a> |
| <FONT color="green">073</FONT> if (map.containsKey(name)) {<a name="line.73"></a> |
| <FONT color="green">074</FONT> failoverAppenders.add(new AppenderControl(map.get(name), null, null));<a name="line.74"></a> |
| <FONT color="green">075</FONT> } else {<a name="line.75"></a> |
| <FONT color="green">076</FONT> LOGGER.error("Failover appender " + name + " is not configured");<a name="line.76"></a> |
| <FONT color="green">077</FONT> }<a name="line.77"></a> |
| <FONT color="green">078</FONT> }<a name="line.78"></a> |
| <FONT color="green">079</FONT> if (failoverAppenders.size() == 0) {<a name="line.79"></a> |
| <FONT color="green">080</FONT> LOGGER.error("No failover appenders are available");<a name="line.80"></a> |
| <FONT color="green">081</FONT> ++errors;<a name="line.81"></a> |
| <FONT color="green">082</FONT> }<a name="line.82"></a> |
| <FONT color="green">083</FONT> if (errors == 0) {<a name="line.83"></a> |
| <FONT color="green">084</FONT> super.start();<a name="line.84"></a> |
| <FONT color="green">085</FONT> }<a name="line.85"></a> |
| <FONT color="green">086</FONT> }<a name="line.86"></a> |
| <FONT color="green">087</FONT> <a name="line.87"></a> |
| <FONT color="green">088</FONT> /**<a name="line.88"></a> |
| <FONT color="green">089</FONT> * Handle the Log event.<a name="line.89"></a> |
| <FONT color="green">090</FONT> * @param event The LogEvent.<a name="line.90"></a> |
| <FONT color="green">091</FONT> */<a name="line.91"></a> |
| <FONT color="green">092</FONT> public void append(LogEvent event) {<a name="line.92"></a> |
| <FONT color="green">093</FONT> RuntimeException re = null;<a name="line.93"></a> |
| <FONT color="green">094</FONT> if (!isStarted()) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> error("FailoverAppender " + getName() + " did not start successfully");<a name="line.95"></a> |
| <FONT color="green">096</FONT> return;<a name="line.96"></a> |
| <FONT color="green">097</FONT> }<a name="line.97"></a> |
| <FONT color="green">098</FONT> try {<a name="line.98"></a> |
| <FONT color="green">099</FONT> primary.callAppender(event);<a name="line.99"></a> |
| <FONT color="green">100</FONT> } catch (Exception ex) {<a name="line.100"></a> |
| <FONT color="green">101</FONT> re = new LoggingException(ex);<a name="line.101"></a> |
| <FONT color="green">102</FONT> boolean written = false;<a name="line.102"></a> |
| <FONT color="green">103</FONT> for (AppenderControl control : failoverAppenders) {<a name="line.103"></a> |
| <FONT color="green">104</FONT> try {<a name="line.104"></a> |
| <FONT color="green">105</FONT> control.callAppender(event);<a name="line.105"></a> |
| <FONT color="green">106</FONT> written = true;<a name="line.106"></a> |
| <FONT color="green">107</FONT> break;<a name="line.107"></a> |
| <FONT color="green">108</FONT> } catch (Exception fex) {<a name="line.108"></a> |
| <FONT color="green">109</FONT> continue;<a name="line.109"></a> |
| <FONT color="green">110</FONT> }<a name="line.110"></a> |
| <FONT color="green">111</FONT> }<a name="line.111"></a> |
| <FONT color="green">112</FONT> if (!written && !isExceptionSuppressed()) {<a name="line.112"></a> |
| <FONT color="green">113</FONT> throw re;<a name="line.113"></a> |
| <FONT color="green">114</FONT> }<a name="line.114"></a> |
| <FONT color="green">115</FONT> }<a name="line.115"></a> |
| <FONT color="green">116</FONT> }<a name="line.116"></a> |
| <FONT color="green">117</FONT> <a name="line.117"></a> |
| <FONT color="green">118</FONT> @Override<a name="line.118"></a> |
| <FONT color="green">119</FONT> public String toString() {<a name="line.119"></a> |
| <FONT color="green">120</FONT> StringBuilder sb = new StringBuilder(getName());<a name="line.120"></a> |
| <FONT color="green">121</FONT> sb.append(" primary=").append(primary).append(", failover={");<a name="line.121"></a> |
| <FONT color="green">122</FONT> boolean first = true;<a name="line.122"></a> |
| <FONT color="green">123</FONT> for (String str : failovers) {<a name="line.123"></a> |
| <FONT color="green">124</FONT> if (!first) {<a name="line.124"></a> |
| <FONT color="green">125</FONT> sb.append(", ");<a name="line.125"></a> |
| <FONT color="green">126</FONT> }<a name="line.126"></a> |
| <FONT color="green">127</FONT> sb.append(str);<a name="line.127"></a> |
| <FONT color="green">128</FONT> first = false;<a name="line.128"></a> |
| <FONT color="green">129</FONT> }<a name="line.129"></a> |
| <FONT color="green">130</FONT> sb.append("}");<a name="line.130"></a> |
| <FONT color="green">131</FONT> return sb.toString();<a name="line.131"></a> |
| <FONT color="green">132</FONT> }<a name="line.132"></a> |
| <FONT color="green">133</FONT> <a name="line.133"></a> |
| <FONT color="green">134</FONT> /**<a name="line.134"></a> |
| <FONT color="green">135</FONT> * Create a Failover Appender.<a name="line.135"></a> |
| <FONT color="green">136</FONT> * @param name The name of the Appender (required).<a name="line.136"></a> |
| <FONT color="green">137</FONT> * @param primary The name of the primary Appender (required).<a name="line.137"></a> |
| <FONT color="green">138</FONT> * @param failovers The name of one or more Appenders to fail over to (at least one is required).<a name="line.138"></a> |
| <FONT color="green">139</FONT> * @param config The current Configuration (passed by the Configuration when the appender is created).<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @param filter A Filter (optional).<a name="line.140"></a> |
| <FONT color="green">141</FONT> * @param suppress "true" if exceptions should be hidden from the application, "false" otherwise.<a name="line.141"></a> |
| <FONT color="green">142</FONT> * The default is "true".<a name="line.142"></a> |
| <FONT color="green">143</FONT> * @return The FailoverAppender that was created.<a name="line.143"></a> |
| <FONT color="green">144</FONT> */<a name="line.144"></a> |
| <FONT color="green">145</FONT> @PluginFactory<a name="line.145"></a> |
| <FONT color="green">146</FONT> public static FailoverAppender createAppender(@PluginAttr("name") String name,<a name="line.146"></a> |
| <FONT color="green">147</FONT> @PluginAttr("primary") String primary,<a name="line.147"></a> |
| <FONT color="green">148</FONT> @PluginElement("failovers") String[] failovers,<a name="line.148"></a> |
| <FONT color="green">149</FONT> @PluginConfiguration Configuration config,<a name="line.149"></a> |
| <FONT color="green">150</FONT> @PluginElement("filters") Filter filter,<a name="line.150"></a> |
| <FONT color="green">151</FONT> @PluginAttr("suppressExceptions") String suppress) {<a name="line.151"></a> |
| <FONT color="green">152</FONT> if (name == null) {<a name="line.152"></a> |
| <FONT color="green">153</FONT> LOGGER.error("A name for the Appender must be specified");<a name="line.153"></a> |
| <FONT color="green">154</FONT> return null;<a name="line.154"></a> |
| <FONT color="green">155</FONT> }<a name="line.155"></a> |
| <FONT color="green">156</FONT> if (primary == null) {<a name="line.156"></a> |
| <FONT color="green">157</FONT> LOGGER.error("A primary Appender must be specified");<a name="line.157"></a> |
| <FONT color="green">158</FONT> return null;<a name="line.158"></a> |
| <FONT color="green">159</FONT> }<a name="line.159"></a> |
| <FONT color="green">160</FONT> if (failovers == null || failovers.length == 0) {<a name="line.160"></a> |
| <FONT color="green">161</FONT> LOGGER.error("At least one failover Appender must be specified");<a name="line.161"></a> |
| <FONT color="green">162</FONT> return null;<a name="line.162"></a> |
| <FONT color="green">163</FONT> }<a name="line.163"></a> |
| <FONT color="green">164</FONT> <a name="line.164"></a> |
| <FONT color="green">165</FONT> boolean handleExceptions = suppress == null ? true : Boolean.valueOf(suppress);<a name="line.165"></a> |
| <FONT color="green">166</FONT> <a name="line.166"></a> |
| <FONT color="green">167</FONT> return new FailoverAppender(name, filter, primary, failovers, config, handleExceptions);<a name="line.167"></a> |
| <FONT color="green">168</FONT> }<a name="line.168"></a> |
| <FONT color="green">169</FONT> }<a name="line.169"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
