001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.layout;
018
019import java.io.IOException;
020import java.nio.charset.Charset;
021
022import org.apache.commons.csv.CSVFormat;
023import org.apache.commons.csv.CSVPrinter;
024import org.apache.commons.csv.QuoteMode;
025import org.apache.logging.log4j.core.Layout;
026import org.apache.logging.log4j.core.LogEvent;
027import org.apache.logging.log4j.core.config.Node;
028import org.apache.logging.log4j.core.config.plugins.Plugin;
029import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
030import org.apache.logging.log4j.core.config.plugins.PluginFactory;
031import org.apache.logging.log4j.status.StatusLogger;
032
033/**
034 * A Comma-Separated Value (CSV) layout to log events.
035 * 
036 * Depends on Apache Commons CSV 1.2.
037 * 
038 * @since 2.4
039 */
040@Plugin(name = "CsvLogEventLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)
041public class CsvLogEventLayout extends AbstractCsvLayout {
042
043    private static final long serialVersionUID = 1L;
044    
045    public static CsvLogEventLayout createDefaultLayout() {
046        return new CsvLogEventLayout(Charset.forName(DEFAULT_CHARSET), CSVFormat.valueOf(DEFAULT_FORMAT), null, null);
047    }
048
049    public static CsvLogEventLayout createLayout(final CSVFormat format) {
050        return new CsvLogEventLayout(Charset.forName(DEFAULT_CHARSET), format, null, null);
051    }
052
053    @PluginFactory
054    public static CsvLogEventLayout createLayout(
055            // @formatter:off
056            @PluginAttribute(value = "format", defaultString = DEFAULT_FORMAT) final String format,
057            @PluginAttribute("delimiter") final Character delimiter,
058            @PluginAttribute("escape") final Character escape,
059            @PluginAttribute("quote") final Character quote,
060            @PluginAttribute("quoteMode") final QuoteMode quoteMode,
061            @PluginAttribute("nullString") final String nullString,
062            @PluginAttribute("recordSeparator") final String recordSeparator,
063            @PluginAttribute(value = "charset", defaultString = DEFAULT_CHARSET) final Charset charset,
064            @PluginAttribute("header") final String header,
065            @PluginAttribute("footer") final String footer)
066            // @formatter:on
067    {
068
069        final CSVFormat csvFormat = createFormat(format, delimiter, escape, quote, quoteMode, nullString, recordSeparator);
070        return new CsvLogEventLayout(charset, csvFormat, header, footer);
071    }
072   
073    protected CsvLogEventLayout(final Charset charset, final CSVFormat csvFormat, final String header, final String footer) {
074        super(charset, csvFormat, header, footer);
075    }
076
077    @Override
078    public String toSerializable(final LogEvent event) {
079        final StringBuilder buffer = getStringBuilder();
080        // Revisit when 1.3 is out so that we do not need to create a new
081        // printer for each event.
082        // No need to close the printer.
083        try (final CSVPrinter printer = new CSVPrinter(buffer, getFormat())) {
084            printer.print(event.getNanoTime());
085            printer.print(event.getTimeMillis());
086            printer.print(event.getLevel());
087            printer.print(event.getThreadName());
088            printer.print(event.getMessage().getFormattedMessage());
089            printer.print(event.getLoggerFqcn());
090            printer.print(event.getLoggerName());
091            printer.print(event.getMarker());
092            printer.print(event.getThrownProxy());
093            printer.print(event.getSource());
094            printer.print(event.getContextMap());
095            printer.print(event.getContextStack());
096            printer.println();
097            return buffer.toString();
098        } catch (final IOException e) {
099            StatusLogger.getLogger().error(event.toString(), e);
100            return getFormat().getCommentMarker() + " " + e;
101        }
102    }
103
104}