You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bu...@apache.org on 2013/10/07 17:48:54 UTC
svn commit: r881573 - in /websites/staging/sling/trunk/content: ./
documentation/development/client-request-logging.html
Author: buildbot
Date: Mon Oct 7 15:48:54 2013
New Revision: 881573
Log:
Staging update by buildbot for sling
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/documentation/development/client-request-logging.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Oct 7 15:48:54 2013
@@ -1 +1 @@
-1529977
+1529980
Modified: websites/staging/sling/trunk/content/documentation/development/client-request-logging.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/development/client-request-logging.html (original)
+++ websites/staging/sling/trunk/content/documentation/development/client-request-logging.html Mon Oct 7 15:48:54 2013
@@ -88,7 +88,7 @@
<p>Sling provides extensive support to log various information at the before and after processing client requests. Out of the box, there are two loggers configured to write traditional <code>access.log</code> and <code>request.log</code> files. In addition more logging can be configured by providing OSGi Configuration Admin configuration.</p>
<h2 id="traditional-accesslog-and-requestlog-files">Traditional access.log and request.log Files</h2>
<p>In the Web Console configure the <em>Apache Sling Request Logger</em> (PID=<code>org.apache.sling.engine.impl.log.RequestLogger</code>) configuration.</p>
-<p>In the Sling Web Console locate the Configuration page (<code>/system/console/configMgr</code>) and click on the <code>+</code> (plus) symbol on the <em>Apache Sling Customizable Request Data Logger</em> line. This opens a dialog to enter the configuration whose properties can be configured as follows:</p>
+<p>In the Sling Web Console locate the Configuration page (<code>/system/console/configMgr</code>) and click on the pencil (edit) symbol on the <em>Apache Sling Request Logger</em> line. This opens a dialog to enter the configuration whose properties can be configured as follows:</p>
<table>
<thead>
<tr>
@@ -102,38 +102,38 @@
<tr>
<td>Request Log Name</td>
<td><code>request.log.output</code></td>
+<td>logs/request.log</td>
<td>Name of the destination for the request log. The request log logs the entry and exit of each request into and out of the system together with the entry time, exit time, time to process the request, a request counter as well as the final status code and response content type. In terms of Request Logger Service formats, request entry is logged with the format <code>%t \[%R\] \-> %m %U%q %H</code> and request exit is logged with the format <code>%\{end}t \[%R] <\- %s %\{Content-Type}o %Dms</code> (See <a href="#log-format-specification">Log Format Specification</a> below for the specification of the format).</td>
-<td></td>
</tr>
<tr>
<td>Request Log Type</td>
<td><code>request.log.outputtype</code></td>
+<td>Logger Name</td>
<td>Type of Logger named with the Logger Name parameter. See <a href="#log-output">Log Output</a> below</td>
-<td></td>
</tr>
<tr>
<td>Enable Request Log</td>
<td><code>request.log.enabled</code></td>
+<td>true</td>
<td>Whether to enable Request logging or not.</td>
-<td></td>
</tr>
<tr>
<td>Access Log Name</td>
<td><code>access.log.output</code></td>
+<td>logs/access.log</td>
<td>Name of the destination for the access log. The access log writes an entry for each request as the request terminates using the NCSA extended/combined log format. In terms of Request Logger Service formats the access log is written with the format <code>%h %l %u %t "%r" %>s %b "%\{Referer}i" "%\{User-Agent}i"</code> (See <a href="#log-format-specification">Log Format Specification</a> below for the specification of the format).</td>
-<td></td>
</tr>
<tr>
<td>Access Log Type</td>
<td><code>access.log.outputtype</code></td>
+<td>Logger Name</td>
<td>Type of Logger named with the Logger Name parameter. See <a href="#log-output">Log Output</a> below</td>
-<td></td>
</tr>
<tr>
<td>Enable Access Log</td>
<td><code>access.log.enabled</code></td>
+<td>true</td>
<td>Whether to enable Access logging or not.</td>
-<td></td>
</tr>
</tbody>
</table>
@@ -165,7 +165,7 @@
</tr>
</tbody>
</table>
-<p><em>Note:</em> If logging to a file, this file is not rotated and/or limited by size. To get log file rotation use the <em>Logger Name</em> logging type. See <a href="#rotating-logger-files">Rotating Logger Files</a> below for information on how logging information can be written to rotated and/or size limited files.</p>
+<p><strong>Note:</strong> If logging to a file, this file is not rotated and/or limited by size. To get log file rotation use the <em>Logger Name</em> logging type. See <a href="#rotating-logger-files">Rotating Logger Files</a> below for information on how logging information can be written to rotated and/or size limited files.</p>
<h3 id="additional-per-request-loggers">Additional per-request Loggers</h3>
<p>In the Web Console create <em>Apache Sling Customizable Request Data Logger</em> (Factory PID=<code>org.apache.sling.engine.impl.log.RequestLoggerService</code>) configuration.</p>
<p>In the Sling Web Console locate the Configuration page (<code>/system/console/configMgr</code>) and click on the <code>+</code> (plus) symbol on the <em>Apache Sling Customizable Request Data Logger</em> line. This opens a dialog to enter the configuration whose properties can be configured as follows:</p>
@@ -358,10 +358,10 @@
</tr>
</tbody>
</table>
-<p><em>Modifiers</em></p>
+<p><strong>Modifiers</strong></p>
<p>Particular items can be restricted to print only for responses with specific HTTP status codes by placing a comma-separated list of status codes immediately following the "%". For example, "%400,501{User-agent}i" logs User-agent on 400 errors and 501 errors only. For other status codes, the literal string "-" will be logged. The status code list may be preceded by a "!" to indicate negation: "%!200,304,302{Referer}i" logs Referer on all requests that do not return one of the three specified codes.</p>
<p>The Apache httpd modifiers "<" and ">" are not supported by Sling and currently ignored.</p>
-<p><em>Some Notes</em></p>
+<p><strong>Some Notes</strong></p>
<p>For security reasons non-printable and other special characters in %C, %i and %o are escaped using \uhhhh sequences, where hhhh stands for the hexadecimal representation of the character's unicode value. Exceptions from this rule are " and \, which are escaped by prepending a backslash, and all whitespace characters, which are written in their Java-style notation (\n, \t, etc).</p>
<h4 id="rotating-logger-files">Rotating Logger Files</h4>
<p>If you want to write the request (and access) logging information into a rotated file, you should configure as follows:</p>
@@ -377,7 +377,7 @@
<li>Optionally, you may create an <em>Apache Sling Logging Writer Configuration</em> for the log file defined in the previous step to better control rotation setup. See <a href="">Log Writer Configuration</a> for full details.</li>
</ol>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1529977 by dklco on Mon, 7 Oct 2013 15:40:38 +0000
+ Rev. 1529980 by dklco on Mon, 7 Oct 2013 15:48:46 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project