Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-flume-ng / apidocs / src-html / org / apache / logging / log4j / flume / appender / FlumeAvroAppender.html
blob: e121f40adc0710028de20a033bdddb64d04ef1d4 [file] [log] [blame]
<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.flume.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.core.Filter;<a name="line.19"></a>
<FONT color="green">020</FONT> import org.apache.logging.log4j.core.Layout;<a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.logging.log4j.core.LogEvent;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.logging.log4j.core.appender.AppenderBase;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.logging.log4j.core.config.plugins.PluginAttr;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.logging.log4j.core.layout.RFC5424Layout;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> import java.net.InetAddress;<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> /**<a name="line.31"></a>
<FONT color="green">032</FONT> * An Appender that uses the Avro protocol to route events to Flume.<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> @Plugin(name = "Flume", type = "Core", elementType = "appender", printObject = true)<a name="line.34"></a>
<FONT color="green">035</FONT> public final class FlumeAvroAppender extends AppenderBase implements FlumeEventFactory {<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> private FlumeAvroManager manager;<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> private final String mdcIncludes;<a name="line.39"></a>
<FONT color="green">040</FONT> private final String mdcExcludes;<a name="line.40"></a>
<FONT color="green">041</FONT> private final String mdcRequired;<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> private final String eventPrefix;<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> private final String mdcPrefix;<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> private final boolean compressBody;<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> private final String hostname;<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> private final int reconnectDelay;<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> private final int retries;<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> private final FlumeEventFactory factory;<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> private FlumeAvroAppender(String name, Filter filter, Layout layout, boolean handleException,<a name="line.57"></a>
<FONT color="green">058</FONT> String hostname, String includes, String excludes, String required, String mdcPrefix,<a name="line.58"></a>
<FONT color="green">059</FONT> String eventPrefix, boolean compress, int delay, int retries,<a name="line.59"></a>
<FONT color="green">060</FONT> FlumeEventFactory factory, FlumeAvroManager manager) {<a name="line.60"></a>
<FONT color="green">061</FONT> super(name, filter, layout, handleException);<a name="line.61"></a>
<FONT color="green">062</FONT> this.manager = manager;<a name="line.62"></a>
<FONT color="green">063</FONT> this.mdcIncludes = includes;<a name="line.63"></a>
<FONT color="green">064</FONT> this.mdcExcludes = excludes;<a name="line.64"></a>
<FONT color="green">065</FONT> this.mdcRequired = required;<a name="line.65"></a>
<FONT color="green">066</FONT> this.eventPrefix = eventPrefix;<a name="line.66"></a>
<FONT color="green">067</FONT> this.mdcPrefix = mdcPrefix;<a name="line.67"></a>
<FONT color="green">068</FONT> this.compressBody = compress;<a name="line.68"></a>
<FONT color="green">069</FONT> this.hostname = hostname;<a name="line.69"></a>
<FONT color="green">070</FONT> this.reconnectDelay = delay;<a name="line.70"></a>
<FONT color="green">071</FONT> this.retries = retries;<a name="line.71"></a>
<FONT color="green">072</FONT> this.factory = factory == null ? this : factory;<a name="line.72"></a>
<FONT color="green">073</FONT> }<a name="line.73"></a>
<FONT color="green">074</FONT> <a name="line.74"></a>
<FONT color="green">075</FONT> /**<a name="line.75"></a>
<FONT color="green">076</FONT> * Publish the event.<a name="line.76"></a>
<FONT color="green">077</FONT> * @param event The LogEvent.<a name="line.77"></a>
<FONT color="green">078</FONT> */<a name="line.78"></a>
<FONT color="green">079</FONT> public void append(LogEvent event) {<a name="line.79"></a>
<FONT color="green">080</FONT> <a name="line.80"></a>
<FONT color="green">081</FONT> FlumeEvent flumeEvent = factory.createEvent(event, mdcIncludes, mdcExcludes, mdcRequired, mdcPrefix,<a name="line.81"></a>
<FONT color="green">082</FONT> eventPrefix, compressBody);<a name="line.82"></a>
<FONT color="green">083</FONT> flumeEvent.setBody(getLayout().format(flumeEvent));<a name="line.83"></a>
<FONT color="green">084</FONT> manager.send(flumeEvent, reconnectDelay, retries);<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> @Override<a name="line.87"></a>
<FONT color="green">088</FONT> public void stop() {<a name="line.88"></a>
<FONT color="green">089</FONT> super.stop();<a name="line.89"></a>
<FONT color="green">090</FONT> manager.release();<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> <a name="line.92"></a>
<FONT color="green">093</FONT> /**<a name="line.93"></a>
<FONT color="green">094</FONT> * Create a Flume event.<a name="line.94"></a>
<FONT color="green">095</FONT> * @param event The Log4j LogEvent.<a name="line.95"></a>
<FONT color="green">096</FONT> * @param includes comma separated list of mdc elements to include.<a name="line.96"></a>
<FONT color="green">097</FONT> * @param excludes comma separated list of mdc elements to exclude.<a name="line.97"></a>
<FONT color="green">098</FONT> * @param required comma separated list of mdc elements that must be present with a value.<a name="line.98"></a>
<FONT color="green">099</FONT> * @param mdcPrefix The prefix to add to MDC key names.<a name="line.99"></a>
<FONT color="green">100</FONT> * @param eventPrefix The prefix to add to event fields.<a name="line.100"></a>
<FONT color="green">101</FONT> * @param compress If true the body will be compressed.<a name="line.101"></a>
<FONT color="green">102</FONT> * @return A Flume Event.<a name="line.102"></a>
<FONT color="green">103</FONT> */<a name="line.103"></a>
<FONT color="green">104</FONT> public FlumeEvent createEvent(LogEvent event, String includes, String excludes, String required,<a name="line.104"></a>
<FONT color="green">105</FONT> String mdcPrefix, String eventPrefix, boolean compress) {<a name="line.105"></a>
<FONT color="green">106</FONT> return new FlumeEvent(event, mdcIncludes, mdcExcludes, mdcRequired, mdcPrefix,<a name="line.106"></a>
<FONT color="green">107</FONT> eventPrefix, compressBody);<a name="line.107"></a>
<FONT color="green">108</FONT> }<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> /**<a name="line.110"></a>
<FONT color="green">111</FONT> * Create a Flume Avro Appender.<a name="line.111"></a>
<FONT color="green">112</FONT> * @param agents An array of Agents.<a name="line.112"></a>
<FONT color="green">113</FONT> * @param delay The amount of time in milliseconds to wait between retries.<a name="line.113"></a>
<FONT color="green">114</FONT> * @param agentRetries The number of times to retry an agent before failing to the next agent.<a name="line.114"></a>
<FONT color="green">115</FONT> * @param name The name of the Appender.<a name="line.115"></a>
<FONT color="green">116</FONT> * @param suppress If true exceptions will be handled in the appender.<a name="line.116"></a>
<FONT color="green">117</FONT> * @param excludes A comma separated list of MDC elements to exclude.<a name="line.117"></a>
<FONT color="green">118</FONT> * @param includes A comma separated list of MDC elements to include.<a name="line.118"></a>
<FONT color="green">119</FONT> * @param required A comma separated list of MDC elements that are required.<a name="line.119"></a>
<FONT color="green">120</FONT> * @param mdcPrefix The prefix to add to MDC key names.<a name="line.120"></a>
<FONT color="green">121</FONT> * @param eventPrefix The prefix to add to event key names.<a name="line.121"></a>
<FONT color="green">122</FONT> * @param compressBody If true the event body will be compressed.<a name="line.122"></a>
<FONT color="green">123</FONT> * @param batchSize Number of events to include in a batch. Defaults to 1.<a name="line.123"></a>
<FONT color="green">124</FONT> * @param factory The factory to use to create Flume events.<a name="line.124"></a>
<FONT color="green">125</FONT> * @param layout The layout to format the event.<a name="line.125"></a>
<FONT color="green">126</FONT> * @param filter A Filter to filter events.<a name="line.126"></a>
<FONT color="green">127</FONT> * @return A Flume Avro Appender.<a name="line.127"></a>
<FONT color="green">128</FONT> */<a name="line.128"></a>
<FONT color="green">129</FONT> @PluginFactory<a name="line.129"></a>
<FONT color="green">130</FONT> public static FlumeAvroAppender createAppender(@PluginElement("agents") Agent[] agents,<a name="line.130"></a>
<FONT color="green">131</FONT> @PluginAttr("reconnectionDelay") String delay,<a name="line.131"></a>
<FONT color="green">132</FONT> @PluginAttr("agentRetries") String agentRetries,<a name="line.132"></a>
<FONT color="green">133</FONT> @PluginAttr("name") String name,<a name="line.133"></a>
<FONT color="green">134</FONT> @PluginAttr("suppressExceptions") String suppress,<a name="line.134"></a>
<FONT color="green">135</FONT> @PluginAttr("mdcExcludes") String excludes,<a name="line.135"></a>
<FONT color="green">136</FONT> @PluginAttr("mdcIncludes") String includes,<a name="line.136"></a>
<FONT color="green">137</FONT> @PluginAttr("mdcRequired") String required,<a name="line.137"></a>
<FONT color="green">138</FONT> @PluginAttr("mdcPrefix") String mdcPrefix,<a name="line.138"></a>
<FONT color="green">139</FONT> @PluginAttr("eventPrefix") String eventPrefix,<a name="line.139"></a>
<FONT color="green">140</FONT> @PluginAttr("compress") String compressBody,<a name="line.140"></a>
<FONT color="green">141</FONT> @PluginAttr("batchSize") String batchSize,<a name="line.141"></a>
<FONT color="green">142</FONT> @PluginElement("flumeEventFactory") FlumeEventFactory factory,<a name="line.142"></a>
<FONT color="green">143</FONT> @PluginElement("layout") Layout layout,<a name="line.143"></a>
<FONT color="green">144</FONT> @PluginElement("filters") Filter filter) {<a name="line.144"></a>
<FONT color="green">145</FONT> <a name="line.145"></a>
<FONT color="green">146</FONT> String hostname;<a name="line.146"></a>
<FONT color="green">147</FONT> try {<a name="line.147"></a>
<FONT color="green">148</FONT> hostname = InetAddress.getLocalHost().getHostName();<a name="line.148"></a>
<FONT color="green">149</FONT> } catch (Exception ex) {<a name="line.149"></a>
<FONT color="green">150</FONT> LOGGER.error("Unable to determine local hostname", ex);<a name="line.150"></a>
<FONT color="green">151</FONT> return null;<a name="line.151"></a>
<FONT color="green">152</FONT> }<a name="line.152"></a>
<FONT color="green">153</FONT> if (agents == null || agents.length == 0) {<a name="line.153"></a>
<FONT color="green">154</FONT> LOGGER.debug("No agents provided, using defaults");<a name="line.154"></a>
<FONT color="green">155</FONT> agents = new Agent[] {Agent.createAgent(null, null)};<a name="line.155"></a>
<FONT color="green">156</FONT> }<a name="line.156"></a>
<FONT color="green">157</FONT> <a name="line.157"></a>
<FONT color="green">158</FONT> boolean handleExceptions = suppress == null ? true : Boolean.valueOf(suppress);<a name="line.158"></a>
<FONT color="green">159</FONT> boolean compress = compressBody == null ? true : Boolean.valueOf(compressBody);<a name="line.159"></a>
<FONT color="green">160</FONT> <a name="line.160"></a>
<FONT color="green">161</FONT> int batchCount = batchSize == null ? 1 : Integer.parseInt(batchSize);<a name="line.161"></a>
<FONT color="green">162</FONT> int reconnectDelay = delay == null ? 0 : Integer.parseInt(delay);<a name="line.162"></a>
<FONT color="green">163</FONT> int retries = agentRetries == null ? 0 : Integer.parseInt(agentRetries);<a name="line.163"></a>
<FONT color="green">164</FONT> <a name="line.164"></a>
<FONT color="green">165</FONT> if (layout == null) {<a name="line.165"></a>
<FONT color="green">166</FONT> layout = RFC5424Layout.createLayout(null, null, null, "True", null, null, null, null, excludes,<a name="line.166"></a>
<FONT color="green">167</FONT> includes, required, null, null);<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>
<FONT color="green">170</FONT> if (name == null) {<a name="line.170"></a>
<FONT color="green">171</FONT> LOGGER.error("No name provided for Appender");<a name="line.171"></a>
<FONT color="green">172</FONT> return null;<a name="line.172"></a>
<FONT color="green">173</FONT> }<a name="line.173"></a>
<FONT color="green">174</FONT> <a name="line.174"></a>
<FONT color="green">175</FONT> FlumeAvroManager manager = FlumeAvroManager.getManager(agents, batchCount);<a name="line.175"></a>
<FONT color="green">176</FONT> if (manager == null) {<a name="line.176"></a>
<FONT color="green">177</FONT> return null;<a name="line.177"></a>
<FONT color="green">178</FONT> }<a name="line.178"></a>
<FONT color="green">179</FONT> <a name="line.179"></a>
<FONT color="green">180</FONT> return new FlumeAvroAppender(name, filter, layout, handleExceptions, hostname, includes,<a name="line.180"></a>
<FONT color="green">181</FONT> excludes, required, mdcPrefix, eventPrefix, compress, reconnectDelay, retries, factory, manager);<a name="line.181"></a>
<FONT color="green">182</FONT> }<a name="line.182"></a>
<FONT color="green">183</FONT> }<a name="line.183"></a>
</PRE>
</BODY>
</HTML>