org.apache.logging.log4j.core.appender
Class SyslogAppender<T extends Serializable>

java.lang.Object
  extended by org.apache.logging.log4j.core.filter.AbstractFilterable
      extended by org.apache.logging.log4j.core.appender.AbstractAppender<T>
          extended by org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<T>
              extended by org.apache.logging.log4j.core.appender.SocketAppender<T>
                  extended by org.apache.logging.log4j.core.appender.SyslogAppender<T>
Type Parameters:
T - The Layout's Serializable type.
All Implemented Interfaces:
Appender<T>, Filterable, LifeCycle

public class SyslogAppender<T extends Serializable>
extends SocketAppender<T>

The Syslog Appender.


Field Summary
 
Fields inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender
immediateFlush
 
Fields inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
LOGGER
 
Constructor Summary
protected SyslogAppender(String name, Layout<T> layout, Filter filter, boolean handleException, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser)
           
 
Method Summary
static
<S extends Serializable>
SyslogAppender<S>
createAppender(String host, String portNum, String protocol, String delay, String immediateFail, String name, String immediateFlush, String suppress, String facility, String id, String ein, String includeMDC, String mdcId, String mdcPrefix, String eventPrefix, String includeNL, String escapeNL, String appName, String msgId, String excludes, String includes, String required, String format, Filter filter, Configuration config, String charsetName, String exceptionPattern, LoggerFields loggerFields, String advertise)
          Create a SyslogAppender.
 
Methods inherited from class org.apache.logging.log4j.core.appender.SocketAppender
createAppender, createSocketManager, stop
 
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender
append, getManager, replaceManager, start
 
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
error, error, error, getHandler, getLayout, getName, isExceptionSuppressed, isStarted, parseInt, setHandler, toString
 
Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, hasFilter, isFiltered, removeFilter, startFilter, stopFilter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SyslogAppender

protected SyslogAppender(String name,
                         Layout<T> layout,
                         Filter filter,
                         boolean handleException,
                         boolean immediateFlush,
                         AbstractSocketManager manager,
                         Advertiser advertiser)
Method Detail

createAppender

public static <S extends Serializable> SyslogAppender<S> createAppender(String host,
                                                                        String portNum,
                                                                        String protocol,
                                                                        String delay,
                                                                        String immediateFail,
                                                                        String name,
                                                                        String immediateFlush,
                                                                        String suppress,
                                                                        String facility,
                                                                        String id,
                                                                        String ein,
                                                                        String includeMDC,
                                                                        String mdcId,
                                                                        String mdcPrefix,
                                                                        String eventPrefix,
                                                                        String includeNL,
                                                                        String escapeNL,
                                                                        String appName,
                                                                        String msgId,
                                                                        String excludes,
                                                                        String includes,
                                                                        String required,
                                                                        String format,
                                                                        Filter filter,
                                                                        Configuration config,
                                                                        String charsetName,
                                                                        String exceptionPattern,
                                                                        LoggerFields loggerFields,
                                                                        String advertise)
Create a SyslogAppender.

Type Parameters:
S - The Layout's Serializable type.
Parameters:
host - The name of the host to connect to.
portNum - The port to connect to on the target host.
protocol - The Protocol to use.
delay - The interval in which failed writes should be retried.
immediateFail - True if the write should fail if no socket is immediately available.
name - The name of the Appender.
immediateFlush - "true" if data should be flushed on each write.
suppress - "true" if exceptions should be hidden from the application, "false" otherwise. The default is "true".
facility - The Facility is used to try to classify the message.
id - The default structured data id to use when formatting according to RFC 5424.
ein - The IANA enterprise number.
includeMDC - Indicates whether data from the ThreadContextMap will be included in the RFC 5424 Syslog record. Defaults to "true:.
mdcId - The id to use for the MDC Structured Data Element.
mdcPrefix - The prefix to add to MDC key names.
eventPrefix - The prefix to add to event key names.
includeNL - If true, a newline will be appended to the end of the syslog record. The default is false.
escapeNL - String that should be used to replace newlines within the message text.
appName - The value to use as the APP-NAME in the RFC 5424 syslog record.
msgId - The default value to be used in the MSGID field of RFC 5424 syslog records.
excludes - A comma separated list of mdc keys that should be excluded from the LogEvent.
includes - A comma separated list of mdc keys that should be included in the FlumeEvent.
required - A comma separated list of mdc keys that must be present in the MDC.
format - If set to "RFC5424" the data will be formatted in accordance with RFC 5424. Otherwise, it will be formatted as a BSD Syslog record.
filter - A Filter to determine if the event should be handled by this Appender.
config - The Configuration.
charsetName - The character set to use when converting the syslog String to a byte array.
exceptionPattern - The converter pattern to use for formatting exceptions.
loggerFields - The logger fields
advertise - Whether to advertise
Returns:
A SyslogAppender.


Copyright © 1999-2013 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.