Author: dklco
Date: Mon Oct 7 15:48:46 2013
New Revision: 1529980
URL: http://svn.apache.org/r1529980
Log:
Fixing the editing instructions and the defaults for the Apache Sling Request
Logger and fixed some content which was emboldened but here was italicized
Modified:
sling/site/trunk/content/documentation/development/client-request-logging.mdtext
Modified:
sling/site/trunk/content/documentation/development/client-request-logging.mdtext
URL:
http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/client-request-logging.mdtext?rev=1529980&r1=1529979&r2=1529980&view=diff
==============================================================================
---
sling/site/trunk/content/documentation/development/client-request-logging.mdtext
(original)
+++
sling/site/trunk/content/documentation/development/client-request-logging.mdtext
Mon Oct 7 15:48:46 2013
@@ -6,16 +6,16 @@ Sling provides extensive support to log
In the Web Console configure the *Apache Sling Request Logger*
(PID=`org.apache.sling.engine.impl.log.RequestLogger`) configuration.
-In the Sling Web Console locate the Configuration page
(`/system/console/configMgr`) and click on the `+` (plus) symbol on the *Apache
Sling Customizable Request Data Logger* line. This opens a dialog to enter the
configuration whose properties can be configured as follows:
+In the Sling Web Console locate the Configuration page
(`/system/console/configMgr`) and click on the pencil (edit) symbol on the
*Apache Sling Request Logger* line. This opens a dialog to enter the
configuration whose properties can be configured as follows:
| Parameter | Name | Default | Description |
|--|--|--|--|
-| Request Log Name | `request.log.output` | 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 `%t \[%R\] \-> %m %U%q %H` and request exit is logged
with the format `%\{end}t \[%R] <\- %s %\{Content-Type}o %Dms` (See [Log Format
Specification](#log-format-specification) below for the specification of the
format). |
-| Request Log Type | `request.log.outputtype` | Type of Logger named with the
Logger Name parameter. See [Log Output](#log-output) below |
-| Enable Request Log | `request.log.enabled` | Whether to enable Request
logging or not. |
-| Access Log Name | `access.log.output` | 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 `%h %l %u %t
"%r" %>s %b "%\{Referer}i" "%\{User-Agent}i"` (See [Log Format
Specification](#log-format-specification) below for the specification of the
format). |
-| Access Log Type | `access.log.outputtype` | Type of Logger named with the
Logger Name parameter. See [Log Output](#log-output) below |
-| Enable Access Log | `access.log.enabled` | Whether to enable Access logging
or not. |
+| Request Log Name | `request.log.output` | logs/request.log | 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 `%t \[%R\] \-> %m %U%q %H` and
request exit is logged with the format `%\{end}t \[%R] <\- %s %\{Content-Type}o
%Dms` (See [Log Format Specification](#log-format-specification) below for the
specification of the format). |
+| Request Log Type | `request.log.outputtype` | Logger Name | Type of Logger
named with the Logger Name parameter. See [Log Output](#log-output) below |
+| Enable Request Log | `request.log.enabled` | true | Whether to enable
Request logging or not. |
+| Access Log Name | `access.log.output` | logs/access.log | 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 `%h
%l %u %t "%r" %>s %b "%\{Referer}i" "%\{User-Agent}i"` (See [Log Format
Specification](#log-format-specification) below for the specification of the
format). |
+| Access Log Type | `access.log.outputtype` | Logger Name | Type of Logger
named with the Logger Name parameter. See [Log Output](#log-output) below |
+| Enable Access Log | `access.log.enabled` | true | Whether to enable Access
logging or not. |
#### Log Output
@@ -28,7 +28,7 @@ Output of client request logging is defi
| 1 | File Name | Writes the logging information to a file, on message per
line. The file name is an absolute or relative path name. If the name is
relative, it is resolved against the `sling.home` framework property. |
| 2 | RequestLog Service | Sends the logging information to a
`org.apache.sling.engine.RequestLog` service whose `requestlog.name` service
registration property must the same as the value of the Logger Name property.
If more than one such service is registered, all services are called. If no
such service is registered, the logging information is discarded. Using
RequestLog Services is deprecated. |
-*Note:* If logging to a file, this file is not rotated and/or limited by size.
To get log file rotation use the *Logger Name* logging type. See [Rotating
Logger Files](#rotating-logger-files) below for information on how logging
information can be written to rotated and/or size limited files.
+**Note:** If logging to a file, this file is not rotated and/or limited by
size. To get log file rotation use the *Logger Name* logging type. See
[Rotating Logger Files](#rotating-logger-files) below for information on how
logging information can be written to rotated and/or size limited files.
### Additional per-request Loggers
@@ -91,14 +91,14 @@ The characteristics of the request itsel
| `%O` | Not supported in Sling; prints nothing. |
-*Modifiers*
+**Modifiers**
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.
The Apache httpd modifiers "<" and ">" are not supported by Sling and
currently ignored.
-*Some Notes*
+**Some Notes**
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).
