Agent trace logs

$('a[name]').remove(); $('#ic-homepage__footer').before('

'); $("#tabs").tabs({ selected: 1 }); $("#ic-homepage__ic-tips").append( quickTipHTML() ); unhideOneProductTip(); $("#ic-homepage__product-tips").wrapInner('

'); $("#ic-homepage__feed-tips").wrapInner('

'); });

IBM Tivoli Monitoring > Version 6.3 > User's Guides > Agent Builder User's Guide > Troubleshooting IBM Tivoli Monitoring, Version 6.3

Agent trace logs

Trace logs capture information about the operating environment when component software fails to operate as intended.
The principal log type is the RAS (Reliability, Availability, and Serviceability) trace log. These logs are in the English language only. The RAS trace log mechanism is available for all components of IBM Tivoli Monitoring. Most logs are in a logs subdirectory on the host computer. See the following sections to learn how to configure and use trace logs:

Principal trace log files

Example for using trace logs

Set RAS trace parameters

The documentation refers to the RAS facility in IBM Tivoli Monitoring as RAS1.
IBM Software Support uses the information that is captured by trace logs to trace a problem to its source or to determine why an error occurred. Although the default configuration for trace logs is to be enabled, it can be disabled.

Overview of log file management

(Table 1) provides the names, locations, and descriptions of RAS1 log files. The log file names adhere to the following naming convention:
hostname_productcode_[instance_]kproduct_codeagent_timestamp-nn.log
where:

hostname is the host name of the machine on which the monitoring component is running.

product_code is the last two characters of the product code (for example, for K33, it would be 33).

instance is the instance ID of a multi-instance agent. The instance ID can be up to 26 characters long.

timestamp is an eight-character hexadecimal time stamp that represents the time at which the program started.

nn is a rolling log suffix. See Examples of trace logs for details of log rolling.

Single and multi-instance agents build differently formatted log file names. Multi-instance agents include the instance ID in the log file name. The following example is for a multi-instance agent that runs on balayne, with product code k11 and instance ID inst1:
BALAYNE_11_inst1_k11agent_46c31514-01.log
The following example is for a single instance agent that runs on balayne, with product code 13:
inst1 BALAYNE_13_k13agent_46c49270-01.log

Examples of trace logs

For example, if a monitoring agent is running on computer server01 with the product code of K33, the RAS log file for a data source might be named:
server01_33_437fc59-01.log
For long-running programs, the nn suffix is used to maintain a short history of log files for that startup of the program. For example, the data source might have a series of log files as follows:
server01_33_437fc59-01.log server01_33_437fc59-02.log server01_33_437fc59-03.log
As the program runs, the first log (nn=01) is preserved because it contains program startup information. The remaining logs roll: when the set of numbered logs reaches a maximum size, the remaining logs are overwritten in sequence.
Each time a program is started, a new time stamp is assigned to maintain a short program history. For example, if the data source is started twice, it might have log files as follows:
server01_33_437fc59-01.log server01_33_437fc59-02.log server01_33_437fc59-03.log server01_33_537fc59-01.log server01_33_537fc59-02.log server01_33_537fc59-03.log

Principal trace log files

(Table 1) contains locations, file names, and descriptions of trace logs that can help determine the source of problems with agents.

Trace log files for troubleshooting agents

System where log is located File name and path Description
On the Tivoli Enterprise Monitoring Server

On Windows: The file IBM Tivoli Monitoring timestamp.log in the install_dir\InstallITM path.

On UNIX: The candle_installation.log file in the install_dir/logs path.

Provides details about products that are installed.
Trace logging is enabled by default. A configuration step is not required to enable this tracing.
The Warehouse_Configuration.log file is in the following path on Windows: install_dir\InstallITM. On UNIX, the file is in the following path: install_dir/Install Provides details about the configuration of data warehousing for historical reporting.
Name of the RAS log file is as follows:

On Windows: install_dir\logs\hostname_ms_HEXtimestamp-nn.log

On UNIX: install_dir/logs/hostname_ms_timestamp.log

File names for RAS1 logs include a hexadecimal time stamp.
Also on UNIX, a log with a decimal time stamp is provided: hostname_productcode_timestamp.log and hostname_productcode_timestamp.pidnnnnn in the install_dir/logs path, where nnnnn is the process ID number.
Traces activity on the monitoring server.
On the Tivoli Enterprise Monitoring Server Name of the RAS log file is as follows:

On Windows: install_dir\logs\hostname_cq_timestamp-nn.log

On UNIX: install_dir/logs/hostname_cq_timestamp-nn.log

File names for RAS1 logs include a hexadecimal time stamp.
Also on UNIX, a log with a decimal time stamp is provided: hostname_productcode_timestamp.log and hostname_productcode_ timestamp.pidnnnnn in the install_dir/logs path, where nnnnn is the process ID number.
Traces activity on the portal server.
The teps_odbc.log file is in the following path on Windows:install_dir\InstallITM path. On UNIX, the file is in the following path: install_dir/logs When you enable historical reporting, this log file traces the status of the warehouse proxy agent.
On the computer that hosts the monitoring agent The RAS1 log files are named
hostname_productcode_[instance]_k[productcode]
agent_timestamp-nn.log

The files are in the install_dir\tmaitm6\logs path.

File names for RAS1 logs include a hexadecimal time stamp.

Multi-instance agents include the instance ID in the log file name.

Traces activity of the monitoring agent.
On the computer that hosts the monitoring agent that includes JDBC or JMX data sources The JMX, JDBC, or Java log file is named as follows, depending on whether the agent uses JMX, JDBC, or both JMX and JDBC (Java):

For a single instance agent
KXX_JMX|JDBC|JAVA_trace.log

For a multiple instance agent
KXX_JMX|JDBC|JAVA_instanceName_trace.log

Traces activity of the data provider Java process for JMX, JDBC, or both.

The RAS1 log files are named hostname_productcode_[instance_]_k[productcode]agent_timestamp-nn.log and are in the install_dir\tmaitm6\logs path.
File names for RAS1 logs include a hexadecimal time stamp.
Multi-instance agents include the instance ID in the log file name.
Definitions of variables:

timestamp is time stamp whose format includes year (y), month (m), day (d), hour (h), and minute (m), as follows: yyyymmdd hhmm

HEXtimestamp is a hexadecimal representation of the time at which the process was started.

install_dir represents the directory path where you installed the IBM Tivoli Monitoring component. install_dir can represent a path on the computer that host the monitoring system, the monitoring agent, or the portal.

instance refers to the name of the database instance that you are monitoring.

hostname refers to the name of the computer on which the IBM Tivoli Monitoring component runs.

nn represents the circular sequence in which logs are rotated. The range is 1-5, by default, though the first is always retained because it includes configuration parameters.

For more information about the complete set of trace logs that are maintained on the monitoring server, see the IBM Tivoli Monitoring Installation and Setup Guide.

Example for using trace logs

Typically IBM Software Support applies specialized knowledge to analyze trace logs to determine the source of problems. However, you can open trace logs in a text editor to learn some basic facts about the IBM Tivoli Monitoring environment. The following example is from the log for a Tivoli Universal Agent data source that is created by the Agent Builder:
!47CC1929.0000!==========> IBM Tivoli RAS1 Service Log <========= +47CC1929.0000 System Name: BALAYNE Process ID: 2152 +47CC1929.0000 Program Name: k01agent User Name: SYSTEM +47CC1929.0000 Task Name: k01agent System Type: WinXP;5.1-SP2 +47CC1929.0000 MAC1_ENV Macro: 0xC112 Start Date: 2008/03/03 +47CC1929.0000 Start Time: 10:28:41 CPU Count: 2 +47CC1929.0000 Page Size: 4K Phys Memory: 2047M +47CC1929.0000 Virt Memory: 2048MPage Space: 3429M +47CC1929.0000 Service Point: system.balayne_01 UTC Start Time: 47cc1929 +47CC1929.0000 ITM Home: C:\IBM\ITM ITM Process: balayne_01 +47CC1929.0000 Executable Name: C:\IBM\ITM\TMAITM6\k01agent.exe +47CC1929.0000 KBB_RAS1: ERROR +47CC1929.0000 KBB_RAS1_LOG: C:\IBM\ITM\TMAITM6\logs\BALAYNE_01_k01agent_47cc1929-.log
INVENTORY=C:\IBM\ITM\TMAITM6\logs\BALAYNE_01_k01agent.inv COUNT=03 LIMIT=5 PRESERVE=1 MAXFILES=9 +47CC1929.0000 KBB_ENVPATH: C:\IBM\ITM\TMAITM6\KQRENV +47CC1929.0000 ==================================================== (47CC1929.0000-2390:RAS1,400,"CTBLD") +47CC1929.0000 Component: kbb +47CC1929.0000 Driver: d7310a/3784490.1 +47CC1929.0000 Timestamp: Nov 6 2007 17:51:39 +47CC1929.0000 Target: wv7i386 (47CC1929.0001-2390:RAS1,400,"CTBLD") +47CC1929.0001 Component: kdy +47CC1929.0001 Driver: d7310a/3784490.23 +47CC1929.0001 Timestamp: Nov 6 2007 18:36:38 +47CC1929.0001 Target: wv7i386 (47CC1929.0002-2390:RAS1,400,"CTBLD") +47CC1929.0002 Component: kns +47CC1929.0002 Driver: d7310a/3784490.9 +47CC1929.0002 Timestamp: Nov 6 2007 18:20:58 +47CC1929.0002 Target: wv7i386 (47CC1929.0003-2390:RAS1,400,"CTBLD") +47CC1929.0003 Component: ira +47CC1929.0003 Driver: dev/3751458.660 +47CC1929.0003 Timestamp: Mar 3 2008 10:22:31 +47CC1929.0003 Target: wv7i386 (47CC1929.0004-2390:kbbssge.c,52,"BSS1_GetEnv") CANDLE_HOME="C:\IBM\ITM" (47CC1929.0005-2390:kbbssge.c,52,"BSS1_GetEnv") CDP_DP_ACTION_TIMEOUT="20" (47CC1929.0006-2390:kbbssge.c,52,"BSS1_GetEnv") CDP_DP_CACHE_TTL="30" (47CC1929.0007-2390:kbbssge.c,52,"BSS1_GetEnv") CDP_PURE_EVENT_CACHE_SIZE="100" (47CC1929.000A-2390:kbbssge.c,52,"BSS1_GetEnv") AGENT_REF_FILE="C:\IBM\ITM\TMAITM6\KQR.ref" (47CC1929.000B-2390:query.cpp,698,"CtPreInit") AGENT_REF_FILE = C:\IBM\ITM\TMAITM6\KQR.ref (47CC1929.000C-2390:query.cpp,241,"ApplicationXMLConfigParser::startElement") Returning
service name = KQRCMA (47CC1929.000D-2390:kbbssge.c,52,"BSS1_GetEnv") CANDLE_HOME="C:\IBM\ITM" (47CC1929.000E-2390:kbbssge.c,52,"BSS1_GetEnv") AGENT_REF_FILE="C:\IBM\ITM\TMAITM6\K01.ref"

This example shows that the data source started up correctly. You can see the values for variables that can be used to configure the data source (CDP_PUSH_INTERVAL_SECS and CDP_NT_EVENT_LOG_GET_ALL_ENTRIES_FIRST_TIME).
On Windows, you can use the following alternative method to view trace logs:

In the Windows Start menu, choose Program Files > IBM Tivoli Monitoring > Manage Tivoli Enterprise Monitoring Services. The Managing Tivoli Enterprise Monitoring Services window is displayed.

Right-click a component and select Advanced > View Trace Log in the menu. For example, if you want to view the trace log of an agent, right-click the name of the agent in the window. You can also use the viewer to access remote logs.
The viewer converts time stamps in the logs to a format that is easier to read.

For information about the ras1log tool, see the IBM Tivoli Monitoring Troubleshooting Guide.

Set RAS trace parameters
Pinpoint a problem by setting detailed tracing of individual components of the monitoring agent and modules.

Parent topic:
Troubleshooting

+
Search Tips | Advanced Search

System where log is located	File name and path	Description
On the Tivoli Enterprise Monitoring Server	On Windows: The file IBM Tivoli Monitoring timestamp.log in the install_dir\InstallITM path. On UNIX: The candle_installation.log file in the install_dir/logs path.	Provides details about products that are installed. Trace logging is enabled by default. A configuration step is not required to enable this tracing.
The Warehouse_Configuration.log file is in the following path on Windows: install_dir\InstallITM. On UNIX, the file is in the following path: install_dir/Install	Provides details about the configuration of data warehousing for historical reporting.
Name of the RAS log file is as follows: On Windows: install_dir\logs\hostname_ms_HEXtimestamp-nn.log On UNIX: install_dir/logs/hostname_ms_timestamp.log File names for RAS1 logs include a hexadecimal time stamp. Also on UNIX, a log with a decimal time stamp is provided: hostname_productcode_timestamp.log and hostname_productcode_timestamp.pidnnnnn in the install_dir/logs path, where nnnnn is the process ID number.	Traces activity on the monitoring server.
On the Tivoli Enterprise Monitoring Server	Name of the RAS log file is as follows: On Windows: install_dir\logs\hostname_cq_timestamp-nn.log On UNIX: install_dir/logs/hostname_cq_timestamp-nn.log File names for RAS1 logs include a hexadecimal time stamp. Also on UNIX, a log with a decimal time stamp is provided: hostname_productcode_timestamp.log and hostname_productcode_ timestamp.pidnnnnn in the install_dir/logs path, where nnnnn is the process ID number.	Traces activity on the portal server.
The teps_odbc.log file is in the following path on Windows:install_dir\InstallITM path. On UNIX, the file is in the following path: install_dir/logs	When you enable historical reporting, this log file traces the status of the warehouse proxy agent.
On the computer that hosts the monitoring agent	The RAS1 log files are named hostname_productcode_[instance]_k[productcode] agent_timestamp-nn.log The files are in the install_dir\tmaitm6\logs path. File names for RAS1 logs include a hexadecimal time stamp. Multi-instance agents include the instance ID in the log file name.	Traces activity of the monitoring agent.
On the computer that hosts the monitoring agent that includes JDBC or JMX data sources	The JMX, JDBC, or Java log file is named as follows, depending on whether the agent uses JMX, JDBC, or both JMX and JDBC (Java): For a single instance agent KXX_JMX\|JDBC\|JAVA_trace.log For a multiple instance agent KXX_JMX\|JDBC\|JAVA_instanceName_trace.log	Traces activity of the data provider Java process for JMX, JDBC, or both.
The RAS1 log files are named hostname_productcode_[instance_]_k[productcode]agent_timestamp-nn.log and are in the install_dir\tmaitm6\logs path. File names for RAS1 logs include a hexadecimal time stamp. Multi-instance agents include the instance ID in the log file name. Definitions of variables: timestamp is time stamp whose format includes year (y), month (m), day (d), hour (h), and minute (m), as follows: yyyymmdd hhmm HEXtimestamp is a hexadecimal representation of the time at which the process was started. install_dir represents the directory path where you installed the IBM Tivoli Monitoring component. install_dir can represent a path on the computer that host the monitoring system, the monitoring agent, or the portal. instance refers to the name of the database instance that you are monitoring. hostname refers to the name of the computer on which the IBM Tivoli Monitoring component runs. nn represents the circular sequence in which logs are rotated. The range is 1-5, by default, though the first is always retained because it includes configuration parameters.