svn commit: r1692853 - in /sling/site/trunk/content/documentation/development: logging.mdtext sling-log-support.png

[ch...@apache.org]

Author: chetanm
Date: Mon Jul 27 10:08:25 2015
New Revision: 1692853

URL: http://svn.apache.org/r1692853
Log:
--Updating docs for 
* SLING-4907 - Provide support for registering Filter with all configured appenders
* SLING-4905 - Log WebConsole Plugin should provide link to actual log file
* SLING-4904 - Log Config printer should only dump last 'n' lines of the logs
* SLING-4788 - SlingConfigurationPrinter should use mode aware and only stream the full logs in the zip version and avoid duplicate information

Modified:
    sling/site/trunk/content/documentation/development/logging.mdtext
    sling/site/trunk/content/documentation/development/sling-log-support.png

Modified: sling/site/trunk/content/documentation/development/logging.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/logging.mdtext?rev=1692853&r1=1692852&r2=1692853&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/development/logging.mdtext (original)
+++ sling/site/trunk/content/documentation/development/logging.mdtext Mon Jul 27 10:08:25 2015
@@ -22,6 +22,21 @@ following features:
 * Configures logging through Logback which is integrated with the OSGi environment
 * Allows logging to be configured both via editing Logback xml or via OSGi Configurations
 
+## WebConsole Plugin
+
+The Web Console Plugin supports the following features:
+
+* Display the list of loggers which have levels or appenders configured.
+* List the file appenders with the location of current active log files.
+* Show the contents of LogBack config files.
+* Show the contents of various Logback config fragments.
+* Show Logback Status logs.
+* Inline edit the Logger setting
+* Configure Logger with content assist for logger names
+* Provides links to log file content allows log file content to be viewed from Web UI
+
+<img src="sling-log-support.png" />
+
 ## Initial Configuration
 
 The `org.apache.sling.commons.log` bundle gets its initial configuration from the following `BundleContext` properties:
@@ -37,6 +52,8 @@ The `org.apache.sling.commons.log` bundl
 | `org.apache.sling.commons.log.julenabled` | n/a | Enables the `java.util.logging` support. |
 | `org.apache.sling.commons.log.configurationFile` | n/a | Path for the Logback config file which would be used to configure logging. If the path is not absolute then it would be resolved against Sling Home |
 | `org.apache.sling.commons.log.packagingDataEnabled` | true | Boolean property to control packaging data support of Logback. See [Packaging Data][11] section of Logback for more details |
+| `org.apache.sling.commons.log.numOfLines` | 1000 | Number of lines from each log files to include while generating the dump in 'txt' mode. If set to -1 then whole file would be included |
+| `org.apache.sling.commons.log.maxOldFileCountInDump` | 3 | Maximum number of old rolled over files for each active file to be included while generating the dump as part of Status zip support |
 
 ## User Configuration - OSGi Based
 
@@ -59,6 +76,7 @@ The following properties may be set:
 | `org.apache.sling.commons.log.file` | `String` | undefined | Sets the log file to which log messages are written. If this property is empty or missing, log messages are written to `System.out`. This property should refer to the file name of a configured Log Writer (see below). If no Log Writer is configured with the same file name an implicit Log Writer configuration with default configuration is created. |
 | `org.apache.sling.commons.log.pattern` | `String` | \{0,date,dd.MM.yyyy HH:mm:ss.SSS\} \*\{4\}\* \[\{2\}\]({{ refs.-2.path }}) \{3\} \{5\} | The `java.util.MessageFormat` pattern to use for formatting log messages with the root logger. This is a `java.util.MessageFormat` pattern supporting up to six arguments: \{0\} The timestamp of type `java.util.Date`, \{1\} the log marker, \{2\} the name of the current thread, \{3\} the name of the logger, \{4\} the debug level and \{5\} the actual debug message. If the log call includes a Throwable, the stacktrace is just appended to the message regardless of the pattern. |
 | `org.apache.sling.commons.log.names` | `String\[\]` | -- | A list of logger names to which this configuration applies. |
+| `org.apache.sling.commons.log.additiv` | `Boolean` | false | If set to false then logs from these loggers would not be sent to any appender attached higher in the hierarchy |
 
 
 Note that multiple Logger Configurations may refer to the same Log Writer Configuration. If no Log Writer Configuration
@@ -193,6 +211,8 @@ be passed to the appender. When register
         }
     }
 
+If the `appenders` value is set to `*` then the filter would be registered with all the appenders (`Since 4.0.4`)
+
 ### Appenders as OSGi services
 
 [Logback Appenders][2] handle the logging events produced by Logback. To register an OSGi `Appender`,
@@ -490,20 +510,6 @@ You need to specify the location of logb
         java -jar org.apache.sling.launchpad-XXX-standalone.jar -Dorg.apache.sling.commons.log.configurationFile=/path/to/logback
  
 
-## WebConsole Plugin
-
-The Web Console Plugin supports the following features:
-
-* Display the list of loggers which have levels or appenders configured.
-* List the file appenders with the location of current active log files.
-* Show the contents of LogBack config files.
-* Show the contents of various Logback config fragments.
-* Show Logback Status logs.
-* Inline edit the Logger setting
-* Configure Logger with content assist for logger names
-
-<img src="sling-log-support.png" />
-
 [1]: http://logback.qos.ch/manual/filters.html
 [2]: http://logback.qos.ch/manual/appenders.html
 [3]: http://logback.qos.ch/manual/filters.html#TurboFilter

Modified: sling/site/trunk/content/documentation/development/sling-log-support.png
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/sling-log-support.png?rev=1692853&r1=1692852&r2=1692853&view=diff
==============================================================================
Binary files - no diff available.