| <!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.appender.mom.jeromq;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.Serializable;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.concurrent.TimeUnit;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><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.Filter;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.Layout;<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.appender.AbstractAppender;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.Node;<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.PluginAttribute;<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.config.plugins.validation.constraints.Required;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.layout.PatternLayout;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.util.Strings;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span>/**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * Sends log events to one or more ZeroMQ (JeroMQ) endpoints.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <p><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Requires the JeroMQ jar (LGPL as of 0.3.5)<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * </p><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>// TODO<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>// Some methods are synchronized because a ZMQ.Socket is not thread-safe<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>// Using a ThreadLocal for the publisher hangs tests on shutdown. There must be<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>// some issue on threads owning certain resources as opposed to others.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>@Plugin(name = "JeroMQ", category = Node.CATEGORY, elementType = Appender.ELEMENT_TYPE, printObject = true)<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public final class JeroMqAppender extends AbstractAppender {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private static final int DEFAULT_BACKLOG = 100;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private static final int DEFAULT_IVL = 100;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private static final int DEFAULT_RCV_HWM = 1000;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private static final int DEFAULT_SND_HWM = 1000;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private final JeroMqManager manager;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private final List<String> endpoints;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private int sendRcFalse;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> private int sendRcTrue;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private JeroMqAppender(final String name, final Filter filter, final Layout<? extends Serializable> layout,<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> final boolean ignoreExceptions, final List<String> endpoints, final long affinity, final long backlog,<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> final boolean delayAttachOnConnect, final byte[] identity, final boolean ipv4Only, final long linger,<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> final long maxMsgSize, final long rcvHwm, final long receiveBufferSize, final int receiveTimeOut,<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> final long reconnectIVL, final long reconnectIVLMax, final long sendBufferSize, final int sendTimeOut,<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> final long sndHWM, final int tcpKeepAlive, final long tcpKeepAliveCount, final long tcpKeepAliveIdle,<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> final long tcpKeepAliveInterval, final boolean xpubVerbose, final Property[] properties) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> super(name, filter, layout, ignoreExceptions, properties);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> this.manager = JeroMqManager.getJeroMqManager(name, affinity, backlog, delayAttachOnConnect, identity, ipv4Only,<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> linger, maxMsgSize, rcvHwm, receiveBufferSize, receiveTimeOut, reconnectIVL, reconnectIVLMax,<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> sendBufferSize, sendTimeOut, sndHWM, tcpKeepAlive, tcpKeepAliveCount, tcpKeepAliveIdle,<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> tcpKeepAliveInterval, xpubVerbose, endpoints);<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> this.endpoints = endpoints;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> }<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> // The ZMQ.Socket class has other set methods that we do not cover because<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> // they throw unsupported operation exceptions.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> @PluginFactory<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public static JeroMqAppender createAppender(<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> // @formatter:off<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> @Required(message = "No name provided for JeroMqAppender") @PluginAttribute("name") final String name,<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> @PluginElement("Layout") Layout<?> layout,<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> @PluginElement("Filter") final Filter filter,<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> @PluginElement("Properties") final Property[] properties,<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> // Super attributes<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> @PluginAttribute("ignoreExceptions") final boolean ignoreExceptions,<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> // ZMQ attributes; defaults picked from zmq.Options.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> @PluginAttribute(value = "affinity", defaultLong = 0) final long affinity,<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> @PluginAttribute(value = "backlog", defaultLong = DEFAULT_BACKLOG) final long backlog,<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> @PluginAttribute(value = "delayAttachOnConnect") final boolean delayAttachOnConnect,<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> @PluginAttribute(value = "identity") final byte[] identity,<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> @PluginAttribute(value = "ipv4Only", defaultBoolean = true) final boolean ipv4Only,<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> @PluginAttribute(value = "linger", defaultLong = -1) final long linger,<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> @PluginAttribute(value = "maxMsgSize", defaultLong = -1) final long maxMsgSize,<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> @PluginAttribute(value = "rcvHwm", defaultLong = DEFAULT_RCV_HWM) final long rcvHwm,<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> @PluginAttribute(value = "receiveBufferSize", defaultLong = 0) final long receiveBufferSize,<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> @PluginAttribute(value = "receiveTimeOut", defaultLong = -1) final int receiveTimeOut,<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> @PluginAttribute(value = "reconnectIVL", defaultLong = DEFAULT_IVL) final long reconnectIVL,<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> @PluginAttribute(value = "reconnectIVLMax", defaultLong = 0) final long reconnectIVLMax,<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> @PluginAttribute(value = "sendBufferSize", defaultLong = 0) final long sendBufferSize,<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> @PluginAttribute(value = "sendTimeOut", defaultLong = -1) final int sendTimeOut,<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> @PluginAttribute(value = "sndHwm", defaultLong = DEFAULT_SND_HWM) final long sndHwm,<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> @PluginAttribute(value = "tcpKeepAlive", defaultInt = -1) final int tcpKeepAlive,<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> @PluginAttribute(value = "tcpKeepAliveCount", defaultLong = -1) final long tcpKeepAliveCount,<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> @PluginAttribute(value = "tcpKeepAliveIdle", defaultLong = -1) final long tcpKeepAliveIdle,<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> @PluginAttribute(value = "tcpKeepAliveInterval", defaultLong = -1) final long tcpKeepAliveInterval,<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> @PluginAttribute(value = "xpubVerbose") final boolean xpubVerbose<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> // @formatter:on<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> ) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> if (layout == null) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> layout = PatternLayout.createDefaultLayout();<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> List<String> endpoints;<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> if (properties == null) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> endpoints = new ArrayList<>(0);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> } else {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> endpoints = new ArrayList<>(properties.length);<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> for (final Property property : properties) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> if ("endpoint".equalsIgnoreCase(property.getName())) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> final String value = property.getValue();<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> if (Strings.isNotEmpty(value)) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> endpoints.add(value);<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> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> LOGGER.debug("Creating JeroMqAppender with name={}, filter={}, layout={}, ignoreExceptions={}, endpoints={}",<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> name, filter, layout, ignoreExceptions, endpoints);<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return new JeroMqAppender(name, filter, layout, ignoreExceptions, endpoints, affinity, backlog,<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> delayAttachOnConnect, identity, ipv4Only, linger, maxMsgSize, rcvHwm, receiveBufferSize,<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> receiveTimeOut, reconnectIVL, reconnectIVLMax, sendBufferSize, sendTimeOut, sndHwm, tcpKeepAlive,<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> tcpKeepAliveCount, tcpKeepAliveIdle, tcpKeepAliveInterval, xpubVerbose, null);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> @Override<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> public synchronized void append(final LogEvent event) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> final Layout<? extends Serializable> layout = getLayout();<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> final byte[] formattedMessage = layout.toByteArray(event);<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> if (manager.send(getLayout().toByteArray(event))) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> sendRcTrue++;<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> } else {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> sendRcFalse++;<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> LOGGER.error("Appender {} could not send message {} to JeroMQ {}", getName(), sendRcFalse, formattedMessage);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> @Override<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public boolean stop(final long timeout, final TimeUnit timeUnit) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> setStopping();<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> boolean stopped = super.stop(timeout, timeUnit, false);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> stopped &= manager.stop(timeout, timeUnit);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> setStopped();<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> return stopped;<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> // not public, handy for testing<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> int getSendRcFalse() {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return sendRcFalse;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> // not public, handy for testing<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> int getSendRcTrue() {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> return sendRcTrue;<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> // not public, handy for testing<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> void resetSendRcs() {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> sendRcTrue = sendRcFalse = 0;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> @Override<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> public String toString() {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return "JeroMqAppender{" +<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> "name=" + getName() +<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> ", state=" + getState() +<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> ", manager=" + manager +<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> ", endpoints=" + endpoints +<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> '}';<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span>}<a name="line.185"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
