Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.3 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / layout / SyslogLayout.html
blob: b0c75f626d56f1a7e26736ad66ef5854138dfd44 [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.layout;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.nio.charset.Charset;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.nio.charset.StandardCharsets;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.text.SimpleDateFormat;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Date;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.HashMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Locale;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.regex.Matcher;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.regex.Pattern;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.Layout;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.Node;<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.PluginBuilderAttribute;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.net.Facility;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.net.Priority;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.util.NetUtils;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.logging.log4j.util.Chars;<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> * Formats a log event as a BSD Log record.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>@Plugin(name = "SyslogLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)<a name="line.43"></a>
<span class="sourceLineNo">044</span>public final class SyslogLayout extends AbstractStringLayout {<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Builds a SyslogLayout.<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;p&gt;The main arguments are&lt;/p&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;ul&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;li&gt;facility: The Facility is used to try to classify the message.&lt;/li&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;li&gt;includeNewLine: If true a newline will be appended to the result.&lt;/li&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;li&gt;escapeNL: Pattern to use for replacing newlines.&lt;/li&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;li&gt;charset: The character set.&lt;/li&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;/ul&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @param &lt;B&gt; the builder type<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> public static class Builder&lt;B extends Builder&lt;B&gt;&gt; extends AbstractStringLayout.Builder&lt;B&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> implements org.apache.logging.log4j.core.util.Builder&lt;SyslogLayout&gt; {<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> public Builder() {<a name="line.60"></a>
<span class="sourceLineNo">061</span> super();<a name="line.61"></a>
<span class="sourceLineNo">062</span> setCharset(StandardCharsets.UTF_8);<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> @PluginBuilderAttribute<a name="line.65"></a>
<span class="sourceLineNo">066</span> private Facility facility = Facility.LOCAL0;<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> @PluginBuilderAttribute("newLine")<a name="line.68"></a>
<span class="sourceLineNo">069</span> private boolean includeNewLine;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> @PluginBuilderAttribute("newLineEscape")<a name="line.71"></a>
<span class="sourceLineNo">072</span> private String escapeNL;<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> @Override<a name="line.74"></a>
<span class="sourceLineNo">075</span> public SyslogLayout build() {<a name="line.75"></a>
<span class="sourceLineNo">076</span> return new SyslogLayout(facility, includeNewLine, escapeNL, getCharset());<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> public Facility getFacility() {<a name="line.79"></a>
<span class="sourceLineNo">080</span> return facility;<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> public boolean isIncludeNewLine() {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return includeNewLine;<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> public String getEscapeNL() {<a name="line.87"></a>
<span class="sourceLineNo">088</span> return escapeNL;<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> public B setFacility(final Facility facility) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> this.facility = facility;<a name="line.92"></a>
<span class="sourceLineNo">093</span> return asBuilder();<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> public B setIncludeNewLine(final boolean includeNewLine) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> this.includeNewLine = includeNewLine;<a name="line.97"></a>
<span class="sourceLineNo">098</span> return asBuilder();<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> public B setEscapeNL(final String escapeNL) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> this.escapeNL = escapeNL;<a name="line.102"></a>
<span class="sourceLineNo">103</span> return asBuilder();<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> @PluginBuilderFactory<a name="line.108"></a>
<span class="sourceLineNo">109</span> public static &lt;B extends Builder&lt;B&gt;&gt; B newBuilder() {<a name="line.109"></a>
<span class="sourceLineNo">110</span> return new Builder&lt;B&gt;().asBuilder();<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
<span class="sourceLineNo">114</span> * Match newlines in a platform-independent manner.<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> public static final Pattern NEWLINE_PATTERN = Pattern.compile("\\r?\\n");<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> private final Facility facility;<a name="line.118"></a>
<span class="sourceLineNo">119</span> private final boolean includeNewLine;<a name="line.119"></a>
<span class="sourceLineNo">120</span> private final String escapeNewLine;<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> /**<a name="line.122"></a>
<span class="sourceLineNo">123</span> * Date format used if header = true.<a name="line.123"></a>
<span class="sourceLineNo">124</span> */<a name="line.124"></a>
<span class="sourceLineNo">125</span> private final SimpleDateFormat dateFormat = new SimpleDateFormat("MMM dd HH:mm:ss", Locale.ENGLISH);<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> /**<a name="line.127"></a>
<span class="sourceLineNo">128</span> * Host name used to identify messages from this appender.<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> private final String localHostname = NetUtils.getLocalHostname();<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> protected SyslogLayout(final Facility facility, final boolean includeNL, final String escapeNL, final Charset charset) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> super(charset);<a name="line.133"></a>
<span class="sourceLineNo">134</span> this.facility = facility;<a name="line.134"></a>
<span class="sourceLineNo">135</span> this.includeNewLine = includeNL;<a name="line.135"></a>
<span class="sourceLineNo">136</span> this.escapeNewLine = escapeNL == null ? null : Matcher.quoteReplacement(escapeNL);<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<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> * Formats a {@link org.apache.logging.log4j.core.LogEvent} in conformance with the BSD Log record format.<a name="line.140"></a>
<span class="sourceLineNo">141</span> *<a name="line.141"></a>
<span class="sourceLineNo">142</span> * @param event The LogEvent<a name="line.142"></a>
<span class="sourceLineNo">143</span> * @return the event formatted as a String.<a name="line.143"></a>
<span class="sourceLineNo">144</span> */<a name="line.144"></a>
<span class="sourceLineNo">145</span> @Override<a name="line.145"></a>
<span class="sourceLineNo">146</span> public String toSerializable(final LogEvent event) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> final StringBuilder buf = getStringBuilder();<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> buf.append('&lt;');<a name="line.149"></a>
<span class="sourceLineNo">150</span> buf.append(Priority.getPriority(facility, event.getLevel()));<a name="line.150"></a>
<span class="sourceLineNo">151</span> buf.append('&gt;');<a name="line.151"></a>
<span class="sourceLineNo">152</span> addDate(event.getTimeMillis(), buf);<a name="line.152"></a>
<span class="sourceLineNo">153</span> buf.append(Chars.SPACE);<a name="line.153"></a>
<span class="sourceLineNo">154</span> buf.append(localHostname);<a name="line.154"></a>
<span class="sourceLineNo">155</span> buf.append(Chars.SPACE);<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> String message = event.getMessage().getFormattedMessage();<a name="line.157"></a>
<span class="sourceLineNo">158</span> if (null != escapeNewLine) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> message = NEWLINE_PATTERN.matcher(message).replaceAll(escapeNewLine);<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span> buf.append(message);<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> if (includeNewLine) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> buf.append('\n');<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span> return buf.toString();<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> private synchronized void addDate(final long timestamp, final StringBuilder buf) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> final int index = buf.length() + 4;<a name="line.170"></a>
<span class="sourceLineNo">171</span> buf.append(dateFormat.format(new Date(timestamp)));<a name="line.171"></a>
<span class="sourceLineNo">172</span> // RFC 3164 says leading space, not leading zero on days 1-9<a name="line.172"></a>
<span class="sourceLineNo">173</span> if (buf.charAt(index) == '0') {<a name="line.173"></a>
<span class="sourceLineNo">174</span> buf.setCharAt(index, Chars.SPACE);<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span> /**<a name="line.178"></a>
<span class="sourceLineNo">179</span> * Gets this SyslogLayout's content format. Specified by:<a name="line.179"></a>
<span class="sourceLineNo">180</span> * &lt;ul&gt;<a name="line.180"></a>
<span class="sourceLineNo">181</span> * &lt;li&gt;Key: "structured" Value: "false"&lt;/li&gt;<a name="line.181"></a>
<span class="sourceLineNo">182</span> * &lt;li&gt;Key: "dateFormat" Value: "MMM dd HH:mm:ss"&lt;/li&gt;<a name="line.182"></a>
<span class="sourceLineNo">183</span> * &lt;li&gt;Key: "format" Value: "&amp;lt;LEVEL&amp;gt;TIMESTAMP PROP(HOSTNAME) MESSAGE"&lt;/li&gt;<a name="line.183"></a>
<span class="sourceLineNo">184</span> * &lt;li&gt;Key: "formatType" Value: "logfilepatternreceiver" (format uses the keywords supported by<a name="line.184"></a>
<span class="sourceLineNo">185</span> * LogFilePatternReceiver)&lt;/li&gt;<a name="line.185"></a>
<span class="sourceLineNo">186</span> * &lt;/ul&gt;<a name="line.186"></a>
<span class="sourceLineNo">187</span> *<a name="line.187"></a>
<span class="sourceLineNo">188</span> * @return Map of content format keys supporting SyslogLayout<a name="line.188"></a>
<span class="sourceLineNo">189</span> */<a name="line.189"></a>
<span class="sourceLineNo">190</span> @Override<a name="line.190"></a>
<span class="sourceLineNo">191</span> public Map&lt;String, String&gt; getContentFormat() {<a name="line.191"></a>
<span class="sourceLineNo">192</span> final Map&lt;String, String&gt; result = new HashMap&lt;&gt;();<a name="line.192"></a>
<span class="sourceLineNo">193</span> result.put("structured", "false");<a name="line.193"></a>
<span class="sourceLineNo">194</span> result.put("formatType", "logfilepatternreceiver");<a name="line.194"></a>
<span class="sourceLineNo">195</span> result.put("dateFormat", dateFormat.toPattern());<a name="line.195"></a>
<span class="sourceLineNo">196</span> result.put("format", "&lt;LEVEL&gt;TIMESTAMP PROP(HOSTNAME) MESSAGE");<a name="line.196"></a>
<span class="sourceLineNo">197</span> return result;<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span> /**<a name="line.200"></a>
<span class="sourceLineNo">201</span> * Creates a SyslogLayout.<a name="line.201"></a>
<span class="sourceLineNo">202</span> *<a name="line.202"></a>
<span class="sourceLineNo">203</span> * @param facility The Facility is used to try to classify the message.<a name="line.203"></a>
<span class="sourceLineNo">204</span> * @param includeNewLine If true a newline will be appended to the result.<a name="line.204"></a>
<span class="sourceLineNo">205</span> * @param escapeNL Pattern to use for replacing newlines.<a name="line.205"></a>
<span class="sourceLineNo">206</span> * @param charset The character set.<a name="line.206"></a>
<span class="sourceLineNo">207</span> * @return A SyslogLayout.<a name="line.207"></a>
<span class="sourceLineNo">208</span> * @deprecated Use {@link #newBuilder()}.<a name="line.208"></a>
<span class="sourceLineNo">209</span> */<a name="line.209"></a>
<span class="sourceLineNo">210</span> @Deprecated<a name="line.210"></a>
<span class="sourceLineNo">211</span> public static SyslogLayout createLayout(final Facility facility, final boolean includeNewLine,<a name="line.211"></a>
<span class="sourceLineNo">212</span> final String escapeNL, final Charset charset) {<a name="line.212"></a>
<span class="sourceLineNo">213</span> return new SyslogLayout(facility, includeNewLine, escapeNL, charset);<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span><a name="line.215"></a>
<span class="sourceLineNo">216</span> /**<a name="line.216"></a>
<span class="sourceLineNo">217</span> * Gets the facility.<a name="line.217"></a>
<span class="sourceLineNo">218</span> *<a name="line.218"></a>
<span class="sourceLineNo">219</span> * @return the facility<a name="line.219"></a>
<span class="sourceLineNo">220</span> */<a name="line.220"></a>
<span class="sourceLineNo">221</span> public Facility getFacility() {<a name="line.221"></a>
<span class="sourceLineNo">222</span> return facility;<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span>}<a name="line.224"></a>
</pre>
</div>
</body>
</html>