You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by sd...@apache.org on 2013/10/18 03:27:45 UTC
svn commit: r1533304 -
/logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml.vm
Author: sdeboy
Date: Fri Oct 18 01:27:45 2013
New Revision: 1533304
URL: http://svn.apache.org/r1533304
Log:
Update advertiser information
Modified:
logging/log4j/log4j2/trunk/src/site/xdoc/manual/configuration.xml.vm
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=1533304&r1=1533303&r2=1533304&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 Fri Oct 18 01:27:45 2013
@@ -273,25 +273,41 @@ public class Bar {
<a name="AdvertisingAppenderConfigurations"/>
<subsection name="Advertising Appender Configurations">
<p>
- 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 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 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 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.
+ Log4j supports advertisement of individual appender configurations. External systems can examine these advertised
+ appender configurations and use that information to automate processing. For example, applications can advertise a FileAppender
+ configuration and Chainsaw can discover that configuration, allowing Chainsaw users to begin processing the log file
+ with no user configuration of Chainsaw required.
+ </p>
+ <p>
+ Log4j provides one Advertiser implementation, which can expose FileAppender and SocketAppender
+ configurations via Multicast DNS using the <a href="http://jmdns.sourceforge.net">http://jmdns.sourceforge.net</a> library.
+ </p>
+ <p>
+ Chainsaw supports discovery of Multicast DNS-published advertisements and will display the discovered
+ appender configuration as an entry in Chainsaw's Zeroconf tab. Since all necessary appender configuration details are
+ broadcast in the advertisement, Chainsaw has all of the information it needs to parse and tail the log file -
+ no Chainsaw configuration required - just double-click on the appender configuration entry in the
+ Zeroconf tab of Chainsaw to begin processing the log file.
+ </p>
+ <p>
+ Note: Chainsaw can currently only process advertised FileAppender configurations from Log4j2.
+ </p>
+ <p>
+ To advertise an appender configuration:
+ <ul>
+ <li>Add the JmDns library from <a href="http://jmdns.sourceforge.net">http://jmdns.sourceforge.net</a> to the application classpath</li>
+ <li>Set the 'advertiser' attribute of the configuration element to 'multicastdns'</li>
+ <li>Set the 'advertise' attribute on the appender element to 'true'</li>
+ <li>If advertising a FileAppender-based configuration, set the 'advertiseURI' attribute on the appender element to an appropriate URI</li>
+ </ul>
+ </p>
+ <p>
+ FileAppender-based configurations require an additional 'advertiseURI' attribute to be specified on the appender.
+ The 'advertiseURI' attribute provides Chainsaw with information on how the file can be accessed.
+ For example, the file may be remotely accessible to Chainsaw via ssh/sftp by specifying a Commons VFS
+ (<a href="http://commons.apache.org/proper/commons-vfs/">http://commons.apache.org/proper/commons-vfs/</a>) sftp:// URI,
+ an http:// URI may be used if the file is accessible through a web server, or a file:// URI can be specified
+ if accessing the file from a locally-running instance of Chainsaw.
</p>
<pre class="prettyprint linenums"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>