Sun Java System Instant Messaging 7.2 Administration Guide

Administering Logging for Instant Messenger

By default, Instant Messenger data is not logged. You may be asked to collect client data during a support call. In this situation, you will need to enable logging before you can view client log data.

Instant Messenger logs are created on demand and stored in the user's home directory (usr_home/.sunmsgr/messenger.log).

Setting Up Logging for Instant Messenger

To set up logging for Instant Messenger you will need to:

  1. Determine the type of data you want to collect.

  2. Modify im.jnlp to include the logconfig parameter.

  3. Specify a type for the logconfig parameter based on the type of data you want to collect.

  4. Redeploy the resource files.

ProcedureTo Enable Logging for Instant Messenger

  1. Make a backup copy of im.jnlp.

  2. Open the im.jnlp Instant Messenger resource file in a text editor.

  3. Search for the line:


    <application-desc main-class="com.iplanet.im.client.iIM">
  4. Add the following argument to the end of the section:


    <argument>logconfig=type</argument>
    

    Where type is one of ALL, API, XMPPTRAFFIC, or CLIENT. See Instant Messenger Log File Content Options for details.

  5. Save and close the im.jnlp file.

  6. If you are using Sun Java System Application Server or Sun Java System Web Server, redeploy the resource files as described in Redeploying Resource Files.

  7. Relaunch Instant Messenger.

  8. Locate the log file.

    By default the log file is stored as usr_home/.sunmsgr/messenger.log.

Next Steps

You should revert back to the backup copy of im.jnlp when you have finished troubleshooting Instant Messenger. Then, redeploy the resource files as described in Redeploying Resource Files.

Locating the Instant Messenger Log File (messenger.log)

By default, the Instant Messenger log file is stored as messenger.log under the user's home directory as follows:


/usr_home/.sunmsgr/messenger.log

Instant Messenger Log File Content Options

You can determine what activity you want logged in messenger.log by specifying a value for the logconfig parameter in im.jnlp. Table 13–3 describes the configuration parameters for logconfig. See To Enable Logging for Instant Messenger for instructions on setting the logconfig parameter and generating Instant Messenger logs.

Table 13–3 Instant Messenger Logging Options for messenger.log

logconfig value

messenger.log Contains...

ALL

Information for the API, all traffic between client and server, as well as debugging information for the Instant Messenger client application itself. 

API

API information only. 

XMPPTRAFFIC

Client to server communication only. 

CLIENT

Client application (Instant Messenger) details only.