morciuch 2002/08/27 13:17:30
Modified: xdocs todo.xml changes.xml config_guide.xml
Log:
Documentation for PortletStatsService (see Bugzilla issue 11737)
Revision Changes Path
1.25 +3 -3 jakarta-jetspeed/xdocs/todo.xml
Index: todo.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/todo.xml,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- todo.xml 26 Aug 2002 01:59:18 -0000 1.24
+++ todo.xml 27 Aug 2002 20:17:30 -0000 1.25
@@ -143,7 +143,7 @@
</tr>
<tr>
<td>11697</td>
- <td>Customizer parameter presentation styles</td>
+ <td>Customizer parameter presentation styles. <strong>Done</strong></td>
<td>MO</td>
</tr>
<tr>
@@ -158,7 +158,7 @@
</tr>
<tr>
<td>11737</td>
- <td>Portlet Usage Logging</td>
+ <td>Portlet Usage Logging. <strong>Done</strong></td>
<td>MO</td>
</tr>
<tr>
1.64 +10 -1 jakarta-jetspeed/xdocs/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/changes.xml,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -r1.63 -r1.64
--- changes.xml 26 Aug 2002 01:59:18 -0000 1.63
+++ changes.xml 27 Aug 2002 20:17:30 -0000 1.64
@@ -24,10 +24,19 @@
-->
</ul>
<li>
+ Add - Bug # 11737 - 2002/08/27 - Implemented PortletStatsService, disabled by
default (MO)
+</li>
+<li>
Fix - 2002/08/25 - Updated Ant to 1.5 (PS)
</li>
<li>
Fix - 2002/08/25 - Implemented allow-if-owner element for in RegistrySecurity and
enable "owner" in the authentication methods (PS)
+</li>
+<li>
+ Add - Bug # 11599 - 2002/08/23 - Added import/export feature in PSML Browser (MO)
+</li>
+<li>
+ Add - Bug # 11697 - 2002/08/20 - Implemented portlet parameter presentation
styles (MO)
</li>
<li>
Add - 2002/08/13 - Bug fixes: enhancement to customizing portlet title allowing
for multiple instances of same portlet on a page with different titles
1.10 +62 -1 jakarta-jetspeed/xdocs/config_guide.xml
Index: config_guide.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/config_guide.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- config_guide.xml 17 Jul 2002 06:29:31 -0000 1.9
+++ config_guide.xml 27 Aug 2002 20:17:30 -0000 1.10
@@ -452,6 +452,41 @@
</tr>
</table>
</subsection>
+ <subsection name="Portlet usage logger">
+ <p>
+ This facility is useful to generate web server like access log which
+ captures access to individual portlets (since this cannot be accomplished
+ via regular web server logging). See javadoc for
<code>org.apache.jetspeed.services.JetspeedPortletStatsService</code>
+ for more information about the internals of this service. The following
are service properties as
+ defined in JetspeedResources.properties:
+ </p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>services.PortletStats.classname =
org.apache.jetspeed.services.portletstats.JetspeedPortletStatsService</td>
+ <td>Simple implementation using Apache Common Log Format (CLF)</td>
+ </tr>
+ <tr>
+ <td>services.PortletStats.logger = access</td>
+ <td>Name of the log4j logger</td>
+ </tr>
+ <tr>
+ <td>services.PortletStats.enabled = false</td>
+ <td>This service is disabled by default</td>
+ </tr>
+ <tr>
+ <td>services.PortletStats.excludePortlets = </td>
+ <td>Portlets to exclude from logging (not yet implemented)</td>
+ </tr>
+ <tr>
+ <td>services.PortletStats.dateFormat = dd/MMM/yyyy:hh:mm:ss z</td>
+ <td>Date format to use in the log entry</td>
+ </tr>
+ </table>
+ </subsection>
<subsection name="Example configuration">
<p>
The following configuration will rotate the logging among 6 files. All
logging
@@ -469,7 +504,7 @@
#
# destination.file: A path relative to the web app root
# -------------------------------------------------------------------
-services.LoggingService.facilities=rotation,system,debug
+services.LoggingService.facilities=rotation,system,debug,logforj,access
services.LoggingService.default=rotation
services.LoggingService.loggingConfig=org.apache.turbine.services.logging.PropertiesLoggingConfig
@@ -503,6 +538,32 @@
services.LoggingService.security.destination.file=/WEB-INF/log/jetspeed.log
services.LoggingService.security.className=org.apache.turbine.services.logging.Log4JavaLogger
services.LoggingService.security.level=DEBUG
+
+# An example configuration for using Log4Java, with log4j properties inline
+# The category name - at the end of this line - needs to match the logging facility
name - the first log4j.
+# need this rootCategory entry to capture the torque/fulcrum etc logging
+services.LoggingService.logforj.log4j.rootCategory = INFO, logforj, access
+
+# need this category entry for the actual jetspeed logging (I don't know why it
doesn't get covered by the root category!)
+services.LoggingService.logforj.log4j.category.logforj = DEBUG, logforj
+
+services.LoggingService.logforj.log4j.appender.logforj.file
=${webappRoot}/WEB-INF/log/jetspeed.log
+services.LoggingService.logforj.log4j.appender.logforj =
org.apache.log4j.FileAppender
+services.LoggingService.logforj.log4j.appender.logforj.layout =
org.apache.log4j.PatternLayout
+services.LoggingService.logforj.log4j.appender.logforj.layout.conversionPattern =
[%d{dd MMM yyyy HH:mm:ss} %5p] - %m%n
+services.LoggingService.logforj.log4j.appender.logforj.append = false
+services.LoggingService.logforj.className=org.apache.turbine.services.logging.Log4JavaLogger
+services.LoggingService.logforj.level=DEBUG
+
+# An example configuration for portlet access audit logging
+services.LoggingService.access.log4j.category.access = INFO, access
+services.LoggingService.access.log4j.appender.access.file =
${webappRoot}/WEB-INF/log/access.log
+services.LoggingService.access.log4j.appender.access = org.apache.log4j.FileAppender
+services.LoggingService.access.log4j.appender.access.layout =
org.apache.log4j.PatternLayout
+services.LoggingService.access.log4j.appender.access.layout.ConversionPattern = %m%n
+services.LoggingService.access.log4j.appender.access.append = true
+services.LoggingService.access.className =
org.apache.turbine.services.logging.Log4JavaLogger
+services.LoggingService.access.level = INFO
# An example configuration for automatic log rotation using Log4Java
# This will keep the log file size under 1MB and save up to 5 backup copies
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>