Package org.apache.log4j.layout
Class Log4j1SyslogLayout
- java.lang.Object
-
- org.apache.logging.log4j.core.layout.AbstractLayout<java.lang.String>
-
- org.apache.logging.log4j.core.layout.AbstractStringLayout
-
- org.apache.log4j.layout.Log4j1SyslogLayout
-
- All Implemented Interfaces:
LocationAware
,Layout<java.lang.String>
,Encoder<LogEvent>
,StringLayout
@Plugin(name="Log4j1SyslogLayout", category="Core", elementType="layout", printObject=true) public final class Log4j1SyslogLayout extends AbstractStringLayout
Port of the layout used by SyslogAppender in Log4j 1.x. Provided for compatibility with existing Log4j 1 configurations. Originally developed by Ceki Gülcü and Anders Kristensen.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Log4j1SyslogLayout.Builder<B extends Log4j1SyslogLayout.Builder<B>>
Builds a SyslogLayout.-
Nested classes/interfaces inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout
AbstractStringLayout.Serializer, AbstractStringLayout.Serializer2
-
-
Field Summary
Fields Modifier and Type Field Description private LogEventPatternConverter
dateConverter
private static java.lang.String[]
dateFormatOptions
Date format used if header = true.private Facility
facility
private boolean
facilityPrinting
private boolean
header
private static java.lang.String
localHostname
Host name used to identify messages from this appender.private StringLayout
messageLayout
-
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, LOGGER
-
Fields inherited from interface org.apache.logging.log4j.core.Layout
ELEMENT_TYPE
-
-
Constructor Summary
Constructors Modifier Constructor Description private
Log4j1SyslogLayout(Facility facility, boolean facilityPrinting, boolean header, StringLayout messageLayout, java.nio.charset.Charset charset)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.String>
getContentFormat()
Gets this SyslogLayout's content format.static <B extends Log4j1SyslogLayout.Builder<B>>
BnewBuilder()
java.lang.String
toSerializable(LogEvent event)
Formats aLogEvent
in conformance with the BSD Log record format.-
Methods inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout
getBytes, getCharset, getContentType, getFooter, getFooterSerializer, getHeader, getHeaderSerializer, getStringBuilder, getStringBuilderEncoder, requiresLocation, serializeToBytes, serializeToString, toByteArray, trimToMaxSize
-
Methods inherited from class org.apache.logging.log4j.core.layout.AbstractLayout
encode, getConfiguration, markEvent
-
-
-
-
Field Detail
-
localHostname
private static final java.lang.String localHostname
Host name used to identify messages from this appender.
-
facility
private final Facility facility
-
facilityPrinting
private final boolean facilityPrinting
-
header
private final boolean header
-
messageLayout
private final StringLayout messageLayout
-
dateFormatOptions
private static final java.lang.String[] dateFormatOptions
Date format used if header = true.
-
dateConverter
private final LogEventPatternConverter dateConverter
-
-
Constructor Detail
-
Log4j1SyslogLayout
private Log4j1SyslogLayout(Facility facility, boolean facilityPrinting, boolean header, StringLayout messageLayout, java.nio.charset.Charset charset)
-
-
Method Detail
-
newBuilder
@PluginBuilderFactory public static <B extends Log4j1SyslogLayout.Builder<B>> B newBuilder()
-
toSerializable
public java.lang.String toSerializable(LogEvent event)
Formats aLogEvent
in conformance with the BSD Log record format.- Parameters:
event
- The LogEvent- Returns:
- the event formatted as a String.
-
getContentFormat
public java.util.Map<java.lang.String,java.lang.String> getContentFormat()
Gets this SyslogLayout's content format. Specified by:- Key: "structured" Value: "false"
- Key: "dateFormat" Value: "MMM dd HH:mm:ss"
- Key: "format" Value: "<LEVEL>TIMESTAMP PROP(HOSTNAME) MESSAGE"
- Key: "formatType" Value: "logfilepatternreceiver" (format uses the keywords supported by LogFilePatternReceiver)
- Specified by:
getContentFormat
in interfaceLayout<java.lang.String>
- Overrides:
getContentFormat
in classAbstractLayout<java.lang.String>
- Returns:
- Map of content format keys supporting SyslogLayout
-
-