Tracing servers and agents

You can set trace levels for IBM Spectrum® Control server and agent components. The tracing tool uses the IBM® Logging Toolkit for C (CCLOG) for tracing server and agent data.

Setting server trace levels in the GUI

If you have Administrator permissions, you can turn on or off the trace recording for the individual services on each component server. By enabling or disabling the trace recording before you create logs, you can provide IBM Support with more information on specific component servers that might be causing the problem.

To enable or disable the trace recording for a component servers, complete the following steps:

In the menu bar, go to Home > System Management.
Click Component Servers in the Components section. In the Component Servers pane, you can view performance information for each component server. The current trace recording for each component server is highlighted.
Click On or Off to enable or disable tracing for each of the services of a component server.

Tracing a Storage Resource agent

To trace a Storage Resource agent, follow these steps:

In the menu bar, go to Servers > Servers.
In the Servers pane, right-click a server and click View Properties.
Click the Agent tab and click Edit.
Specify the following values:

Agent Trace

Click Enabled.

Trace Level

The trace level can be one of the following values:

Minimum

The minimum debugging level. This option is the default and is always turned on. This option includes trace information for key locations in the code that includes first failure data capture. This setting does not capture any output data.

Medium

The medium debugging level. This setting does not capture any output data.

Maximum

The maximum debugging level. This option includes entry and exit information for every method in addition to all DEBUG_MIN statements. This option can impact performance.

Number of Trace Files

The maximum number of files that are used before the Data server starts reusing the tracing files. The default is eight files.

Trace File Size (MiB)

The maximum file size for the tracing files. The default is one MiB.
Click Save and then click Close.

Trace log file locations

The Java™ tracing information is stored in the locations that are shown in Table 1 and Table 2.

Table 1. Java trace log files
Class	Java trace log file
Storage Resource agent	`installation_directory`/agent/log `installation_directory`/agent/log/ `name_of_server_SRA_communicates_with`
Server	`installation_directory`/data/log/ServerTrace.log

The Native tracing information is stored in the locations that are shown in Table 2.

Table 2. Native trace log files
Class	Native trace log file
Server	`installation_directory`/data/log/traceTPCDNativeServer_ `yyyymmddhhmmssLOGx`.log
UnixStopServer	`installation_directory`/data/log/traceTPCDNativeStopServer_ `yyyymmddhhmmssLOGx`.log
ImportExport	`installation_directory`/data/log/traceTPCDNativeImportExport_ `yyyymmddhhmmssLOGx`.log

Messages are logged before the creation of a user-defined installation directory. Because the log directory is not initially available, installation messages are written to standard error log files. The standard error log is redirected to a temporary file. The temporary message log file is copied to the appropriate log directory, and the standard error log file is redirected to reflect the new message log file location

When an executable file is run, it creates the tracing files that are shown in Table 3.

Table 3. Trace files for executable routines
Executable file	Platform	Trace log file location, file name, and description
udbexec.exe	Windows™ operating systems	\`hostname`\traceTSRMNativeUdbexec_PID.log `installation_directory`\data\ca\ traceTSRMNativeUdbexec_`PID`_`yyyymmddhhmmss`.log
ExecSvc.exe	Windows operating systems	`temp`\traceTSRMNativeExecSvc.log This executable routine runs only on the remote computer during a Windows push installation.
udbexec.exe¹ or `udbexec` ²	All operating systems	`installation_directory`/data/ca/ traceTSRMNativeudbexec_`pid`_`yyyymmddhhmmss`.log
DbMonitor.exe¹ or DbMonitor²	All operating systems	This executable routine is run on Windows operating systems for all database monitoring activities. This executable routine generates trace files that are named based on the name of the active job. For example, the default database scan generates a trace file similar to the following file: TPCUser.Default Db Scan.0001_dbmonitor.00009163.trace

Notes:

¹ Use in Windows operating systems.
² Use in Linux® or AIX® operating systems.

Configuration files for tracing

There are two configuration files added for Java tracing: ServerTraceLog.config and AgentTraceLog.config. The nativelog.config file is used for native code tracing.

Table 4. Trace configuration files
File	Directory
Native code trace configuration file	`installation_directory`/data/config/nativelog.config
Java tracing configuration file	`installation_directory`/data/config/ServerTraceLog.config

nativelog.config file

During the installation or a maintenance upgrade of IBM Spectrum Control, a file that is named nativelog.config is created in the installation_directory/data/config directory.

This file is used to specify the default levels of tracing for the IBM Spectrum Control processes (for example, the server and the agent). Depending on which platform IBM Spectrum Control is installed, some of the items that are listed in this file might vary.

In particular, Windows installations do not have the #StopAgent section that Linux and AIX platforms have. The reason for the difference is because the agent service is started differently on these platforms. Settings in these files are separated into sections that represent IBM Spectrum Control processes. The trace settings per process are listed underneath the process they represent.

The definitions for the entries in the nativelog.config file are as follows:

# Agent: A IBM Spectrum Control process. In this case, the agent process is specified.
agt.level=DEBUG_MIN: The default trace level for the agent process.
agt.maxFiles=3: The maximum number of trace files to be created or used.
agt.maxFileSize=20480000: The maximum size of each trace file (in bytes).

The level of trace that is specified in this file is also applied to specific child processes run from their parent process. For example, the processes udbexec.exe and MiniProbe.exe can use the settings from the Agent section as their default trace level because these processes are run by the Agent process.

You can edit the contents of this file if you want to change the default level of tracing for a particular process. However, these changes do not take effect until that process is stopped and restarted again. For example, if you want to change the tracing level of the server from DEBUG_MIN to DEBUG_MID, you can modify the nativelog.config file. Restart the server to effect the change.

By modifying this file, you can ensure that each time the server is stopped and restarted, the specified trace level is applied.

Here is an example of the nativelog.config file for Windows operating systems:

# level: DEBUG_MIN || DEBUG_MID || DEBUG_MAX 
# maxFiles: >= 2 && <= 100 
# maxFileSize: >= 128000 && <= 102400000  

# Agent 
agt.level=DEBUG_MIN 
agt.maxFiles=3 
agt.maxFileSize=20480000 

# Server 
srv.level=DEBUG_MIN 
srv.maxFiles=3 
srv.maxFileSize=20480000 

# ImportExport 
impexp.level=DEBUG_MIN 
impexp.maxFiles=3 
impexp.maxFileSize=20480000

Here is an example of the nativelog.config file for Linux and AIX operating systems:

# level: DEBUG_MIN || DEBUG_MID || DEBUG_MAX 
# maxFiles: >= 2 && <= 100 
# maxFileSize: >= 128000 && <= 102400000  

# Agent 
agt.level=DEBUG_MIN 
agt.maxFiles=3 
agt.maxFileSize=20480000 

# ImportExport 
impexp.level=DEBUG_MIN 
impexp.maxFiles=3 
impexp.maxFileSize=20480000 

# StopAgent 
stpagt.level=DEBUG_MIN 
stpagt.maxFiles=3 
stpagt.maxFileSize=20480000

AgentTraceLog.config file

The definitions for the entries in the AgentTraceLog.config file are as follows:

ITSRM.logger.trace.Agent.logging=true: The state of tracing for the agent. In this case, tracing is enabled.
ITSRM.logger.trace.Agent.level=DEBUG_MAX: The trace level for the agent. DEBUG_MAX is the only level that produces trace information.
ITSRM.handler.file.maxFiles=8: The maximum number of trace files to be created or used.
ITSRM.handler.file.maxFileSize=1024: The maximum size of each trace file (in bytes).

ServerTraceLog.config file

The definitions for the entries in the ServerTraceLog.config file are as follows:

ITSRM.logger.trace.Server.logging=true: The state of tracing for the Server process. In this case, tracing is enabled.
ITSRM.logger.trace.Server.level=DEBUG_MAX: The trace level for the Server process. DEBUG_MAX is the only level that produces trace information.
ITSRM.handler.file.maxFiles=5: The maximum number of trace files to be created or used.
ITSRM.handler.file.maxFileSize=20480: The maximum size of each trace file (in bytes).
ITSRM.logger.trace.TivoliSRM-GUI.logging=false: The state of tracing for the stand-alone GUI process. In this case, tracing is disabled.
ITSRM.logger.trace.TivoliSRM-GUI.level=DEBUG_MAX: The trace level for the stand-alone GUI process.
ITSRM.logger.trace.TivoliSRM-CIMOM.logging=false: The state of tracing for the CIMOM process. In this case tracing, is disabled.
ITSRM.logger.trace.TivoliSRM-CIMOM.level=DEBUG_MAX: The trace level for the CIMOM process.
ITSRM.logger.trace.TivoliSRM-Agent.logging=false: The state of tracing for the Agent process. In this case, tracing is disabled.
ITSRM.logger.trace.TivoliSRM-Agent.level=DEBUG_MAX: The trace level for the Agent process.
ITSRM.logger.trace.Scheduler.logging=false: The state of tracing for the Scheduler process. In this case, tracing is disabled.
ITSRM.logger.trace.Scheduler.level=DEBUG_MAX: The trace level for the Scheduler process.