Expeditor Client for Desktop and Devices,
Version 6.1.x
Operating systems: Linux on x86, Symbian, Windows
Expeditor Client for Desktop and Devices,
Version 6.1.x
The Lotus® Expeditor Client platform leverages the Java™ Runtime Environment java.util.logging logging framework for persistence of all of the platform and application log and trace messages.
The default configuration of the platform logging framework is stored in the user’s workspace/.config/rcpinstall.properties file. For information on updating this file, see Updating the rcpinstall.properties file.
Handlers
The
default configuration for the client platform registers three handlers: a
console handler, a log handler and a trace handler. 
The encoding
for the file-based handlers (log and trace) is set to UTF-8 while the console
encoding defaults to the platform encoding method for all log messages.
The
number of files (count) to be persisted for each of the handlers defaults
to 6, and the maximum size (size) for each of the files before they will be
rotated defaults to 4000000 bytes.The size can be set individually
for both the log and trace handlers and has a minimum size of 100K bytes. The
default message level filter for the console handler and the trace handler
is FINEST allowing all messages that are logged to be captured by these handlers
and processed appropriately, while the log handler defaults to WARNING to
ensure that the system log, which is intended for the end user is not overrun
with informational messages and trace messages during normal execution. This
setting allows the end user to more easily identify possible problems in the
log file in the case where the application/platform is not functioning as
expected.
One important note is that while the standard java.util.logging settings are used for most of the configuration, the one variation from this is the pattern setting. The pattern for the Lotus Expeditor Client is expected to just be a relative name from the users workspace/logs directory and does not support the %h replacement defined by java.util.logging to relocate these log files.
Formatters
If the platform is started with a console, all log and trace messages are routed to the console handler and displayed using the standard text format using the RCPFormatter. The standard log and trace files are written by default in CommonBaseEvent XML format using the CBE101Formatter.
Logger level configuration
The default rcpinstall.properties file also includes a small collection of default java.util.logging logger level configuration as well. There are 2 special named loggers defined to handle system.err and system.out messages they are called SystemOut and System.err. They default to the INFO level which means that system.err and system.out messages will not appear by default in the system.log file but they will appear in the system trace file.
Default Configuration
# JSR47 Logging Configuration handlers=java.util.logging.ConsoleHandler com.ibm.rcp.core.internal.logger.boot.RCPLogHandler com.ibm.rcp.core.internal.logger.boot.RCPTraceHandler com.ibm.rcp.core.internal.logger.boot.RCPLogHandler.encoding=UTF-8 com.ibm.rcp.core.internal.logger.boot.RCPTraceHandler.encoding=UTF-8 .level=WARNING SystemOut.level=INFO SystemErr.level=INFO com.ibm.rcp.core.internal.logger.frameworkhook.level=CONFIG com.ibm.rcp.core.internal.logger.boot.RCPLogHandler.level=WARNING com.ibm.rcp.core.internal.logger.boot.RCPTraceHandler.level=FINEST java.util.logging.ConsoleHandler.level=FINEST java.util.logging.ConsoleHandler.formatter=com.ibm.rcp.core.internal .logger.boot.RCPFormatter # RCP Logging Configuration #com.ibm.rcp.core.internal.logger.boot.RCPLogHandler.formatter= com.ibm.rcp.core.internal.logger.boot.RCPFormatter com.ibm.rcp.core.internal.logger.boot.RCPLogHandler.formatter= com.ibm.rcp.core.internal.logger.cbe.CBE101Formatter com.ibm.rcp.core.internal.logger.boot.RCPLogHandler.size=4000000 com.ibm.rcp.core.internal.logger.boot.RCPLogHandler.count=6 com.ibm.rcp.core.internal.logger.boot.RCPLogHandler.append=false com.ibm.rcp.core.internal.logger.boot.RCPLogHandler.pattern=error- log-%g # RCP Trace Configuration #com.ibm.rcp.core.internal.logger.boot.RCPTraceHandler.formatter= com.ibm.rcp.core.internal.logger.boot.RCPFormatter com.ibm.rcp.core.internal.logger.boot.RCPTraceHandler.formatter= com.ibm.rcp.core.internal.logger.cbe.CBE101Formatter com.ibm.rcp.core.internal.logger.boot.RCPTraceHandler.size=4000000 com.ibm.rcp.core.internal.logger.boot.RCPTraceHandler.count=6 com.ibm.rcp.core.internal.logger.boot.RCPTraceHandler.append=false com.ibm.rcp.core.internal.logger.boot.RCPTraceHandler.pattern=trace- log-%g
Log message federation
While the JRE java.util.logging APIs are used for the actual persistence of messages to disk, it is important to note that there are several logging APIs available in the Lotus Expeditor Client platform. The client platform provides the following logging APIs: java.util.logging APIs, eclipse logging APIs, the OSGi LogService APIs, and Apache Commons logging APIs. The core logging framework of the Lotus Expeditor Client platform captures the messages from all of these APIs and federates them into one single log using the java.util.logging persistence and formatting framework. To simplify configuration of these federated messages, dynamic named loggers are created for the non-java.util.logging components when messages of the appropriate level are generated and logged. The named loggers are created with the bundle symbolic name of the OSGi bundle that is logging the message as the name of the java.util.logging logger. This logger can be configured using the standard java.util.logging logger level configuration using the rcpinstall.properties file or dynamically using the OSGi console command setlogrlev. See Dynamically adjusting the log level in Lotus Expeditor Troubleshooting and Support for more information on this capability.
Last updated: January 21, 2008