Cookbook Contents

Overview

OpenSocial Component functionality spans many different components and may span across the client and server. Therefore any support data that is collected may also need to span the different components and the client and server. In order to understand what support data to collect, an administrator should refer to the gadget rendering process and the Deployment Architecture. Support data should be collected from all components that are involved in the rendering scenario that is seeing the issue. For instance, if an OpenSocial gadget that uses OAuth is failing to render in the Notes client, both the Notes client logs and the Domino Server with Shindig logs would need to be considered.

The Notes client logs will report information on where the OpenSocial gadget or Embedded Experience is rendering. The OpenSocial Component location will be "localhost" when rendering locally or the hostname of the Domino Server with Shindig when rendering remotely.

Collecting Support Data in Notes

Support data for the OpenSocial Component in Notes can be collected via the normal "Collect Support Data" mechanism, also referred to as IBM Support Assistant (ISA). Custom tracing should be enabled to ensure the most detailed information is available for troubleshooting. Logs for the OpenSocial Component in Notes will primarily appear in the workspace logs, i.e., <Notes Data Directory>/workspace/logs.

1. Run the ISA tool


2. Enable customized tracing


3. Select the "Embedded Experiences" tracing


4. Pause the collector


5. Press "Pause"


6. Reproduce the issue.
7. Go back to Help -> Support -> Collect Support Data
8. "Collect" and provide the ISA

Collecting Support Data in iNotes

The iNotes client provides a console, the contents of which can be viewed and copied from the browser. For more information, see Using the iNotes console log to inspect and copy debug information Note: While the UI in the aforementioned article is the pre-9.0 UI, the instructions are still relevant in 9.0.

In 9.0, the iNotes console provides a build number for "WCAN" (as indicated below), which is the build component ID for the OpenSocial Component on the iNotes server. If the OpenSocial Component is not installed on the iNotes server, this version number will not appear.

Collecting Support Data on Domino

Collecting support data on Domino is not as straightforward as collecting Notes or iNotes client logs. Custom logging must be enabled by hand, as outlined below. One must also consider which components are involved in the area being diagnosed. This is done by keeping in mind the gadget rendering process and the Deployment Architecture.

Workspace log locations

The OpenSocial Component on the Domino server will primarily generate logs in the OSGi workspace (similar to Notes); however, with the introduction of DOTS there are two distinct workspace folders that should be checked for logs, one for the OSGi instance that runs as part of the HTTP task and one that runs as part of the DOTS task.

OSGi on HTTP

OSGi logs from the HTTP task can be found under <Domino Data Directory>/domino/workspace/logs

To enable custom logging for the OSGi instance for the HTTP task, one can modify <Domino Data Directory>/domino/workspace/.config/rcpinstall.properties. The HTTP task must be restarted after making these changes.

OSGi on DOTS

OSGi logs from the DOTS task can be found under <Domino Data Directory>/domino/workspace-dots/logs

To enable custom logging for the OSGi instance for the DOTS task, one can modify <Domino Data Directory>/domino/workspace-dots/.config/rcpinstall.properties. The DOTS task must be restarted after making these changes.

Custom logging to enable

Widgets in iNotes

This section includes logging that should be enabled for diagnosing problems with Widgets in iNotes, including OpenSocial widget trust management.

Enable custom logging on the iNotes Mail Server
OSGi on HTTP


OSGi on DOTS

OpenSocial Gadgets and Embedded Experiences

Note: This applies not only to OpenSocial gadgets and Embedded Experiences that are rendering in iNotes, but also those rendering remotely in the Notes client.

Enable custom logging on the Domino Server with Shindig

Cookbook Contents