| <!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.io.IOException;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.Writer;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.nio.charset.Charset;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.nio.charset.StandardCharsets;<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.Map;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Layout;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.DefaultConfiguration;<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.plugins.Plugin;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<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.util.KeyValuePair;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Appends a series of JSON events as strings serialized as bytes.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> *<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <h3>Complete well-formed JSON vs. fragment JSON</h3><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * If you configure {@code complete="true"}, the appender outputs a well-formed JSON document. By default, with<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * {@code complete="false"}, you should include the output as an <em>external file</em> in a separate file to form a<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * well-formed JSON document.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * </p><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <p><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * If {@code complete="false"}, the appender does not write the JSON open array character "[" at the start<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * of the document, "]" and the end, nor comma "," between records.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * </p><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <h3>Encoding</h3><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Appenders using this layout should have their {@code charset} set to {@code UTF-8} or {@code UTF-16}, otherwise<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * events containing non ASCII characters could result in corrupted log files.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * </p><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <h3>Pretty vs. compact JSON</h3><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <p><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * By default, the JSON layout is not compact (a.k.a. "pretty") with {@code compact="false"}, which means the<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * appender uses end-of-line characters and indents lines to format the text. If {@code compact="true"}, then no<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * end-of-line or indentation is used. Message content may contain, of course, escaped end-of-lines.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * </p><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <h3>Additional Fields</h3><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <p><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * This property allows addition of custom fields into generated JSON.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * {@code <JsonLayout><KeyValuePair key="foo" value="bar"/></JsonLayout>} inserts {@code "foo":"bar"} directly<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * into JSON output. Supports Lookup expressions.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * </p><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span>@Plugin(name = "JsonLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)<a name="line.68"></a> |
| <span class="sourceLineNo">069</span>public final class JsonLayout extends AbstractJacksonLayout {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> private static final String DEFAULT_FOOTER = "]";<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private static final String DEFAULT_HEADER = "[";<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> static final String CONTENT_TYPE = "application/json";<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> public static class Builder<B extends Builder<B>> extends AbstractJacksonLayout.Builder<B><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> implements org.apache.logging.log4j.core.util.Builder<JsonLayout> {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> @PluginBuilderAttribute<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private boolean propertiesAsList;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> @PluginBuilderAttribute<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private boolean objectMessageAsJsonObject;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> @PluginElement("AdditionalField")<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> private KeyValuePair[] additionalFields;<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> public Builder() {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> super();<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> setCharset(StandardCharsets.UTF_8);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> @Override<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> public JsonLayout build() {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> final boolean encodeThreadContextAsList = isProperties() && propertiesAsList;<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> final String headerPattern = toStringOrNull(getHeader());<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> final String footerPattern = toStringOrNull(getFooter());<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> return new JsonLayout(getConfiguration(), isLocationInfo(), isProperties(), encodeThreadContextAsList,<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> isComplete(), isCompact(), getEventEol(), getEndOfLine(), headerPattern, footerPattern, getCharset(),<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> isIncludeStacktrace(), isStacktraceAsString(), isIncludeNullDelimiter(), isIncludeTimeMillis(),<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> getAdditionalFields(), getObjectMessageAsJsonObject());<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public boolean isPropertiesAsList() {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> return propertiesAsList;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public B setPropertiesAsList(final boolean propertiesAsList) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> this.propertiesAsList = propertiesAsList;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> return asBuilder();<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> public boolean getObjectMessageAsJsonObject() {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return objectMessageAsJsonObject;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public B setObjectMessageAsJsonObject(final boolean objectMessageAsJsonObject) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> this.objectMessageAsJsonObject = objectMessageAsJsonObject;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> return asBuilder();<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> @Override<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> public KeyValuePair[] getAdditionalFields() {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> return additionalFields;<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> @Override<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> public B setAdditionalFields(final KeyValuePair[] additionalFields) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> this.additionalFields = additionalFields;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> return asBuilder();<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> }<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> /**<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @deprecated Use {@link #newBuilder()} instead<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> */<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> @Deprecated<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> protected JsonLayout(final Configuration config, final boolean locationInfo, final boolean properties,<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> final boolean encodeThreadContextAsList,<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> final boolean complete, final boolean compact, final boolean eventEol, final String endOfLine,final String headerPattern,<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> final String footerPattern, final Charset charset, final boolean includeStacktrace) {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> super(config, new JacksonFactory.JSON(encodeThreadContextAsList, includeStacktrace, false, false).newWriter(<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> locationInfo, properties, compact),<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> charset, compact, complete, eventEol, endOfLine,<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(headerPattern).setDefaultPattern(DEFAULT_HEADER).build(),<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(footerPattern).setDefaultPattern(DEFAULT_FOOTER).build(),<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> false, null);<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> private JsonLayout(final Configuration config, final boolean locationInfo, final boolean properties,<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> final boolean encodeThreadContextAsList,<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> final boolean complete, final boolean compact, final boolean eventEol, final String endOfLine,<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> final String headerPattern, final String footerPattern, final Charset charset,<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> final boolean includeStacktrace, final boolean stacktraceAsString,<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> final boolean includeNullDelimiter, final boolean includeTimeMillis,<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> final KeyValuePair[] additionalFields, final boolean objectMessageAsJsonObject) {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> super(config, new JacksonFactory.JSON(encodeThreadContextAsList, includeStacktrace, stacktraceAsString, objectMessageAsJsonObject).newWriter(<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> locationInfo, properties, compact, includeTimeMillis),<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> charset, compact, complete, eventEol, endOfLine,<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(headerPattern).setDefaultPattern(DEFAULT_HEADER).build(),<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(footerPattern).setDefaultPattern(DEFAULT_FOOTER).build(),<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> includeNullDelimiter,<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> additionalFields);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> /**<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * Returns appropriate JSON header.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> *<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @return a byte array containing the header, opening the JSON array.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> @Override<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> public byte[] getHeader() {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> if (!this.complete) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> return null;<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> final StringBuilder buf = new StringBuilder();<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> final String str = serializeToString(getHeaderSerializer());<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> if (str != null) {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> buf.append(str);<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> }<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> buf.append(this.eol);<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> return getBytes(buf.toString());<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> |
| <span class="sourceLineNo">186</span> /**<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * Returns appropriate JSON footer.<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> *<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @return a byte array containing the footer, closing the JSON array.<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> */<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> @Override<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> public byte[] getFooter() {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> if (!this.complete) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return null;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> final StringBuilder buf = new StringBuilder();<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> buf.append(this.eol);<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> final String str = serializeToString(getFooterSerializer());<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> if (str != null) {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> buf.append(str);<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> }<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> buf.append(this.eol);<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> return getBytes(buf.toString());<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> @Override<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> public Map<String, String> getContentFormat() {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> final Map<String, String> result = new HashMap<>();<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> result.put("version", "2.0");<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> return result;<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span><a name="line.212"></a> |
| <span class="sourceLineNo">213</span> /**<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * @return The content type.<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> */<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> @Override<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> public String getContentType() {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> return CONTENT_TYPE + "; charset=" + this.getCharset();<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> /**<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * Creates a JSON Layout.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @param config<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * The plugin configuration.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * @param locationInfo<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * If "true", includes the location information in the generated JSON.<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * @param properties<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * If "true", includes the thread context map in the generated JSON.<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * @param propertiesAsList<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * If true, the thread context map is included as a list of map entry objects, where each entry has<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * a "key" attribute (whose value is the key) and a "value" attribute (whose value is the value).<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * Defaults to false, in which case the thread context map is included as a simple map of key-value<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * pairs.<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * @param complete<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * If "true", includes the JSON header and footer, and comma between records.<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @param compact<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * If "true", does not use end-of-lines and indentation, defaults to "false".<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @param eventEol<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * If "true", forces an EOL after each log event (even if compact is "true"), defaults to "false". This<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * allows one even per line, even in compact mode.<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * @param headerPattern<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * The header pattern, defaults to {@code "["} if null.<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * @param footerPattern<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * The header pattern, defaults to {@code "]"} if null.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @param charset<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * The character set to use, if {@code null}, uses "UTF-8".<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @param includeStacktrace<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @return A JSON Layout.<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> *<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * @deprecated Use {@link #newBuilder()} instead<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> */<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> @Deprecated<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> public static JsonLayout createLayout(<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> final Configuration config,<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> final boolean locationInfo,<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> final boolean properties,<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> final boolean propertiesAsList,<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> final boolean complete,<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> final boolean compact,<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> final boolean eventEol,<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> final String headerPattern,<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> final String footerPattern,<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> final Charset charset,<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> final boolean includeStacktrace) {<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> final boolean encodeThreadContextAsList = properties && propertiesAsList;<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> return new JsonLayout(config, locationInfo, properties, encodeThreadContextAsList, complete, compact, eventEol,<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> null, headerPattern, footerPattern, charset, includeStacktrace, false, false, false, null, false);<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> }<a name="line.269"></a> |
| <span class="sourceLineNo">270</span><a name="line.270"></a> |
| <span class="sourceLineNo">271</span> @PluginBuilderFactory<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> public static <B extends Builder<B>> B newBuilder() {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> return new Builder<B>().asBuilder();<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> /**<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * Creates a JSON Layout using the default settings. Useful for testing.<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> *<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * @return A JSON Layout.<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> */<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> public static JsonLayout createDefaultLayout() {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> return new JsonLayout(new DefaultConfiguration(), false, false, false, false, false, false, null,<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> DEFAULT_HEADER, DEFAULT_FOOTER, StandardCharsets.UTF_8, true, false, false, false, null, false);<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> }<a name="line.284"></a> |
| <span class="sourceLineNo">285</span><a name="line.285"></a> |
| <span class="sourceLineNo">286</span> @Override<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> public void toSerializable(final LogEvent event, final Writer writer) throws IOException {<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> if (complete && eventCount > 0) {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> writer.append(", ");<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> }<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> super.toSerializable(event, writer);<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> }<a name="line.292"></a> |
| <span class="sourceLineNo">293</span>}<a name="line.293"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
