How to Enable Debug Troubleshooting Information for IM Manager

Article:TECH88706  |  Created: 2006-01-22  |  Updated: 2011-12-06  |  Article URL http://www.symantec.com/docs/TECH88706
Article Type
Technical Solution

Product(s)

Issue



Debug logging can be enabled in IM Manager to retrieve detailed output from the IM Manager services. Debug logging must be enabled for each of the services.  

This article describes how to:

  • Enable debug logging for IM Manager
  • Change the location for the IM Manager log files

     

Solution



Prior to perform any steps, download the attachment debug.zip. Extract the files from the ZIP file.

NOTE for Windows 2008: All scripts must be run from a command prompt that is running as a Local Machine Administrator.

Perform the following steps: 

1. Click the Start menu.
2. Right click on Command Prompt and select Run as Administrator.



Turn on Debug Logging


      1. Run the file setloglevelhigh.bat.
      2. Reboot the server for the settings to take effect.  If there are specific services for which troubleshooting is needed then just restart those services (see below for the service to log file mapping).


Turn off Debug Logging


    Perform the following steps to configure standard logging for IM Manager:
          1. Run the file setloglevellow.bat.
          2. Reboot the server for the settings to take effect.

 

How to Determine IM Manager Current Log File Locations and Names
 

    Perform the following steps from the IM Manager server:
      1. Run the script setloglevellow.bat. NOTE: This will set the logging level to low. The script outputs the names of the IM Manager log files.


Change Locations of logs

1. If the server is a Microsoft Live/Office Communications Server then add registry entries by running the following registry file:

2007: lcsnet.reg
2007 R2: Win2K8lcsnet.reg

This adds a specific registry entry for one of the IM Manager LCS/OCS component logfile name.


 2. Run the file setlogpath.bat with a parameter of the path where the debug logs should be stored.

For example the following command line stores the logs on the D drive.

setlogpath.bat d:\

Here is an example setting the log path on e:\logs:

setlogpath.bat e:\temp

3. Reboot the server for the settings to take effect. If there are specific services for which troubleshooting is needed then just restart those services (see below for the service to log file mapping).


 

Information for LCS/OCS Environments
 


Sametime Message Injector
 

    The IM Manager Sametime Message Injector Service does not use any of the items above.

    Perform the following steps to turn on debug logging for the IM Manager Sametime Message Injector Service:
      1. Open regedit.
      2. Open the folder HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\IMlogicSametimeMsgInjector\Parameters.
      3. Double click on the (Default) node in the right hand pane.
      4. Add the path of the log file to the end of the registry value. For example, the following entry sets the path to c:\IMLogicSametimeMsgInjector.log:
        class=MsgInjector -Djava.class.path=IMlogicMsgInjector.zip;STCore.jar wrkdir=C:\Lotus\Domino jvmdll=C:\Lotus\Domino\wsc-jre/jre/bin/classic\jvm.dll IMlogicSametime.ini c:\IMLogicSametimeMsgInjector.log
      5. Restart the Windows Service IMlogic Sametime Message Injector.



Technical Information


Changing the Maximum Log File Size Manually
 


    The maximum log file size is specified by the registry key MaxLogFileSize in the following locations:

    For Windows 2003:

    HKLM\Software\IMLogic\IMLogEnterprise\4.0\RelayService
    HKLM\Software\IMLogic\IMLogEnterprise\4.0\AdminService
    HKLM\Software\IMLogic\IMLogEnterprise\4.0\LDapUpdate
    HKLM\Software\IMLogic\IMLogEnterprise\4.0\Service
    HKLM\Software\IMLogic\IMLogEnterprise\4.0\LCS
    HKLM\Software\IMLogic\IMLogEnterprise\4.0\Reuters
    HKLM\Software\IMLogic\IMLogEnterprise\4.0\Filter
    HKLM\Software\IMLogic\IMLogEnterprise\4.0\Sametime

    For Windows 2008:

    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\IMLogic\IMLogEnterprise\4.0\RelayService
    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\IMLogic\IMLogEnterprise\4.0\AdminService
    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\IMLogic\IMLogEnterprise\4.0\LDapUpdate
    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\IMLogic\IMLogEnterprise\4.0\Service
    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\IMLogic\IMLogEnterprise\4.0\LCS
    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\IMLogic\IMLogEnterprise\4.0\Reuters
    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\IMLogic\IMLogEnterprise\4.0\Filter
    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\IMLogic\IMLogEnterprise\4.0\Sametime

    The above registry keys specify the maximum log file size in bytes.

    The following registry key specifies the maximum log file size in Megabytes:

    For Windows 2003:
        HKLM\Software\IMLogic\IMLogEnterprise\4.0\LCS\MaxNetLogFileSizeMB
    For Windows 2008:
        HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\IMLogic\IMLogEnterprise\4.0\LCS\MaxNetLogFileSizeMB

    Some IM Manager logs rotate and produce up to ten logs of the specified size.

    IMLinkage.log(.1..10) file sizes are controlled by the IMLinkage.xml file. The standard size of IMLinkage.log files is 50 MB.

    To adjust the maximum size of the IMLinkage.log files follow these steps:
      1. Open the file <im manager installation directory>\IMManager\IMLinkage\config\imlinkage.xml in an editor.
      2. Locate the following lines in the file:
        <logFileName>C:\IMLinkage.log</logFileName>
        <logLevel>ERROR</logLevel>
        <logLevel>WARNING</logLevel>
        <logLevel>INFORMATION</logLevel>
      3. Add a line with the <maximumLogSize> node after the <logFileName> node that contains the size in megabytes. For example, the following configures the logfiles for 50 megabytes:
        <logFileName>C:\IMLinkage.log</logFileName>
        <maximumLogSize>50</maximumLogSize>
        <logLevel>ERROR</logLevel>
        <logLevel>WARNING</logLevel>
        <logLevel>INFORMATION</logLevel>

      Note: The <maximumLogSize> node controls the file size, the log file is in megabytes.

    To change the size of the JavaLiveUpdate log file (1 MB by default) perform the following steps:

    1. Open the file C:\Documents and Settings\All Users\Application Data\Symantec\Java LiveUpdate\liveupdate.conf in an editor.
    2. Add the following line to the end of the file:

    maximumLogFileSize=100

    The value is the size of the file in kilobytes. This setting sets the maximum log file size for Java Liveupdate to 100KB


Rolling Log Files
 

    Some of the IM Manager log files are rolling. This means that when the current log file (e.g. LCLoggingService.log) reaches the maximum size (see above) then the log file LCLoggingService.log.10 is removed, The file LCLoggingService.log.9 is renamed to LCLoggingService.log.10. The same process happens for logs 1 through 8. Then the current file is renamed to LCLoggingService.log.1. A new file called LCLoggingService.log is created.
    It is not possible to change the number of log files retained.


Log File to Process Mapping

Process/Service Name Log File(s)
IMLogService IMManagerservice.log(1..10)
IMLogRelayService

imlinkage.log(1..10)
immanagerelayservice.log(1..10)

LdapUpdateService ldapupdateservice.log(1..10)
IMLogic Admin Service IMManageradminservice.log(1..10)
Auto Update Service AutoUpdateService.log(1..10)
LC Logging Service

RTCLoggingServiceNET.log(1..10)

LC Filter Service

RTCLoggingService.log(1..10)
RTCFilterServiceNET.log(1..10)

IMLog Message Injector Service MSGInjectorService.log(1..10)
ST Chat Logging IMManagerSametime.log
ST File Transfers IMManagerSametimeFT.log
Sametime Message Injector IMLogicSametimeMsgInjector.log


 


Attachments

debug.zip (5 kBytes)
lcsnet.reg (154 Bytes)


Win2K8lcsnet.reg (308 Bytes)


Legacy ID



2007984783470698


Article URL http://www.symantec.com/docs/TECH88706


Terms of use for this information are found in Legal Notices