Class CsvParameterLayout

java.lang.Object

org.apache.logging.log4j.core.layout.AbstractLayout<String>

org.apache.logging.log4j.core.layout.AbstractStringLayout

org.apache.logging.log4j.core.layout.AbstractCsvLayout

org.apache.logging.log4j.core.layout.CsvParameterLayout

All Implemented Interfaces:

LocationAware, Layout<String>, Encoder<LogEvent>, StringLayout

@Plugin(name="CsvParameterLayout",
        category="Core",
        elementType="layout",
        printObject=true)
public class CsvParameterLayout
extends AbstractCsvLayout

A Comma-Separated Value (CSV) layout to log event parameters. The event message is currently ignored.

Best used with:

logger.debug(new ObjectArrayMessage(1, 2, "Bob"));

Depends on Apache Commons CSV 1.4.

Since:

2.4

Nested Class Summary

Nested classes/interfaces inherited from class AbstractStringLayout

AbstractStringLayout.Builder<B>, AbstractStringLayout.Serializer, AbstractStringLayout.Serializer2

Field Summary

Fields inherited from class AbstractCsvLayout

DEFAULT_CHARSET, DEFAULT_FORMAT

Fields inherited from class AbstractStringLayout

DEFAULT_STRING_BUILDER_SIZE, MAX_STRING_BUILDER_SIZE

Fields inherited from class AbstractLayout

configuration, eventCount, footer, header, LOGGER

Fields inherited from interface Layout

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor	Description
CsvParameterLayout(Configuration config, Charset charset, org.apache.commons.csv.CSVFormat csvFormat, String header, String footer)

Method Summary

Modifier and Type	Method	Description
static AbstractCsvLayout	createDefaultLayout()
static AbstractCsvLayout	createLayout(org.apache.commons.csv.CSVFormat format)
static AbstractCsvLayout	createLayout(Configuration config, String format, Character delimiter, Character escape, Character quote, org.apache.commons.csv.QuoteMode quoteMode, String nullString, String recordSeparator, Charset charset, String header, String footer)
String	toSerializable(LogEvent event)	Formats the event as an Object that can be serialized.

Methods inherited from class AbstractCsvLayout

createFormat, getContentType, getFormat

Methods inherited from class AbstractStringLayout

getBytes, getCharset, getFooter, getFooterSerializer, getHeader, getHeaderSerializer, getStringBuilder, getStringBuilderEncoder, requiresLocation, serializeToBytes, serializeToString, toByteArray, trimToMaxSize

Methods inherited from class AbstractLayout

encode, getConfiguration, getContentFormat, markEvent

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Encoder

encode

Methods inherited from interface Layout

getContentFormat

Constructor Details

CsvParameterLayout

public CsvParameterLayout(Configuration config,
 Charset charset,
 org.apache.commons.csv.CSVFormat csvFormat,
 String header,
 String footer)

Method Details

createDefaultLayout

public static AbstractCsvLayout createDefaultLayout()

createLayout

public static AbstractCsvLayout createLayout(org.apache.commons.csv.CSVFormat format)

createLayout

@PluginFactory
public static AbstractCsvLayout createLayout(@PluginConfiguration
 Configuration config,
 @PluginAttribute(value="format",defaultString="Default")
 String format,
 @PluginAttribute("delimiter")
 Character delimiter,
 @PluginAttribute("escape")
 Character escape,
 @PluginAttribute("quote")
 Character quote,
 @PluginAttribute("quoteMode")
 org.apache.commons.csv.QuoteMode quoteMode,
 @PluginAttribute("nullString")
 String nullString,
 @PluginAttribute("recordSeparator")
 String recordSeparator,
 @PluginAttribute(value="charset",defaultString="UTF-8")
 Charset charset,
 @PluginAttribute("header")
 String header,
 @PluginAttribute("footer")
 String footer)

toSerializable

public String toSerializable(LogEvent event)

Description copied from interface: Layout

Formats the event as an Object that can be serialized.

Parameters:

event - The Logging Event.

Returns:

The formatted event.