createAppender
@PluginFactory
public static SyslogAppender createAppender(@PluginAttribute(value="host")
String host,
@PluginAttribute(value="port",defaultInt=0)
int port,
@PluginAttribute(value="protocol")
String protocolStr,
@PluginElement(value="SSL")
SslConfiguration sslConfig,
@PluginAttribute(value="connectTimeoutMillis",defaultInt=0)
int connectTimeoutMillis,
@PluginAliases(value="reconnectionDelay")@PluginAttribute(value="reconnectionDelayMillis",defaultInt=0)
int reconnectionDelayMillis,
@PluginAttribute(value="immediateFail",defaultBoolean=true)
boolean immediateFail,
@PluginAttribute(value="name")
String name,
@PluginAttribute(value="immediateFlush",defaultBoolean=true)
boolean immediateFlush,
@PluginAttribute(value="ignoreExceptions",defaultBoolean=true)
boolean ignoreExceptions,
@PluginAttribute(value="facility",defaultString="LOCAL0")
Facility facility,
@PluginAttribute(value="id")
String id,
@PluginAttribute(value="enterpriseNumber",defaultInt=18060)
int enterpriseNumber,
@PluginAttribute(value="includeMdc",defaultBoolean=true)
boolean includeMdc,
@PluginAttribute(value="mdcId")
String mdcId,
@PluginAttribute(value="mdcPrefix")
String mdcPrefix,
@PluginAttribute(value="eventPrefix")
String eventPrefix,
@PluginAttribute(value="newLine",defaultBoolean=false)
boolean newLine,
@PluginAttribute(value="newLineEscape")
String escapeNL,
@PluginAttribute(value="appName")
String appName,
@PluginAttribute(value="messageId")
String msgId,
@PluginAttribute(value="mdcExcludes")
String excludes,
@PluginAttribute(value="mdcIncludes")
String includes,
@PluginAttribute(value="mdcRequired")
String required,
@PluginAttribute(value="format")
String format,
@PluginElement(value="Filter")
Filter filter,
@PluginConfiguration
Configuration config,
@PluginAttribute(value="charset",defaultString="UTF-8")
Charset charsetName,
@PluginAttribute(value="exceptionPattern")
String exceptionPattern,
@PluginElement(value="LoggerFields")
LoggerFields[] loggerFields,
@PluginAttribute(value="advertise",defaultBoolean=false)
boolean advertise)
Create a SyslogAppender.
- Parameters:
host
- The name of the host to connect to.port
- The port to connect to on the target host.protocolStr
- The Protocol to use.sslConfig
- TODOconnectTimeoutMillis
- the connect timeout in milliseconds.reconnectionDelayMillis
- 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.ignoreExceptions
- If "true"
(default) exceptions encountered when appending events are logged;
otherwise they are propagated to the caller.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.enterpriseNumber
- 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.newLine
- 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 fieldsadvertise
- Whether to advertise
- Returns:
- A SyslogAppender.