Enabling logging for the Connections portlets

In order to diagnose and resolve errors that occur with the IBM® Connections Portlets, you must enable logging.

About this task

When you configure WebSphere® Portal to write the trace and message logging for the Connections portlets, the messages are logged in the trace.log. The file is updated when an error occurs or if trace logs are created. The file is created in the following directory: <portal_server_root>\log. You can enable tracing for each portlet separately. The log classes used for the portlets are as follows:

Activities portlet:
  • com.ibm.lconn.activities.detail
  • com.ibm.lconn.activities
  • com.ibm.lconn.commons.service
  • com.ibm.lconn.profiles.service
Activity Stream portlet:
  • com.ibm.social.*
Blogs portlet:
  • com.ibm.lconn.blog.detail
  • com.ibm.lconn.blog.summary
  • com.ibm.lconn.blog.service
  • com.ibm.lconn.profiles.service
  • com.ibm.lconn.common
Bookmarks portlet:
  • com.ibm.lconn.dogear.detail
  • com.ibm.lconn.dogear.summary
  • com.ibm.lconn.dogear.service
  • com.ibm.lconn.profiles.service
  • com.ibm.lconn.common
Community Overview portlet:
  • com.ibm.lconn.communityOverview
  • com.ibm.lconn.communityOverview.service
  • com.ibm.lconn.profiles.service
  • com.ibm.lconn.common
Forums portlet:
  • com.ibm.lconn.forum.detail
  • com.ibm.lconn.forum.summary
  • com.ibm.lconn.forum.service
  • com.ibm.lconn.profiles.service
  • com.ibm.lconn.common
Library portlet:
  • com.ibm.social.*
Profiles portlet:
  • com.ibm.lconn.profiles
  • com.ibm.lconn.profiles.summary
  • com.ibm.lconn.profiles.service
  • com.ibm.lconn.common
Tags portlet:
  • com.ibm.lconn.tagsi.service
  • com.ibm.lconn.common
Wikis portlet:
  • com.ibm.lconn.wiki
  • com.ibm.lconn.wiki.service
  • com.ibm.lconn.profiles.service
  • com.ibm.lconn.common
VMM adapter:
  • com.ibm.ws.wim.adapter.connections.network.*
  • com.ibm.ws.wim.adapter.*
  • com.ibm.connections.vmm.adapter.filter.*
Note: The recommended logging level is all.
Connections Server: VMM adapter - Sonata Trace specification for sonata/authentication
  • com.ibm.connections.httpClient.*
  • com.ibm.connections.directory.services.*
  • com.ibm.ws.security.*
  • org.apache.commons.httpclient.*
  • SonataHttpHeader
  • SonataHttpBody
Portal Server: VMM adapter - Sonata Trace specification for sonata/authentication
  • com.ibm.connections.httpClient.*
  • org.apache.commons.httpclient.*
  • SonataHttpHeader
  • SonataHttpBody
Inter-portlet Navigation (Piece of Content handler)
com.ibm.lconn.lcaccelerator.search.resolver.*
Note: The recommended logging level is all.
Search center portlet (display provider):
com.ibm.lconn.lcaccelerator.search.display.*
Note: The recommended logging level is all.
Configuration Properties Helper:
com.ibm.lconn.lcaccelerator.profiles.rep.*
Note: The Configuration Properties Helper retrieves all of the configuration settings from the Resource Environment Provider and makes them available to the portlets.
Type-ahead:
  • com.ibm.connections.directory.services.*
  • com.ibm.connections.httpClient.*
  • com.ibm.websphere.wim.*
  • com.ibm.ws.wim.*
Note: The type-ahead builder is used to manage the members/owners. This uses the directory services to function. The recommended logging level is all.
REST Call logging:
  1. Open the file <installed war>\WEB-INF\lcaccelerator\properties\loggerServiceMapping.properties
  2. Set the property TPA_REST_LOG_FLAG to true.
  3. Restart the Application war from the WAS admin console.

This will enable logging of details of the REST service calls to a separate log file These logs will get generated at <installed war>/WEB-INF/logs/RESTCallLogs.log.

You can specify the following log levels: info, fine, finer, finest, and all. To enable logging for one or more of the Connections portlets, do the following:

Procedure

  1. Log into WebSphere Portal as the Administrator
  2. Navigate to Administration > Portal Analysis > Enable Tracing .
  3. In the Append these trace settings field, specify the log level for the desired log class and click the add button (+): For example, com.ibm.lconn.activities.summary=fine
  4. Repeat step 3 for each log class that you want to log.
  5. Log out of portal and log back in.

Example

For example, if you wanted to enable the finest log level for the Activities Detail portlet, you would add these three logging settings:
  • com.ibm.lconn.activities.detail=finest
  • com.ibm.lconn.activities.service=finest
  • com.ibm.lconn.profiles.service=finest
If you wanted to enable the fine log level for the Bookmarks Summary portlets, you would add these logging settings:
  • com.ibm.lconn.dogear.summary=fine
  • com.ibm.lconn.dogear.service=fine