blob: 7a4eaa017081f8507240ddb8369f69125968f422 [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.core.appender.rewrite;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.concurrent.ConcurrentMap;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.Appender;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.Core;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.Filter;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.appender.AbstractAppender;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.AppenderControl;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.AppenderRef;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.Property;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.util.Booleans;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * This Appender allows the logging event to be manipulated before it is processed by other Appenders.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>@Plugin(name = "Rewrite", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.41"></a>
<span class="sourceLineNo">042</span>public final class RewriteAppender extends AbstractAppender {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> private final Configuration config;<a name="line.44"></a>
<span class="sourceLineNo">045</span> private final ConcurrentMap&lt;String, AppenderControl&gt; appenders = new ConcurrentHashMap&lt;&gt;();<a name="line.45"></a>
<span class="sourceLineNo">046</span> private final RewritePolicy rewritePolicy;<a name="line.46"></a>
<span class="sourceLineNo">047</span> private final AppenderRef[] appenderRefs;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> private RewriteAppender(final String name, final Filter filter, final boolean ignoreExceptions,<a name="line.49"></a>
<span class="sourceLineNo">050</span> final AppenderRef[] appenderRefs, final RewritePolicy rewritePolicy,<a name="line.50"></a>
<span class="sourceLineNo">051</span> final Configuration config, final Property[] properties) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> super(name, filter, null, ignoreExceptions, properties);<a name="line.52"></a>
<span class="sourceLineNo">053</span> this.config = config;<a name="line.53"></a>
<span class="sourceLineNo">054</span> this.rewritePolicy = rewritePolicy;<a name="line.54"></a>
<span class="sourceLineNo">055</span> this.appenderRefs = appenderRefs;<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> @Override<a name="line.58"></a>
<span class="sourceLineNo">059</span> public void start() {<a name="line.59"></a>
<span class="sourceLineNo">060</span> for (final AppenderRef ref : appenderRefs) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> final String name = ref.getRef();<a name="line.61"></a>
<span class="sourceLineNo">062</span> final Appender appender = config.getAppender(name);<a name="line.62"></a>
<span class="sourceLineNo">063</span> if (appender != null) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> final Filter filter = appender instanceof AbstractAppender ?<a name="line.64"></a>
<span class="sourceLineNo">065</span> ((AbstractAppender) appender).getFilter() : null;<a name="line.65"></a>
<span class="sourceLineNo">066</span> appenders.put(name, new AppenderControl(appender, ref.getLevel(), filter));<a name="line.66"></a>
<span class="sourceLineNo">067</span> } else {<a name="line.67"></a>
<span class="sourceLineNo">068</span> LOGGER.error("Appender " + ref + " cannot be located. Reference ignored");<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span> super.start();<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<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> * Modifies the event and pass to the subordinate Appenders.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param event The LogEvent.<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> @Override<a name="line.78"></a>
<span class="sourceLineNo">079</span> public void append(LogEvent event) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> if (rewritePolicy != null) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> event = rewritePolicy.rewrite(event);<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> for (final AppenderControl control : appenders.values()) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> control.callAppender(event);<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /**<a name="line.88"></a>
<span class="sourceLineNo">089</span> * Creates a RewriteAppender.<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @param name The name of the Appender.<a name="line.90"></a>
<span class="sourceLineNo">091</span> * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise<a name="line.91"></a>
<span class="sourceLineNo">092</span> * they are propagated to the caller.<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @param appenderRefs An array of Appender names to call.<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param config The Configuration.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @param rewritePolicy The policy to use to modify the event.<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @param filter A Filter to filter events.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @return The created RewriteAppender.<a name="line.97"></a>
<span class="sourceLineNo">098</span> */<a name="line.98"></a>
<span class="sourceLineNo">099</span> @PluginFactory<a name="line.99"></a>
<span class="sourceLineNo">100</span> public static RewriteAppender createAppender(<a name="line.100"></a>
<span class="sourceLineNo">101</span> @PluginAttribute("name") final String name,<a name="line.101"></a>
<span class="sourceLineNo">102</span> @PluginAttribute("ignoreExceptions") final String ignore,<a name="line.102"></a>
<span class="sourceLineNo">103</span> @PluginElement("AppenderRef") final AppenderRef[] appenderRefs,<a name="line.103"></a>
<span class="sourceLineNo">104</span> @PluginConfiguration final Configuration config,<a name="line.104"></a>
<span class="sourceLineNo">105</span> @PluginElement("RewritePolicy") final RewritePolicy rewritePolicy,<a name="line.105"></a>
<span class="sourceLineNo">106</span> @PluginElement("Filter") final Filter filter) {<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);<a name="line.108"></a>
<span class="sourceLineNo">109</span> if (name == null) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> LOGGER.error("No name provided for RewriteAppender");<a name="line.110"></a>
<span class="sourceLineNo">111</span> return null;<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span> if (appenderRefs == null) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> LOGGER.error("No appender references defined for RewriteAppender");<a name="line.114"></a>
<span class="sourceLineNo">115</span> return null;<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> return new RewriteAppender(name, filter, ignoreExceptions, appenderRefs, rewritePolicy, config, 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>
</pre>
</div>
</body>
</html>