Class SyslogLayout

java.lang.Object

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

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

org.apache.logging.log4j.core.layout.SyslogLayout

All Implemented Interfaces:

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

@Plugin(name="SyslogLayout",
        category="Core",
        elementType="layout",
        printObject=true)
public final class SyslogLayout
extends AbstractStringLayout

Formats a log event as a BSD Log record.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SyslogLayout.Builder<B extends SyslogLayout.Builder<B>>	Builds a SyslogLayout.

Nested classes/interfaces inherited from class AbstractStringLayout

AbstractStringLayout.Serializer, AbstractStringLayout.Serializer2

Field Summary

Fields

Modifier and Type	Field	Description
private final SimpleDateFormat	dateFormat	Date format used if header = true.
private final String	escapeNewLine
private final Facility	facility
private final boolean	includeNewLine
private final String	localHostname	Host name used to identify messages from this appender.
static final Pattern	NEWLINE_PATTERN	Match newlines in a platform-independent manner.

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

Modifier	Constructor	Description
protected	SyslogLayout(Facility facility, boolean includeNL, String escapeNL, Charset charset)

Method Summary

Modifier and Type	Method	Description
private void	addDate(long timestamp, StringBuilder buf)
static SyslogLayout	createLayout(Facility facility, boolean includeNewLine, String escapeNL, Charset charset)	Deprecated. Use newBuilder().
Map<String,String>	getContentFormat()	Gets this SyslogLayout's content format.
Facility	getFacility()	Gets the facility.
static <B extends SyslogLayout.Builder<B>> B	newBuilder()
String	toSerializable(LogEvent event)	Formats a LogEvent in conformance with the BSD Log record format.

Methods inherited from class AbstractStringLayout

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

Methods inherited from class AbstractLayout

encode, getConfiguration, markEvent

Methods inherited from class Object

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

Methods inherited from interface Encoder

encode

Field Details

NEWLINE_PATTERN

public static final Pattern NEWLINE_PATTERN

Match newlines in a platform-independent manner.

facility

private final Facility facility

includeNewLine

private final boolean includeNewLine

escapeNewLine

private final String escapeNewLine

dateFormat

private final SimpleDateFormat dateFormat

Date format used if header = true.

localHostname

private final String localHostname

Host name used to identify messages from this appender.

Constructor Details

SyslogLayout

protected SyslogLayout(Facility facility,
 boolean includeNL,
 String escapeNL,
 Charset charset)

Method Details

newBuilder

@PluginBuilderFactory
public static <B extends SyslogLayout.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.

addDate

private void addDate(long timestamp,
 StringBuilder buf)

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

createLayout

@Deprecated
public static SyslogLayout createLayout(Facility facility,
 boolean includeNewLine,
 String escapeNL,
 Charset charset)

Deprecated.

Use newBuilder().

Creates a SyslogLayout.

Parameters:

facility - The Facility is used to try to classify the message.

includeNewLine - If true a newline will be appended to the result.

escapeNL - Pattern to use for replacing newlines.

charset - The character set.

Returns:

A SyslogLayout.

getFacility

public Facility getFacility()

Gets the facility.

Returns:

the facility