Using TM1 Log Files

This is a great explanation of the different types of logging within TM1 for setting the different logging options to DEBUG mode.  This article was written for people to submit logs to support, however is a great explanation of logs in TM1.

For most TM1 Logging, they can be modified so you are not recording at DEBUG level, but rather at a higher, less granular level.

The source of this tech note is ibm.com.

For TM1 Message Logging specifically, I have added the different levels available.

Problem(Abstract)

This document details how to enable DEBUG logging for the majority of IBM Cognos TM1 10.2.0 components.

Diagnosing the problem

IBM Cognos TM1Web Logging

Configuring and Enabling IBM Cognos TM1 Web Logging:

http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_op.10.2.0.doc/t_configuringandenablingtm1weblogging_n51964.html?path=2_5_9_2_2#ConfiguringandEnablingTM1WebLogging_N51964

How to:

To enable TM1 Web logging, we must edit the log4j.properties file for TM1 Web. The log4j.properties file is installed in the ‘<TM1_install_location>\webapps\tm1web\WEB-INF\configuration\’ directory. Always backup the original file before making changes.

Look for and change the following from:
# System logging settings
log4j.rootLogger=ERROR, TextFile
log4j.logger.com.ibm.cognos=ERROR
log4j.logger.com.cognos=ERROR

to:
# System logging settings
log4j.rootLogger=ERROR, TextFile
log4j.logger.com.ibm.cognos=DEBUG
log4j.logger.com.cognos=DEBUG

After all necessary logging has been enabled, recreate the problem we are troubleshooting and make note of the time the problem had occurred (if possible). Then, zip up the entire ‘<TM1_install_location>\webapps\tm1web\WEB-INF\logs’ directory, and send to Support.

IBM Cognos TM1 Admin Server Logging

Configuring Admin Server Logging:

http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_op.10.2.0.doc/c_configuringadminserverlogging_n160173.html?path=2_5_7_1_1#ConfiguringAdminServerLogging_N160173

Enabling Admin Server Logging: http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_op.10.2.0.doc/c_enablingadminserverlogging_n1601ea.html?path=2_5_7_1_2#EnablingAdminServerLogging_N1601EA

How to:

To enable TM1 Admin Server logging, we must edit the tm1admsrv-log.properties file, located in the TM1_64\bin64 or \bin directory.

Look for and change the following from:
log4j.rootLogger=INFO, R1
log4j.logger.TM1=INFO

to

log4j.rootLogger=DEBUG, R1
log4j.logger.TM1=DEBUG

After all necessary logging has been enabled, recreate the problem we are troubleshooting and make note of the time the problem had occurred (if possible). Then, zip up the TM1_64\bin64\tm1admsrv.log (or TM1_64\bin\tm1admsrv.log) file and send to Support.

IBM Cognos TM1 Applications Logging

How to:
Navigate to the TM1_64\webapps\pmpsvc\WEB-INF\configuration\ folder. Open the log4j.properties file with notepad.

Look for and change the following from:
# System logging settings
log4j.rootLogger=ERROR, TextFile
log4j.logger.com.ibm.cognos=ERROR
log4j.logger.com.cognos=ERROR
log4j.logger.com.cognos.org=ERROR
log4j.logger.com.ibm.cognos.perf=ERROR

to
# System logging settings
log4j.rootLogger=ERROR, TextFile
log4j.logger.com.ibm.cognos=DEBUG
log4j.logger.com.cognos=DEBUG
log4j.logger.com.cognos.org=ERROR
log4j.logger.com.ibm.cognos.perf=ERROR

After all necessary logging has been enabled, recreate the problem we are troubleshooting and make note of the time the problem had occurred (if possible). Then, zip up the TM1_64\webapps\pmpsvc\WEB-INF\logs directory and send to Support.

IBM Cognos TM1 Performance Modeller Logging

How to:

To enable Performance Modeller logging, navigate to the C:\Users\ directory and find the folder that matches the name of the user running into problems. From here, drill down until you reach ‘\AppData\Roaming\IBM\Cognos Performance Modeller’ directory.

Look for and change the following lines in the defaultLog.properties file from:
log4j.rootLogger=ERROR, appAppender
log4j.logger.com.cognos=ALL
log4j.logger.com.ibm.cognos=ALL

to

log4j.rootLogger=DEBUG, appAppender
log4j.logger.com.cognos=ALL
log4j.logger.com.ibm.cognos=ALL

After all necessary logging has been enabled, recreate the problem we are troubleshooting and make note of the time the problem had occurred (if possible). Then, zip up the ‘IBM\Cognos Performance Modeler\Logs’ directory and send to Support.

IBM Cognos TM1Top Logging (if you have it):

Currently, TM1Top does not come with TM1 10.2 by default, as it has been replaced by TM1 Operations Console (which is contained in it’s own section, of this technote). That said, TM1Top is likely to become available on DeveloperWorks in the future – for which this technote will be updated, when applicable. For now, these steps can be used to connect a TM1 10.1.1 version of TM1Top to a TM1 10.2.1 Server.

Configuring the TM1Top.ini File:

http://pic.dhe.ibm.com/infocenter/ctm1/v10r1m0/topic/com.ibm.swg.ba.cognos.tm1_op.10.1.1.doc/c_configuringthetm1top.inifile_n160feb.html?path=2_3_7_7_1#ConfiguringtheTm1top.iniFile_N160FEB

Running TM1Top: http://pic.dhe.ibm.com/infocenter/ctm1/v10r1m0/topic/com.ibm.swg.ba.cognos.tm1_op.10.1.1.doc/t_runningtm1top_n16117d.html?path=2_3_7_7_2#RunningTM1Top_N16117D

How to:

By default, a sample Tm1top.ini file is installed to the TM1_64\bin directory. When you run TM1 Top, the Tm1top.ini file should be located in the same directory as the TM1 Top executable file. If you modify the TM1Top.ini file correctly, launching TM1Top should be as simple as launching the tm1top.exe file. Keep TM1Top open, or logging will stop.

Look for and change the following lines to match your environment set up:
adminhost=
servername=
logfile=

to
adminhost=ADMINHOST_MACHINENAME
servername=NAME_OF_TM1_SERVER
logfile=C:\tm1top.log

After all necessary logging has been enabled, recreate the problem we are troubleshooting and make note of the time the problem had occurred (if possible). Then, zip up the C:\tm1top.log file and send to Support.

IBM Cognos TM1 Operations Console:

TM1 Operations Console is a new TM1 Server Monitoring tool. Operations Console allows you to monitor and log multiple TM1 Servers at once.

Installing Cognos TM1 Operations Console:

http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_inst.10.2.0.doc/t_tm1_inst_installingopsconcole.html

Configure Cognos TM1 Operations Console:

http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_inst.10.2.0.doc/t_tm1_ops_console_configurethecognostm1operationsconsole.html

Using Cognos TM1 Operations Console:

http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_ops_console.10.2.0.doc/c_tm1_ops_console_usingthecognostm1operationsconsole_2.html

Creating and Configuring TM1 Operations Console Log Files:

http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_ops_console.10.2.0.doc/c_tm1_ops_console_configur_logs_files.html

How to:

You will first need to install and configure TM1 Operations Console, using the links provided above. Once TM1 Operations Console is configured to the point where you can log in to TM1 Operations console (via http://servername:9510/pmhub/pm/opsconsole). Once you are logged in to TM1 Operations Console:

1 – Add an operation group, and the TM1 Server you wish to monitor ( http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_ops_console.10.2.0.doc/t_tm1_ops_default_setup.html )

2 – Configure the Monitor for Enhanced logging (http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_ops_console.10.2.0.doc/t_tm1_ops_console_usingthemonitorstab.html )
***If this is production, note that a performance impact may be seen when enhanced logging is enabled. You may want to start with Basic logging first.

3 – Make sure logging is enabled for the Monitor you had configured, via http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_ops_console.10.2.0.doc/c_tm1_ops_console_settingthelogfilenumericparameters.html

Once the problem has been recreated, ZIP up the resulting log file and provide it to Support. You can download a CSV copy of the log file following the steps here: http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/index.jsp?topic=%2Fcom.ibm.swg.ba.cognos.tm1_inst.10.2.0.doc%2Ft_tm1_inst_installingopsconcole.html

Alternatively, the log file is created and can be obtained in the following directory: ‘\tm1_64\webapps\tm1operationsconsole\UserData\<AdminHostName>\<TM1ServerName>\admin\Logs\’

IBM Cognos TM1 Server Logging

Enabling and Disabling Logging:

http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_op.10.2.0.doc/t_enablinglogging_n160693.html?path=2_5_7_3_3_0#EnablingLogging_N160693

Configuring Logging Message Level:

http://pic.dhe.ibm.com/infocenter/cbi/v10r2m1/topic/com.ibm.swg.ba.cognos.tm1_op.10.2.0.doc/r_configuringloggingmessagelevel_n160729.html?path=2_5_7_3_3_1#ConfiguringLoggingMessageLevel_N160729

How to:

Use a copy of the logging properties file, tm1s-log.properties, to configure and enable message logging for a specific TM1® server. The tm1s-log.properties should be located in the same directory as the tm1s.cfg file for the TM1 Server you are troubleshooting. If the file does not exist, you should be able to copy it from one of the TM1 Sample DBs that come with the installation.

Look for and change the following:
log4j.logger.TM1=INFO, S1

to

log4j.logger.TM1=DEBUG, S1

After all necessary logging has been enabled, recreate the problem we are troubleshooting and make note of the time the problem had occurred (if possible). Then, zip up the TM1_Logging_Dir\tm1server.log(s) file and send to Support

Message Log Levels

Message levels are logged as follows:

Setting logging to DEBUG will report all severity levels messages.
Setting logging to WARN will report WARN, ERROR, and FATAL messages.
Setting logging to OFF disables all logging for the specific TM1 logger.
Appender is the output destination. Use a value of S1 for the TM1 shared memory appender which transfers messages to memory before saving them to a file.
For example, to turn on logging at the DEBUG level for all TM1 sub-components, you would use the following statements:

log4j.rootLogger=DEBUG, S1
log4j.logger.TM1=DEBUG

Now What?

After enabling 1 or more of the above debugging loggers, the following debug log files can be provided to IBM Cognos Support for review.

-tm1web.log
-tm1admsrv.log
-tm1top.log
-tm1operationsconsole.log (file name varies / is not static)
-tm1server.log
-pmpsvc.log

*Always ZIP the logs prior to sending to Support
**Disable any DEBUG logging once you’ve collected what you need

If you like this post, please spread the love…

About John

Managing Director of Infocube. We are a management accounting consultancy that specialises in Business Analytics.

This entry was posted in Administration, TM1 Admin, TM1 Administration, TM1Top. Bookmark the permalink.