Repository: logging-log4j2 Updated Branches: refs/heads/master 965c9342b -> 62952a57d
[LOG4J2-1126] Site fixes/improvements for 2.4 release. Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/62952a57 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/62952a57 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/62952a57 Branch: refs/heads/master Commit: 62952a57df2773c179bc604bb9675dec565b6456 Parents: 965c934 Author: ggregory <[email protected]> Authored: Mon Sep 21 15:16:26 2015 -0700 Committer: ggregory <[email protected]> Committed: Mon Sep 21 15:16:26 2015 -0700 ---------------------------------------------------------------------- src/site/xdoc/manual/layouts.xml.vm | 144 +++++++++++++++---------------- 1 file changed, 72 insertions(+), 72 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/62952a57/src/site/xdoc/manual/layouts.xml.vm ---------------------------------------------------------------------- diff --git a/src/site/xdoc/manual/layouts.xml.vm b/src/site/xdoc/manual/layouts.xml.vm index c32e227..82cb224 100644 --- a/src/site/xdoc/manual/layouts.xml.vm +++ b/src/site/xdoc/manual/layouts.xml.vm @@ -176,6 +176,78 @@ logger.debug("one={}, two={}, three={}", 1, 2, 3); 0,1441617184044,DEBUG,main,"one=1, two=2, three=3",org.apache.logging.log4j.spi.AbstractLogger,,,,org.apache.logging.log4j.core.layout.CsvLogEventLayoutTest.testLayout(CsvLogEventLayoutTest.java:98),{},[] </pre> </subsection> + <a name="GELFLayout"/> + <subsection name="GELF Layout"> + <!-- From Javadoc of org.apache.logging.log4j.core.layout.GELFLayout --> + <p> + Lays out events in the Graylog Extended Log Format (GELF) 1.1. + </p> + <p> + This layout compresses JSON to GZIP or ZLIB (the <code>compressionType</code>) if log event data is larger than 1024 bytes + (the <code>compressionThreshold</code>). This layout does not implement chunking. + </p> + <p> + Configure as follows to send to a Graylog2 server: + </p> + <pre class="prettyprint linenums">[ + <Appenders> + <Socket name="Graylog" protocol="udp" host="graylog.domain.com" port="12201"> + <GelfLayout host="someserver" compressionType="GZIP" compressionThreshold="1024"> + <KeyValuePair key="additionalField1" value="additional value 1"/> + <KeyValuePair key="additionalField2" value="additional value 2"/> + </GelfLayout> + </Socket> + </Appenders> +] +</pre> + <p> + See also: + </p> + <ul> + <li>The <a href="http://graylog2.org/gelf";>GELF home page</a></li> + <li>The <a href="http://graylog2.org/resources/gelf/specification";>GELF specification</a></li> + </ul> + </subsection> + <a name="HTMLLayout"/> + <subsection name="HTMLLayout"> + <p>The HTMLLayout generates an HTML page and adds each LogEvent to a row in a table. + </p> + <table> + <tr> + <th>Parameter Name</th> + <th>Type</th> + <th>Description</th> + </tr> + <tr> + <td>charset</td> + <td>String</td> + <td>The character set to use when converting the HTML String to a byte array. The value must be + a valid ${Charset}. If not specified, this layout uses UTF-8.</td> + </tr> + <tr> + <td>contentType</td> + <td>String</td> + <td>The value to assign to the Content-Type header. The default is "text/html".</td> + </tr> + <tr> + <td>locationInfo</td> + <td>boolean</td> + <td> + <a name="HtmlLocationInfo" /> + <p>If true, the filename and line number will be included in the HTML output. The default value is + false.</p> + <p>Generating <a href="#LocationInformation">location information</a> + is an expensive operation and may impact performance. Use with caution.</p> + </td> + </tr> + <tr> + <td>title</td> + <td>String</td> + <td>A String that will appear as the HTML title.</td> + </tr> + <caption align="top">HTML Layout Parameters</caption> + </table> + </subsection> <a name="JSONLayout"/> <subsection name="JSONLayout"> <!-- From Javadoc of org.apache.logging.log4j.core.layout.JSONLayout --> @@ -277,46 +349,6 @@ logger.debug("one={}, two={}, three={}", 1, 2, 3); <caption align="top">JSON Layout Parameters</caption> </table> </subsection> - <a name="HTMLLayout"/> - <subsection name="HTMLLayout"> - <p>The HTMLLayout generates an HTML page and adds each LogEvent to a row in a table. - </p> - <table> - <tr> - <th>Parameter Name</th> - <th>Type</th> - <th>Description</th> - </tr> - <tr> - <td>charset</td> - <td>String</td> - <td>The character set to use when converting the HTML String to a byte array. The value must be - a valid ${Charset}. If not specified, this layout uses UTF-8.</td> - </tr> - <tr> - <td>contentType</td> - <td>String</td> - <td>The value to assign to the Content-Type header. The default is "text/html".</td> - </tr> - <tr> - <td>locationInfo</td> - <td>boolean</td> - <td> - <a name="HtmlLocationInfo" /> - <p>If true, the filename and line number will be included in the HTML output. The default value is - false.</p> - <p>Generating <a href="#LocationInformation">location information</a> - is an expensive operation and may impact performance. Use with caution.</p> - </td> - </tr> - <tr> - <td>title</td> - <td>String</td> - <td>A String that will appear as the HTML title.</td> - </tr> - <caption align="top">HTML Layout Parameters</caption> - </table> - </subsection> <a name="PatternLayout"/> <subsection name="PatternLayout"> <p>A flexible layout configurable with pattern string. The goal of this class is to format a LogEvent and @@ -1639,38 +1671,6 @@ at org.apache.logging.log4j.core.pattern.ExtendedThrowableTest.testException(Ext of course, end-of-lines. </p> </subsection> - <a name="GELFLayout"/> - <subsection name="GELF Layout"> - <!-- From Javadoc of org.apache.logging.log4j.core.layout.GELFLayout --> - <p> - Lays out events in the Graylog Extended Log Format (GELF) 1.1. - </p> - <p> - This layout compresses JSON to GZIP or ZLIB (the <code>compressionType</code>) if log event data is larger than 1024 bytes - (the <code>compressionThreshold</code>). This layout does not implement chunking. - </p> - <p> - Configure as follows to send to a Graylog2 server: - </p> - <pre class="prettyprint linenums">[ - <Appenders> - <Socket name="Graylog" protocol="udp" host="graylog.domain.com" port="12201"> - <GelfLayout host="someserver" compressionType="GZIP" compressionThreshold="1024"> - <KeyValuePair key="additionalField1" value="additional value 1"/> - <KeyValuePair key="additionalField2" value="additional value 2"/> - </GelfLayout> - </Socket> - </Appenders> -] -</pre> - <p> - See also: - </p> - <ul> - <li>The <a href="http://graylog2.org/gelf";>GELF home page</a></li> - <li>The <a href="http://graylog2.org/resources/gelf/specification";>GELF specification</a></li> - </ul> - </subsection> <a name="LocationInformation"/> <subsection name="Location Information"> <p>
