Class CsvLogEventLayout
- java.lang.Object
-
- org.apache.logging.log4j.core.layout.AbstractLayout<java.lang.String>
-
- org.apache.logging.log4j.core.layout.AbstractStringLayout
-
- org.apache.logging.log4j.core.layout.AbstractCsvLayout
-
- org.apache.logging.log4j.core.layout.CsvLogEventLayout
-
- All Implemented Interfaces:
Layout<java.lang.String>
,Encoder<LogEvent>
,StringLayout
@Plugin(name="CsvLogEventLayout", category="Core", elementType="layout", printObject=true) public class CsvLogEventLayout extends AbstractCsvLayout
A Comma-Separated Value (CSV) layout to log events. Depends on Apache Commons CSV 1.2.- Since:
- 2.4
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout
AbstractStringLayout.Builder<B extends AbstractStringLayout.Builder<B>>, AbstractStringLayout.Serializer, AbstractStringLayout.Serializer2
-
-
Field Summary
-
Fields inherited from class org.apache.logging.log4j.core.layout.AbstractCsvLayout
DEFAULT_CHARSET, DEFAULT_FORMAT
-
Fields inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout
DEFAULT_STRING_BUILDER_SIZE, MAX_STRING_BUILDER_SIZE
-
Fields inherited from class org.apache.logging.log4j.core.layout.AbstractLayout
configuration, eventCount, footer, header, LOGGER
-
Fields inherited from interface org.apache.logging.log4j.core.Layout
ELEMENT_TYPE
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CsvLogEventLayout(Configuration config, java.nio.charset.Charset charset, org.apache.commons.csv.CSVFormat csvFormat, java.lang.String header, java.lang.String footer)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CsvLogEventLayout
createDefaultLayout()
static CsvLogEventLayout
createLayout(org.apache.commons.csv.CSVFormat format)
static CsvLogEventLayout
createLayout(Configuration config, java.lang.String format, java.lang.Character delimiter, java.lang.Character escape, java.lang.Character quote, org.apache.commons.csv.QuoteMode quoteMode, java.lang.String nullString, java.lang.String recordSeparator, java.nio.charset.Charset charset, java.lang.String header, java.lang.String footer)
java.lang.String
toSerializable(LogEvent event)
Formats the event as an Object that can be serialized.-
Methods inherited from class org.apache.logging.log4j.core.layout.AbstractCsvLayout
createFormat, getContentType, getFormat
-
Methods inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout
getBytes, getCharset, getFooter, getFooterSerializer, getHeader, getHeaderSerializer, getStringBuilder, getStringBuilderEncoder, serializeToBytes, serializeToString, toByteArray, trimToMaxSize
-
Methods inherited from class org.apache.logging.log4j.core.layout.AbstractLayout
encode, getConfiguration, getContentFormat, markEvent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.logging.log4j.core.Layout
getContentFormat
-
-
-
-
Constructor Detail
-
CsvLogEventLayout
protected CsvLogEventLayout(Configuration config, java.nio.charset.Charset charset, org.apache.commons.csv.CSVFormat csvFormat, java.lang.String header, java.lang.String footer)
-
-
Method Detail
-
createDefaultLayout
public static CsvLogEventLayout createDefaultLayout()
-
createLayout
public static CsvLogEventLayout createLayout(org.apache.commons.csv.CSVFormat format)
-
createLayout
@PluginFactory public static CsvLogEventLayout createLayout(@PluginConfiguration Configuration config, @PluginAttribute(value="format",defaultString="Default") java.lang.String format, @PluginAttribute("delimiter") java.lang.Character delimiter, @PluginAttribute("escape") java.lang.Character escape, @PluginAttribute("quote") java.lang.Character quote, @PluginAttribute("quoteMode") org.apache.commons.csv.QuoteMode quoteMode, @PluginAttribute("nullString") java.lang.String nullString, @PluginAttribute("recordSeparator") java.lang.String recordSeparator, @PluginAttribute(value="charset",defaultString="UTF-8") java.nio.charset.Charset charset, @PluginAttribute("header") java.lang.String header, @PluginAttribute("footer") java.lang.String footer)
-
-