Author: sdeboy Date: Sun Mar 3 07:54:13 2013 New Revision: 1452016 URL: http://svn.apache.org/r1452016 Log: Implementing LOG4J2-155: add getFormat to Layout
https://issues.apache.org/jira/browse/LOG4J2-155 Updating socket appender javadoc, updating advertising configuration docs. Modified: logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/DatagramSocketManager.java logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/TCPSocketManager.java logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml.vm Modified: logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/DatagramSocketManager.java URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/DatagramSocketManager.java?rev=1452016&r1=1452015&r2=1452016&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/DatagramSocketManager.java (original) +++ logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/DatagramSocketManager.java Sun Mar 3 07:54:13 2013 @@ -62,7 +62,8 @@ public class DatagramSocketManager exten /** * DatagramSocketManager's content format is specified by:<p/> - * Key: "protocol" Value: "udp" + * Key: "protocol" Value: "udp"<p/> + * Key: "direction" Value: "out" * @return Map of content format keys supporting DatagramSocketManager */ public Map<String, String> getContentFormat() Modified: logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/TCPSocketManager.java URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/TCPSocketManager.java?rev=1452016&r1=1452015&r2=1452016&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/TCPSocketManager.java (original) +++ logging/log4j/log4j2/trunk/core/src/main/java/org/apache/logging/log4j/core/net/TCPSocketManager.java Sun Mar 3 07:54:13 2013 @@ -135,7 +135,8 @@ public class TCPSocketManager extends Ab /** * TCPSocketManager's content format is specified by:<p/> - * Key: "protocol" Value: "tcp" + * Key: "protocol" Value: "tcp"<p/> + * Key: "direction" Value: "out" * @return Map of content format keys supporting TCPSocketManager */ public Map<String, String> getContentFormat() Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml.vm URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml.vm?rev=1452016&r1=1452015&r2=1452016&view=diff ============================================================================== --- logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml.vm (original) +++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml.vm Sun Mar 3 07:54:13 2013 @@ -271,26 +271,23 @@ public class Bar { <a name="AdvertisingAppenderConfigurations"/> <subsection name="Advertising Appender Configurations"> <p> - Log4j provides the ability to expose appender configurations to external systems. - If the advertiser attribute of the configuration element is set to the fully qualified - class name of an Advertiser implementation, the Advertiser will be provided the appender configuration details which the Advertiser can - publish. Other external systems can discover that published information, in order to automatically - process data generated by the appender. Advertisement is then enabled in the specific appender configuration. + Log4j provides the ability to expose appender configurations to external systems when the 'advertiser' + attribute of the configuration element has been specified. Advertisement is enabled for individual appenders by setting + the 'advertise' attribute of the appender to 'true'. </p> <p> - Log4j currently provides one Advertiser implementation: a Multicast DNS advertiser, which can be used to automatically - process a log file or begin receiving events from a socket-based appender, without the receiving end having to manually - configure processing of the appender data. Other possible Advertiser implementations may use JMX or write appender configuration details - to a custom database. + Log4j currently provides one Advertiser implementation: a Multicast DNS advertiser, which can be used to retrieve and parse + a log file or process events from a socket-based appender. Additional Advetiser implementations could be + written which leverage other mechanisms for exposing the appender configuration - for example, by exposing the + configuration via JMX or storing it in a database. </p> <p> - Chainsaw supports discovery of published Multicast DNS entries for file appender and socket-based appenders. By specifying the - Multicast DNS advertiser on the configuration and enabling advertisement on the specific appender, a Chainsaw user could 'double click' - on a discovered appender entry in the Chainsaw UI in order to begin receiving events generated by that appender, with no further - user configuration required. + Chainsaw supports discovery of the Multicast DNS-exposed appender configurations for file-based and socket-based appenders. When + Chainsaw discovers an advertised appender, Chainsaw will display an entry for the appender in the 'ZeroConf' screen, and the user can + double-click on the entry in order to begin receiving events generated by that appender, with no further user configuration required. </p> <p> - Note that individual appenders may require additional information in order to publish the appender configuration. For example, + Note that individual appenders may require that additional information provided in the appender configuration. For example, a FileAppender must specify an advertiseURI which can be used to retrieve the file contents. file://, http:// and Apache Commons VFS-supported URIs are all supported by Chainsaw. </p>
