org.apache.log4j.layout

Class Log4j1SyslogLayout

java.lang.Object

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

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

org.apache.log4j.layout.Log4j1SyslogLayout

All Implemented Interfaces:

LocationAware, Layout<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 and 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 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

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getContentFormat() Gets this SyslogLayout's content format.
static <B extends Log4j1SyslogLayout.Builder<B>> B	newBuilder()
String	toSerializable(LogEvent event) Formats a LogEvent 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

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.Encoder

encode

Method Detail

newBuilder

@PluginBuilderFactory
public static <B extends Log4j1SyslogLayout.Builder<B>> B newBuilder()

toSerializable

public String toSerializable(LogEvent event)

Formats a LogEvent in conformance with the BSD Log record format.

Parameters:

event - The LogEvent

Returns:

the event formatted as a String.

getContentFormat

public Map<String,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 interface Layout<String>

Overrides:

getContentFormat in class AbstractLayout<String>

Returns:

Map of content format keys supporting SyslogLayout