IBM Content Manager, Version 8.5.0.3             

Log file locations

Log files are stored in different locations throughout the content management system, based upon the component. There are default locations for log files, but these locations can be changed. If you change the location of a log file from the default location, ensure that you maintain a record of the new location.

Installation and configuration log files

By default, the installation log files are in the IBMCMREPO/CMVersionFolder/cmcfgmgr/log/hostname directory. The following table contains information about the logs for the various components of an installed and configured content management system.

Table 1. Logs copied into IBMCMROOT/log
Product Install log Configuration log Uninstall log
IBM® Content Manager cminstall.log cmconfig.log cmuninstall.log

Library server log files

The default log file name for the library server is ICMSERVER.log. If the library server is installed in a Windows based environment, the default name and path for the log file is IBMCMROOT\log\ls\LSDBName\ICMSERVER.log. If the library server is installed on an AIX®, Linux, or Solaris based environment, the default log file location is IBMWorkingDirectory/log/ls/LSDBName/ICMSERVER.log. The LSDBName variable is the library server database name and the IBMWorkingDirectory variable is the home directory of the system administration user that is defined during installation.

Resource manager log files

The types of log files used for the resource manager can be divided into the logs that monitor the resource manager application during startup and the logs that monitor the resource manager events while the resource manager is running, as follows:
  • The Java™ Virtual Machine (JVM) logs monitor whether the resource manager application starts correctly. These log files are the SystemOut.log and SystemErr.log files. By default, these files are located in the ${SERVER_LOG_ROOT} path, where SERVER_LOG_ROOT is a WebSphere® Application Server variable that is defined in the application server scope. The default for SERVER_LOG_ROOT is ${WAS_HOME}/profiles/${profileName}/logs/${serverName}, where WAS_HOME is the installation directory of WebSphere Application Server, profileName is the name of the profile for the resource manager, and serverName is the name of the application server on which the application is deployed.

    During resource manager initialization, the resource manager logs entries in the SystemOut.log file about the logging level (INFO, DEBUG, and so on) for the resource manager application, the location of the resource manager logging configuration file, the current contents of the logging configuration file, and the location of the resource manager application log file.

  • The resource manager application log file monitors the resource manager application after it starts running. During resource manager initialization, a unique log file for that resource manager is generated by using the data in the logging configuration file, icmrm_logging.xml. The default name for this resource manager log file is icmrm.logfile. The default path for the file is ${SERVER_LOG_ROOT}/rm/rm_appname/icmrm.logfile, or ${WAS_HOME}/profiles/${profileName}/logs/${serverName}/rm/rm_appname/icmrm.logfile, where rm_appname is the resource manager application name in WebSphere Application Server.
    For resource managers in a clustered environment where multiple resource manager application servers are deployed in a single node, the process ID for each resource manager can be appended on the log file name, in the format icmrm.logfile.process_ID. This function is controlled by the Java system variable icmrm.log4j.name.extension. To change the value for icmrm.log4j.name.extension Java system variable, edit the JVM custom properties for the application server by using the administrative console in WebSphere Application Server.
    Table 2. Values for the icmrm.log4j.name.extension Java system variable
    Value of icmrm.log4j.name.extension Definition
    auto Automatically detect whether the resource manager is in a clustered environment. If the resource manager is in a clustered environment, append the process ID to the log file name. The default value for icmrm.log4j.name.extension.
    on Append the process ID to the log file name.
    off Do not append the process ID to the log file name.

    You can also configure the resource manager log output to save in the SystemOut.log file for WebSphere Application Server by clearing any path and file information in the resource manager log configuration utility. To view log output in the SystemOut.log file, use the log viewer in the WebSphere Application Server administrative console.

Important: Review the following information that describes important differences between resource manager log files for Version 8.4.2 and later and versions earlier than Version 8.4.2.

The log file and the location of the log file are changed for Version 8.4.2 and later. Your Version 8.3, Version 8.4, and Version 8.4.1 log configuration settings do not transfer to Version 8.4.2 and later during an upgrade. Beginning in Version 8.4.2, a new resource manager installation uses the default settings from the logging configuration file, icmrm_logging.xml, to set the location of the resource manager log file. The resource manager log files for Version 8.4.2 and later are set to a directory that is relative to the location where the resource manager is running.

If you upgrade IBM Content Manager and you want to keep the log configuration settings from versions earlier than Version 8.4.2, you must do one of the following actions:
  • If you upgrade from any installation of Version 8.4 earlier than Version 8.4.2, including Version 8.4, Version 8.4.1 and fix packs for those versions, back up your current icmrm_logging.xml logging configuration file. After you upgrade to Version 8.4.2 or later, you must use the configuration manager utility to deploy the resource manager. Then restore the backup version of the icmrm_logging.xml file to the same location as the default logging configuration file.
  • For all other upgrades, configure the log settings after upgrading by using the system administration client.
Important: Beginning in Version 8.4.2, file permissions for object files stored on the resource manager file system, including the log files, are changed. The default permission allows read permission on the files only to the user ID that created the file. Users who do not access the resource manager log files as root or as the administrator of the resource manager must know that the default file permission settings on the log files might prevent their access to these files.

Client for Windows log files

Log files from the Client for Windows are kept on the individual client for Windows systems. The location is a user preference, so it might vary from one system to another.

  1. Connect the Client for Windows to the library server.
  2. Select Options > Preferences.
  3. Select General. The Log File Directory identifies the location of the client for Windows logs:
    • ICMClient.log
    • ICMClient.err
    • ICMClientLog.ini

System administration client log files

The system administration client logs error-level information to the cmadmerr.log file, which is located in the system administration client directory. You can change the default parameters of the cmadmin.log file by using the common log control utility in the system administration client.

The toolkit and connectors component of the system administration client logs error information to the dklog.log file.

Java API and C++ API log files

The default log file for the Java APIs and C++ APIs is ${user.name}.dklog.log. The ${user.name} is the machine system logon user ID. By default, this file is located in the IBMCMROOT\log\connectors directory for a Windows based environment or in the /home/ibmcmadm/log/connectors directory for an AIX, Linux, or Solaris based environment.



Last updated: June 2015
dcmlt006.htm

© Copyright IBM Corporation 2015.