| <!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.nio.charset.Charset;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.commons.csv.CSVFormat;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.commons.csv.QuoteMode;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.Layout;<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.config.Configuration;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.Node;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>/**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * A Comma-Separated Value (CSV) layout to log events.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> *<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Depends on Apache Commons CSV 1.2.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @since 2.4<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>@Plugin(name = "CsvLogEventLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>public class CsvLogEventLayout extends AbstractCsvLayout {<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public static CsvLogEventLayout createDefaultLayout() {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> return new CsvLogEventLayout(null, Charset.forName(DEFAULT_CHARSET), CSVFormat.valueOf(DEFAULT_FORMAT), null, null);<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> }<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> public static CsvLogEventLayout createLayout(final CSVFormat format) {<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> return new CsvLogEventLayout(null, Charset.forName(DEFAULT_CHARSET), format, null, null);<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> }<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> @PluginFactory<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> public static CsvLogEventLayout createLayout(<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> // @formatter:off<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> @PluginConfiguration final Configuration config,<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> @PluginAttribute(value = "format", defaultString = DEFAULT_FORMAT) final String format,<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> @PluginAttribute("delimiter") final Character delimiter,<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> @PluginAttribute("escape") final Character escape,<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> @PluginAttribute("quote") final Character quote,<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> @PluginAttribute("quoteMode") final QuoteMode quoteMode,<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> @PluginAttribute("nullString") final String nullString,<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> @PluginAttribute("recordSeparator") final String recordSeparator,<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> @PluginAttribute(value = "charset", defaultString = DEFAULT_CHARSET) final Charset charset,<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> @PluginAttribute("header") final String header,<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> @PluginAttribute("footer") final String footer)<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> // @formatter:on<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> final CSVFormat csvFormat = createFormat(format, delimiter, escape, quote, quoteMode, nullString, recordSeparator);<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> return new CsvLogEventLayout(config, charset, csvFormat, header, footer);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> }<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> protected CsvLogEventLayout(final Configuration config, final Charset charset, final CSVFormat csvFormat, final String header, final String footer) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> super(config, charset, csvFormat, header, footer);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> }<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> @Override<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public String toSerializable(final LogEvent event) {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> final StringBuilder buffer = getStringBuilder();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> final CSVFormat format = getFormat();<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> try {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> format.print(event.getNanoTime(), buffer, true);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> format.print(event.getTimeMillis(), buffer, false);<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> format.print(event.getLevel(), buffer, false);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> format.print(event.getThreadId(), buffer, false);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> format.print(event.getThreadName(), buffer, false);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> format.print(event.getThreadPriority(), buffer, false);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> format.print(event.getMessage().getFormattedMessage(), buffer, false);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> format.print(event.getLoggerFqcn(), buffer, false);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> format.print(event.getLoggerName(), buffer, false);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> format.print(event.getMarker(), buffer, false);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> format.print(event.getThrownProxy(), buffer, false);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> format.print(event.getSource(), buffer, false);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> format.print(event.getContextData(), buffer, false);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> format.print(event.getContextStack(), buffer, false);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> format.println(buffer);<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> return buffer.toString();<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> } catch (final IOException e) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> StatusLogger.getLogger().error(event.toString(), e);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> return format.getCommentMarker() + " " + e;<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
