170 IBM Workplace Managed Client 2.6 on Linux
Another piece of information that can fall under the “logging” umbrella is the
output contained in another file in the $WORKSPACE/logs directory. At startup,
the client produces a file called config0.log that contains a large amount of client
environment information, including the user policy data that is influencing various
aspects of the client’s behavior. As described earlier in this book, the server-side
user policies control the what a user is able to do with Workplace Managed
Client. If a user reports some type of problem that might be related to a policy
issue, reference this config.log file to determine what policy setting with which the
client is operating. For example, if a user is unable to create a document library,
check the config0.log file to confirm that the following parameters are both set:
isDocumentManagementEnabled:true
isCreateDocumentApplicationEnabled:true
The config0.log file also contains a wealth of other data, such as the flags passed
to both Eclipse and the JVM when starting the client, the overall Java
environment the client is running, a complete list of client features that have been
provisioned, and the entire plug-in registry, which contains a list of all the plug-ins
installed and their versions. Needless to say, this is a very important file to review
whenever a problem arises in executing the client.
6.1.2 Tracing
From an overall serviceability perspective, logging and tracing are very similar in
concept and implementation in IBM Workplace products. The only real
distinctions are the amount and type of details that gets put in the log file and
globalization issues (what gets translated and what does not). That said, tracing
is a very important part of problem determination, and users need to understand
how to control tracing levels in case they need to provide detailed log output to
IBM Support.
Note: The config0.log file might contain two sets of data from the same
execution of the client code. If a change to the policy data is detected relative
to the previously cached policy settings, the old and new policy settings will
both be dumped to this file. To make sure that you review the correct data,
each set of policy data is preceded by a line that contains the date and time
stamp of the time the policy is cached. For example:
Dec 15, 2005 10:36:31 AM com.ibm.workplace.policymanager.rcp.RcpPolicy
setCachedPolicy
Ensure that the settings you check are the most recent. Also, similar to the
behavior of the rcp0.log file, when the config0.log file is created, the previous
configuration log is renamed to config1.log. In the case of the configuration
logs, there will only ever be two of them at most.
Chapter 6. Troubleshooting IBM Workplace Managed Client 171
To control the tracing level for a particular component of the client, the user must
modify the Java logging level for the specific packages in that product
component. To do so, the user must edit the
$INSTALL_DIR/rcp/plugin_customization.ini file.
$INSTALL_DIR is the location the user chose to install to when first installing the
client (the default is /opt/IBM/Workplace Managed Client). In this file, the user
can add an entry such as:
com.ibm.workplace.mail.level=FINEST
This will set the FINEST level of tracing on the mail package in order to trace
errors that occur in the client when using the mail facilities.
Another thing to understand about setting tracing is that it follows the package
hierarchy so that setting trace on a lower-level package overrides any setting for
a package that is higher in the hierarchy. For example, if the
plugin_customization.ini file specifies the following trace setting, all packages
under that hierarchy will log at the default INFO level:
com.ibm.wkplc.bl.rcp.infra.level=INFO
If a user also adds the following setting, the views package (and any package
under it) would log at the FINEST level, while the rest of the packages under the
com.ibm.wkplc.bl.rcp.infra layer would continue to log only INFO or higher
severity messages:
com.ibm.wkplc.bl.rcp.infra.views.level=FINEST
Note: In most cases, trace output is intended to be used by IBM Support to
facilitate troubleshooting. Users generally do not need to understand the
content.
Important: This is the pattern to follow for all trace settings:
<package_name>.level=<severity>
Where <severity> is SEVERE, WARNING, INFO, FINE, FINER, or FINEST.
The severity must be set with all uppercase letters in order to be recognized.
Also, changes to trace levels are not dynamic. IBM Workplace Managed
Client must be restarted for changes to take effect.
For more information about the java.util.logging.Level specification, see:
http://java.sun.com/j2se/1.4.2/docs/api/java/util/logging/Level.html

Get IBM Workplace Managed Client 2.6 on Linux now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.