You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by dk...@apache.org on 2013/10/07 17:40:38 UTC
svn commit: r1529977 - in /sling/site/trunk/content:
documentation/development/client-request-logging.mdtext
documentation/development/logging.mdtext site/.htaccess
site/bundle-resources-extensionsbundleresource.html site/logging.html
Author: dklco
Date: Mon Oct 7 15:40:38 2013
New Revision: 1529977
URL: http://svn.apache.org/r1529977
Log:
Translated logging.html & bundle-resource-extensionsbundleresource.html from the site working on translating client-request-logging.html as well.
Removed:
sling/site/trunk/content/site/bundle-resources-extensionsbundleresource.html
sling/site/trunk/content/site/logging.html
Modified:
sling/site/trunk/content/documentation/development/client-request-logging.mdtext
sling/site/trunk/content/documentation/development/logging.mdtext
sling/site/trunk/content/site/.htaccess
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=1529977&r1=1529976&r2=1529977&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:40:38 2013
@@ -1,4 +1,3 @@
-translation_pending: true
Title: Client Request Logging
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 `access.log` and `request.log` files. In addition more logging can be configured by providing OSGi Configuration Admin configuration.
@@ -11,7 +10,7 @@ In the Sling Web Console locate the Conf
| 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] below for the specification of the format). |
+| 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). |
@@ -29,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
@@ -40,9 +39,9 @@ In the Sling Web Console locate the Conf
| Parameter | Name | Default | Description |
|--|--|--|--|
-| Log Format | `request.log.service.format` | Specify a [#Log Format Specification](#log-format-specification) as described below |
-| Logger Type | `request.log.service.outputtype` | Logger Name/`0` | Type of Logger named with the Logger Name parameter. See [#Log Output](#log-output) above |
-| Logger Name | `request.log.service.output` | `request.log` | Name of the Logger to be used. See [#Log Output](#log-output) above |
+| Log Format | `request.log.service.format` | | Specify a [Log Format Specification](#log-format-specification) as described below |
+| Logger Type | `request.log.service.outputtype` | Logger Name/`0` | Type of Logger named with the Logger Name parameter. See [Log Output](#log-output) above |
+| Logger Name | `request.log.service.output` | `request.log` | Name of the Logger to be used. See [Log Output](#log-output) above |
| Request Entry | `request.log.service.onentry` | unchecked/`false` | Whether logger is called at the start of request processing or after processing the request |
@@ -74,7 +73,7 @@ The characteristics of the request itsel
| `%\{Foobar}o` | The contents of Foobar: header line(s) in the reply. |
| `%p` | The canonical port of the server serving the request |
| `%\{format}p` | The canonical port of the server serving the request or the server's actual port or the client's actual port. Valid formats are canonical, local, or remote. |
-| `%P` | The *name of the thread* -process ID of the child- that serviced the request. |
+| `%P` | The *name of the thread* ~~process ID of the child~~ that serviced the request. |
| `%\{format}P` | Same as `%P`; the `format` parameter is ignored. |
| `%q` | The query string (prepended with a ? if a query string exists, otherwise an empty string) |
| `%r` | First line of request |
@@ -110,8 +109,8 @@ If you want to write the request (and ac
1. Configure the Log Type to be a *Logger Name* and some usefull Logger name. For example `clientlog.request`.
1. Create an *Apache Sling Logging Logger Configuration* for this Logger name according to [Logging Configuration]({{ refs.logging-logger-configuration.path }}) with the following setup:
- ** Allow message at INFO (Information) level to be logged which is the level used by the request loggers
- ** Define the appropriate log file name, for example `logs/client.request.log`
- ** Use only `\{5`} as the message format because request logger messages are generally already fully formated with required timestamp etc.
- ** Add any Logger names used for the client request log configuration, `clientlog.request` in the example above, to the Logger field. By clicking on the `+` (plus) button you may add more than a single logger name whose messages are written to this file.
+ * Allow message at INFO (Information) level to be logged which is the level used by the request loggers
+ * Define the appropriate log file name, for example `logs/client.request.log`
+ * Use only `\{5`} as the message format because request logger messages are generally already fully formated with required timestamp etc.
+ * Add any Logger names used for the client request log configuration, `clientlog.request` in the example above, to the Logger field. By clicking on the `+` (plus) button you may add more than a single logger name whose messages are written to this file.
1. Optionally, you may create an *Apache Sling Logging Writer Configuration* for the log file defined in the previous step to better control rotation setup. See [Log Writer Configuration]({{ refs.logging-log-writer-configuration.path }}) for full details.
\ No newline at end of file
Modified: sling/site/trunk/content/documentation/development/logging.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/logging.mdtext?rev=1529977&r1=1529976&r2=1529977&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/development/logging.mdtext (original)
+++ sling/site/trunk/content/documentation/development/logging.mdtext Mon Oct 7 15:40:38 2013
@@ -1,4 +1,3 @@
-translation_pending: true
Title: Logging
## Introduction
Modified: sling/site/trunk/content/site/.htaccess
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/site/.htaccess?rev=1529977&r1=1529976&r2=1529977&view=diff
==============================================================================
--- sling/site/trunk/content/site/.htaccess (original)
+++ sling/site/trunk/content/site/.htaccess Mon Oct 7 15:40:38 2013
@@ -57,3 +57,5 @@ Redirect Permanent /site/wrap-or-decorat
Redirect Permanent /site/xslt-processing-pipeline.html /old-stuff/scriptengineintegration/xslt-processing-pipeline.html
Redirect Permanent /site/commons-html-utilities.html /documentation/bundles/commons-html-utilities.html
Redirect Permanent /site/manipulating-content-the-slingpostservlet-servletspost.html /documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html
+Redirect Permanent /site/logging.html /documentation/development/logging.html
+Redirect Permanent /site/bundle-resources-extensionsbundleresource.html /documentation/bundles/bundle-resources-extensions-bundleresource.html#configuration