You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gg...@apache.org on 2014/05/22 16:09:14 UTC
svn commit: r1596876 - in /logging/log4j/log4j2/trunk:
log4j-core/src/main/java/org/apache/logging/log4j/core/appender/
log4j-core/src/main/java/org/apache/logging/log4j/core/net/
log4j-core/src/test/java/org/apache/logging/log4j/core/appender/ log4j-c...
Author: ggregory
Date: Thu May 22 14:09:14 2014
New Revision: 1596876
URL: http://svn.apache.org/r1596876
Log:
Merge secure Syslog appender into regular Syslog appender (just like we did for the socket appender). The secure appender just adds on parameter: an SslConfiguration.
Removed:
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/TlsSyslogAppender.java
Modified:
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SyslogAppender.java
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/net/Protocol.java
logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SyslogAppenderTest.java
logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/TlsSyslogAppenderTest.java
logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/net/server/SslXmlSocketServerTest.java
logging/log4j/log4j2/trunk/src/site/site.xml
logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml
Modified: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java?rev=1596876&r1=1596875&r2=1596876&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java Thu May 22 14:09:14 2014
@@ -33,8 +33,8 @@ import org.apache.logging.log4j.core.net
import org.apache.logging.log4j.core.net.Advertiser;
import org.apache.logging.log4j.core.net.DatagramSocketManager;
import org.apache.logging.log4j.core.net.Protocol;
-import org.apache.logging.log4j.core.net.TcpSocketManager;
import org.apache.logging.log4j.core.net.SslSocketManager;
+import org.apache.logging.log4j.core.net.TcpSocketManager;
import org.apache.logging.log4j.core.net.ssl.SslConfiguration;
import org.apache.logging.log4j.core.util.Booleans;
import org.apache.logging.log4j.util.EnglishEnums;
@@ -56,7 +56,7 @@ public class SocketAppender extends Abst
configuration.putAll(manager.getContentFormat());
configuration.put("contentType", layout.getContentType());
configuration.put("name", name);
- advertisement = advertiser.advertise(configuration);
+ this.advertisement = advertiser.advertise(configuration);
}
this.advertiser = advertiser;
}
@@ -64,8 +64,8 @@ public class SocketAppender extends Abst
@Override
public void stop() {
super.stop();
- if (advertiser != null) {
- advertiser.unadvertise(advertisement);
+ if (this.advertiser != null) {
+ this.advertiser.unadvertise(this.advertisement);
}
}
@@ -106,7 +106,7 @@ public class SocketAppender extends Abst
@PluginAttribute("host") final String host,
@PluginAttribute("port") final String portNum,
@PluginAttribute("protocol") final String protocolStr,
- @PluginElement("SSL") SslConfiguration sslConfig,
+ @PluginElement("SSL") final SslConfiguration sslConfig,
@PluginAttribute("reconnectionDelay") final String delay,
@PluginAttribute("immediateFail") final String immediateFail,
@PluginAttribute("name") final String name,
@@ -132,30 +132,33 @@ public class SocketAppender extends Abst
return null;
}
- Protocol protocol = EnglishEnums.valueOf(Protocol.class,
+ final Protocol protocol = EnglishEnums.valueOf(Protocol.class,
protocolStr != null ? protocolStr : Protocol.TCP.name());
if (protocol == Protocol.UDP) {
isFlush = true;
}
-
+
final AbstractSocketManager manager = createSocketManager(name, protocol, host, port, sslConfig,
reconnectDelay, fail, layout);
- if (manager == null) {
- return null;
- }
return new SocketAppender(name, layout, filter, manager, ignoreExceptions, isFlush,
isAdvertise ? config.getAdvertiser() : null);
}
+ /**
+ * Creates an AbstractSocketManager for TCP, UDP, and SSL.
+ *
+ * @throws IllegalArgumentException
+ * if the protocol cannot be handled.
+ */
protected static AbstractSocketManager createSocketManager(final String name, Protocol protocol, final String host,
- final int port, SslConfiguration sslConfig, final int delay, final boolean immediateFail,
+ final int port, final SslConfiguration sslConfig, final int delay, final boolean immediateFail,
final Layout<? extends Serializable> layout) {
if (protocol == Protocol.TCP && sslConfig != null) {
// Upgrade TCP to SSL if an SSL config is specified.
- protocol = Protocol.TLS;
+ protocol = Protocol.SSL;
}
- if (protocol != Protocol.TLS && sslConfig != null) {
+ if (protocol != Protocol.SSL && sslConfig != null) {
LOGGER.info("Appender {} ignoring SSL configuration for {} protocol", name, protocol);
}
switch (protocol) {
@@ -163,7 +166,7 @@ public class SocketAppender extends Abst
return TcpSocketManager.getSocketManager(host, port, delay, immediateFail, layout);
case UDP:
return DatagramSocketManager.getSocketManager(host, port, layout);
- case TLS:
+ case SSL:
return SslSocketManager.getSocketManager(sslConfig, host, port, delay, immediateFail, layout);
default:
throw new IllegalArgumentException(protocol.toString());
Modified: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SyslogAppender.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SyslogAppender.java?rev=1596876&r1=1596875&r2=1596876&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SyslogAppender.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SyslogAppender.java Thu May 22 14:09:14 2014
@@ -32,6 +32,7 @@ import org.apache.logging.log4j.core.lay
import org.apache.logging.log4j.core.net.AbstractSocketManager;
import org.apache.logging.log4j.core.net.Advertiser;
import org.apache.logging.log4j.core.net.Protocol;
+import org.apache.logging.log4j.core.net.ssl.SslConfiguration;
import org.apache.logging.log4j.core.util.Booleans;
import org.apache.logging.log4j.util.EnglishEnums;
@@ -54,7 +55,8 @@ public class SyslogAppender extends Sock
* Create a SyslogAppender.
* @param host The name of the host to connect to.
* @param portNum The port to connect to on the target host.
- * @param protocol The Protocol to use.
+ * @param protocolStr The Protocol to use.
+ * @param sslConfig TODO
* @param delay The interval in which failed writes should be retried.
* @param immediateFail True if the write should fail if no socket is immediately available.
* @param name The name of the Appender.
@@ -64,7 +66,7 @@ public class SyslogAppender extends Sock
* @param facility The Facility is used to try to classify the message.
* @param id The default structured data id to use when formatting according to RFC 5424.
* @param ein The IANA enterprise number.
- * @param includeMDC Indicates whether data from the ThreadContextMap will be included in the RFC 5424 Syslog
+ * @param includeMdc Indicates whether data from the ThreadContextMap will be included in the RFC 5424 Syslog
* record. Defaults to "true:.
* @param mdcId The id to use for the MDC Structured Data Element.
* @param mdcPrefix The prefix to add to MDC key names.
@@ -88,9 +90,11 @@ public class SyslogAppender extends Sock
*/
@PluginFactory
public static SyslogAppender createAppender(
+ // @formatter:off
@PluginAttribute("host") final String host,
@PluginAttribute("port") final String portNum,
- @PluginAttribute("protocol") final String protocol,
+ @PluginAttribute("protocol") final String protocolStr,
+ @PluginElement("SSL") final SslConfiguration sslConfig,
@PluginAttribute("reconnectionDelay") final String delay,
@PluginAttribute("immediateFail") final String immediateFail,
@PluginAttribute("name") final String name,
@@ -99,7 +103,7 @@ public class SyslogAppender extends Sock
@PluginAttribute("facility") final String facility,
@PluginAttribute("id") final String id,
@PluginAttribute("enterpriseNumber") final String ein,
- @PluginAttribute("includeMDC") final String includeMDC,
+ @PluginAttribute("includeMdc") final String includeMdc,
@PluginAttribute("mdcId") final String mdcId,
@PluginAttribute("mdcPrefix") final String mdcPrefix,
@PluginAttribute("eventPrefix") final String eventPrefix,
@@ -115,8 +119,8 @@ public class SyslogAppender extends Sock
@PluginConfiguration final Configuration config,
@PluginAttribute("charset") final String charsetName,
@PluginAttribute("exceptionPattern") final String exceptionPattern,
- @PluginElement("LoggerFields") final LoggerFields[] loggerFields,
- @PluginAttribute("advertise") final String advertise) {
+ @PluginElement("LoggerFields") final LoggerFields[] loggerFields, @PluginAttribute("advertise") final String advertise) {
+ // @formatter:on
final boolean isFlush = Booleans.parseBoolean(immediateFlush, true);
final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
@@ -124,21 +128,19 @@ public class SyslogAppender extends Sock
final boolean fail = Booleans.parseBoolean(immediateFail, true);
final int port = AbstractAppender.parseInt(portNum, 0);
final boolean isAdvertise = Boolean.parseBoolean(advertise);
- final Layout<? extends Serializable> layout = (RFC5424.equalsIgnoreCase(format) ?
- Rfc5424Layout.createLayout(facility, id, ein, includeMDC, mdcId, mdcPrefix, eventPrefix, includeNL,
- escapeNL, appName, msgId, excludes, includes, required, exceptionPattern, "false", loggerFields,
+ final Protocol protocol = EnglishEnums.valueOf(Protocol.class, protocolStr);
+ final String useTlsMessageFormat = Boolean.toString(sslConfig != null || protocol == Protocol.SSL);
+ final Layout<? extends Serializable> layout = RFC5424.equalsIgnoreCase(format) ?
+ Rfc5424Layout.createLayout(facility, id, ein, includeMdc, mdcId, mdcPrefix, eventPrefix, includeNL,
+ escapeNL, appName, msgId, excludes, includes, required, exceptionPattern, useTlsMessageFormat, loggerFields,
config) :
- SyslogLayout.createLayout(facility, includeNL, escapeNL, charsetName));
+ SyslogLayout.createLayout(facility, includeNL, escapeNL, charsetName);
if (name == null) {
LOGGER.error("No name provided for SyslogAppender");
return null;
}
- final Protocol p = EnglishEnums.valueOf(Protocol.class, protocol);
- final AbstractSocketManager manager = createSocketManager(name, p, host, port, null, reconnectDelay, fail, layout);
- if (manager == null) {
- return null;
- }
+ final AbstractSocketManager manager = createSocketManager(name, protocol, host, port, sslConfig, reconnectDelay, fail, layout);
return new SyslogAppender(name, layout, filter, ignoreExceptions, isFlush, manager,
isAdvertise ? config.getAdvertiser() : null);
Modified: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/net/Protocol.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/net/Protocol.java?rev=1596876&r1=1596875&r2=1596876&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/net/Protocol.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/net/Protocol.java Thu May 22 14:09:14 2014
@@ -22,8 +22,8 @@ package org.apache.logging.log4j.core.ne
public enum Protocol {
/** TCP Protocol. */
TCP,
- /** TLS Protocol. */
- TLS,
+ /** SSL Protocol. */
+ SSL,
/** UDP Protocol. */
UDP;
Modified: logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SyslogAppenderTest.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SyslogAppenderTest.java?rev=1596876&r1=1596875&r2=1596876&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SyslogAppenderTest.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SyslogAppenderTest.java Thu May 22 14:09:14 2014
@@ -106,8 +106,8 @@ public class SyslogAppenderTest extends
}
private SyslogAppender createAppender(final String protocol, final String format) {
- return SyslogAppender.createAppender("localhost", PORT, protocol, "-1", null, "Test", "true", "false", "LOCAL0", "Audit",
- "18060", "true", "RequestContext", null, null, includeNewLine, null, "TestApp", "Test", null, "ipAddress,loginId",
- null, format, null, null, null, null, null, null);
+ return SyslogAppender.createAppender("localhost", PORT, protocol, null, "-1", null, "Test", "true", "false", "LOCAL0",
+ "Audit", "18060", "true", "RequestContext", null, null, includeNewLine, null, "TestApp", "Test", null,
+ "ipAddress,loginId", null, format, null, null, null, null, null, null);
}
}
Modified: logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/TlsSyslogAppenderTest.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/TlsSyslogAppenderTest.java?rev=1596876&r1=1596875&r2=1596876&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/TlsSyslogAppenderTest.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/TlsSyslogAppenderTest.java Thu May 22 14:09:14 2014
@@ -86,7 +86,7 @@ public class TlsSyslogAppenderTest exten
serverSocketFactory = sslConfig.getSslServerSocketFactory();
}
- private TlsSyslogAppender createAppender() {
+ private SyslogAppender createAppender() {
String format;
if (messageFormat == TlsSyslogMessageFormat.LEGACY_BSD) {
@@ -95,7 +95,7 @@ public class TlsSyslogAppenderTest exten
format = "RFC5424";
}
- return TlsSyslogAppender.createAppender("localhost", PORT, sslConfig, "-1", null, "Test", "true", "false", "LOCAL0", "Audit",
+ return SyslogAppender.createAppender("localhost", PORT, "SSL", sslConfig, "-1", null, "Test", "true", "false", "LOCAL0", "Audit",
"18060", "true", "RequestContext", null, null, includeNewLine, null, "TestApp", "Test", null, "ipAddress,loginId",
null, format, null, null, null, null, null, null);
}
Modified: logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/net/server/SslXmlSocketServerTest.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/net/server/SslXmlSocketServerTest.java?rev=1596876&r1=1596875&r2=1596876&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/net/server/SslXmlSocketServerTest.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/test/java/org/apache/logging/log4j/core/net/server/SslXmlSocketServerTest.java Thu May 22 14:09:14 2014
@@ -80,7 +80,7 @@ public class SslXmlSocketServerTest exte
}
public SslXmlSocketServerTest() {
- super("TLS", PORT, false);
+ super("SSL", PORT, false);
}
@Override
Modified: logging/log4j/log4j2/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/site.xml?rev=1596876&r1=1596875&r2=1596876&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/site.xml (original)
+++ logging/log4j/log4j2/trunk/src/site/site.xml Thu May 22 14:09:14 2014
@@ -112,7 +112,6 @@
<item name="SMTP" href="/manual/appenders.html#SMTPAppender"/>
<item name="Socket" href="/manual/appenders.html#SocketAppender"/>
<item name="Syslog" href="/manual/appenders.html#SyslogAppender"/>
- <item name="TLS Syslog" href="/manual/appenders.html#TLSSyslogAppender"/>
</item>
<item name="Layouts" href="/manual/layouts.html" collapse="true">
Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml?rev=1596876&r1=1596875&r2=1596876&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml (original)
+++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml Thu May 22 14:09:14 2014
@@ -2793,11 +2793,11 @@ public class JpaLogEntity extends Abstra
<tr>
<td>protocol</td>
<td>String</td>
- <td>"TCP" (default), "TLS" or "UDP".</td>
+ <td>"TCP" (default), "SSL" or "UDP".</td>
</tr>
<tr>
<td>SSL</td>
- <td>SSLConfiguration</td>
+ <td>SslConfiguration</td>
<td>Contains the configuration for the KeyStore and TrustStore.</td>
</tr>
<tr>
@@ -3033,13 +3033,17 @@ public class JpaLogEntity extends Abstra
<td>integer</td>
<td>The port on the host that is listening for log events. This parameter must be specified.</td>
</tr>
-
<tr>
<td>protocol</td>
<td>String</td>
<td>"TCP" or "UDP". This parameter is required.</td>
</tr>
<tr>
+ <td>SSL</td>
+ <td>SslConfiguration</td>
+ <td>Contains the configuration for the KeyStore and TrustStore.</td>
+ </tr>
+ <tr>
<td>reconnectionDelay</td>
<td>integer</td>
<td>If set to a value greater than 0, after an error the SocketManager will attempt to reconnect to
@@ -3071,175 +3075,10 @@ public class JpaLogEntity extends Abstra
</Root>
</Loggers>
</Configuration>]]></pre>
- </subsection>
- <a name="TLSSyslogAppender"/>
- <subsection name="TLSSyslogAppender">
- <p>
- The <code>TLSSyslogAppender</code> is a <code>SocketAppender</code> that writes its output to a remote destination
- specified by a host and port over SSL in a format that conforms with either the BSD Syslog format or the
- RFC 5424 format. The data can be sent over either TCP or UDP.
- </p>
- <table>
- <caption align="top"><code>SyslogAppender</code> Parameters</caption>
- <tr>
- <th>Parameter Name</th>
- <th>Type</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>advertise</td>
- <td>boolean</td>
- <td>Indicates whether the appender should be advertised.</td>
- </tr>
- <tr>
- <td>appName</td>
- <td>String</td>
- <td>The value to use as the APP-NAME in the RFC 5424 syslog record.</td>
- </tr>
- <tr>
- <td>charset</td>
- <td>String</td>
- <td>The character set to use when converting the syslog String to a byte array. The String must be
- a valid <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Charset</a>.
- If not specified, the default system Charset will be used.</td>
- </tr>
- <tr>
- <td>enterpriseNumber</td>
- <td>integer</td>
- <td>The IANA enterprise number as described in
- <a href="http://tools.ietf.org/html/rfc5424#section-7.2.2">RFC 5424</a></td>
- </tr>
- <tr>
- <td>filter</td>
- <td>Filter</td>
- <td>A Filter to determine if the event should be handled by this Appender. More than one Filter
- may be used by using a CompositeFilter.</td>
- </tr>
- <tr>
- <td>facility</td>
- <td>String</td>
- <td>The facility is used to try to classify the message. The facility option must be set to one of
- "KERN", "USER", "MAIL", "DAEMON", "AUTH", "SYSLOG", "LPR", "NEWS", "UUCP", "CRON", "AUTHPRIV",
- "FTP", "NTP", "AUDIT", "ALERT", "CLOCK", "LOCAL0", "LOCAL1", "LOCAL2", "LOCAL3", "LOCAL4", "LOCAL5",
- "LOCAL6", or "LOCAL7". These values may be specified as upper or lower case characters.</td>
- </tr>
- <tr>
- <td>format</td>
- <td>String</td>
- <td>If set to "RFC5424" the data will be formatted in accordance with RFC 5424. Otherwise, it will
- be formatted as a BSD Syslog record. Note that although BSD Syslog records are required to be
- 1024 bytes or shorter the SyslogLayout does not truncate them. The RFC5424Layout also does not
- truncate records since the receiver must accept records of up to 2048 bytes and may accept records
- that are longer.</td>
- </tr>
- <tr>
- <td>host</td>
- <td>String</td>
- <td>The name or address of the system that is listening for log events. This parameter is required.</td>
- </tr>
- <tr>
- <td>id</td>
- <td>String</td>
- <td>The default structured data id to use when formatting according to RFC 5424. If the LogEvent contains
- a StructuredDataMessage the id from the Message will be used instead of this value.</td>
- </tr>
- <tr>
- <td>ignoreExceptions</td>
- <td>boolean</td>
- <td>The default is <code>true</code>, causing exceptions encountered while appending events to be
- internally logged and then ignored. When set to <code>false</code> exceptions will be propagated to the
- caller, instead. You must set this to <code>false</code> when wrapping this Appender in a
- <a href="#FailoverAppender">FailoverAppender</a>.</td>
- </tr>
- <tr>
- <td>immediateFail</td>
- <td>boolean</td>
- <td>When set to true, log events will not wait to try to reconnect and will fail immediately if the
- socket is not available.</td>
- </tr>
- <tr>
- <td>immediateFlush</td>
- <td>boolean</td>
- <td>When set to true - the default, each write will be followed by a flush.
- This will guarantee the data is written
- to disk but could impact performance.</td>
- </tr>
- <tr>
- <td>includeMDC</td>
- <td>boolean</td>
- <td>Indicates whether data from the ThreadContextMap will be included in the RFC 5424 Syslog record.
- Defaults to true.</td>
- </tr>
- <tr>
- <td>loggerFields</td>
- <td>List of KeyValuePairs</td>
- <td>Allows arbitrary PatternLayout patterns to be included as specified ThreadContext fields; no default
- specified. To use, include a >LoggerFields< nested element, containing one or more
- >KeyValuePair< elements. Each >KeyValuePair< must have a key attribute, which
- specifies the key name which will be used to identify the field within the MDC Structured Data element,
- and a value attribute, which specifies the PatternLayout pattern to use as the value.</td>
- </tr>
- <tr>
- <td>mdcExcludes</td>
- <td>String</td>
- <td>A comma separated list of mdc keys that should be excluded from the LogEvent. This is mutually
- exclusive with the mdcIncludes attribute. This attribute only applies to RFC 5424 syslog records.</td>
- </tr>
- <tr>
- <td>mdcIncludes</td>
- <td>String</td>
- <td>A comma separated list of mdc keys that should be included in the FlumeEvent. Any keys in the MDC
- not found in the list will be excluded. This option is mutually exclusive with the mdcExcludes
- attribute. This attribute only applies to RFC 5424 syslog records.</td>
- </tr>
- <tr>
- <td>mdcRequired</td>
- <td>String</td>
- <td>A comma separated list of mdc keys that must be present in the MDC. If a key is not present a
- LoggingException will be thrown. This attribute only applies to RFC 5424 syslog records.</td>
- </tr>
- <tr>
- <td>mdcPrefix</td>
- <td>String</td>
- <td>A string that should be prepended to each MDC key in order to distinguish it from event attributes.
- The default string is "mdc:". This attribute only applies to RFC 5424 syslog records.</td>
- </tr>
- <tr>
- <td>messageId</td>
- <td>String</td>
- <td>The default value to be used in the MSGID field of RFC 5424 syslog records. </td>
- </tr>
- <tr>
- <td>name</td>
- <td>String</td>
- <td>The name of the Appender.</td>
- </tr>
- <tr>
- <td>newLine</td>
- <td>boolean</td>
- <td>If true, a newline will be appended to the end of the syslog record. The default is false.</td>
- </tr>
- <tr>
- <td>port</td>
- <td>integer</td>
- <td>The port on the host that is listening for log events. This parameter must be specified.</td>
- </tr>
- <tr>
- <td>reconnectionDelay</td>
- <td>integer</td>
- <td>If set to a value greater than 0, after an error the SocketManager will attempt to reconnect to
- the server after waiting the specified number of milliseconds. If the reconnect fails then
- an exception will be thrown (which can be caught by the application if <code>ignoreExceptions</code> is
- set to <code>false</code>).</td>
- </tr>
- <tr>
- <td>ssl</td>
- <td>SSLConfiguration</td>
- <td>Contains the configuration for the KeyStore and TrustStore.</td>
- </tr>
- </table>
+
<p>
- A sample TLS Syslog Appender configuration that is configured to send a BSD-style syslog message.
+ For SSL this appender writes its output to a remote destination specified by a host and port over SSL in
+ a format that conforms with either the BSD Syslog format or the RFC 5424 format.
</p>
<pre class="prettyprint linenums"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
@@ -3259,6 +3098,7 @@ public class JpaLogEntity extends Abstra
</Loggers>
</Configuration>]]></pre>
</subsection>
+
</section>
</body>
</document>