Configuring Trace Parameters

This section describes how to configure trace parameters for feature and network services that you manage through Cisco Unified Serviceability.

Tip Unified CM BE and Connection only: For Cisco Unity Connection, you may need to run trace in Cisco Unified Serviceability and Cisco Unity Connection Serviceability to troubleshoot Cisco Unity Connection issues. To troubleshoot services that are supported in Cisco Unified Serviceability, you run trace in Cisco Unified Serviceability. Similarly, to troubleshoot Cisco Unity Connection components, you run trace in Cisco Unity Connection Serviceability. For information on how to run trace in Cisco Unity Connection Serviceability, refer to the Cisco Unity Connection Serviceability Administration Guide.

Procedure

Step 1 Choose Trace > Configuration.

The Trace Configuration window displays.

Step 2 From the Server drop-down list box, choose the server that is running the service for which you want to configure trace; then, click Go.

Step 3 From the Service Group drop-down list box, choose the service group for the service that you want to configure trace; then, click Go.

Tip Table 7-1 lists the services and trace libraries that correspond to the options that display in the Service Group drop-down list box.

Step 4 From the Service drop-down list box, choose the service for which you want to configure trace; then, click Go.

The drop-down list box displays active and inactive services.

Tip Unified CM and Unified CM BE only: For the Cisco CallManager and CTIManager services, you can configure SDL trace parameters. To do so, open the Trace Configuration window for one of those services, and click the Go button that is next to the Related Links drop-down list box.

If you configured Troubleshooting Trace for the service, a message displays at the top of the window that indicates that the Troubleshooting Traces feature is set, which means that the system disables all fields in the Trace Configuration window except for Trace Output Settings. To configure the Trace Output Settings, go to Step 12. To reset Troubleshooting Trace, see the "Configuring Troubleshooting Trace Settings" section on page 8-1.

The trace parameters display for the service that you chose. In addition, the Apply to All Nodes check box displays (Cisco Unified Communications Manager only).

Step 5 Unified CM only: If you want to do so, you can apply the trace settings for the service or trace library to all servers in the cluster by checking the Apply to All Nodes check box; that is, if your configuration supports clusters.

Step 6 Check the Trace On check box.

Step 7 Unified CM and Unified CM BE only: If you are configuring SDL trace parameters, go to Step 10.

Step 9 Check the Trace Fields check box for the service that you chose; for example, Cisco Log Partition Monitoring Tool Trace Fields.

Note Unified CM and Unified CM BE only: If you are configuring trace for the Cisco CallManager or the Cisco CTIManager service and you only want trace information for specific Cisco Unified Communications Manager devices, go to Step 11.

Step 10 If the service does not have multiple trace settings where you can specify the traces that you want to activate, check the Enable All Trace check box. If the service that you chose has multiple trace settings, check the check boxes next to the trace check boxes that you want to enable, as described in Trace Field Descriptions.

Step 11 Unified CM and Unified CM BE only: If you are configuring trace for the Cisco CallManager or the Cisco CTIManager service and you want trace information for specific Cisco Unified Communications Manager devices, perform the following tasks:

a. Check the Device Name Based Trace Monitoring check box.

The Device Name Based Trace Monitoring option traces only the selected devices, thus narrowing the number of trace logs that are generated and reducing the impact on call processing.

b. Click the Select Devices button.

The Device Selection for Tracing window displays.

Tip From Cisco Unified Communications Manager Administration, choose System > Enterprise Parameters;configure the maximum number of devices that are available for tracing. Enter a value in the Max Number of Device Level Trace field. For help on configuring the parameter, click the link for the parameter name or the question mark button in the upper, right corner of the window.

c. From the Find drop-down list box, choose the device for which you want a trace.

d. Enter the appropriate search criteria for the device for which you want a trace and click the Find button.

The window with the search results displays. If more pages of search results to view exist, click the First, Previous, Next, or Last button.

e. Click the Trace check box for the device or devices for which you want device-name-based trace monitoring.

f. Click the Save button.

g. When the update finishes, click the browser closebutton to close the Device Selection for Tracing window and return to the Trace Configuration window.

h. If you want trace to apply to non-devices in addition to devices, check the Include Non-device Traces check box. If check box is checked, set the appropriate debug trace level as described in "Debug Trace Level Settings" section.

Step 12 To limit the number and size of the trace files, specify the trace output setting. See Table 7-17 for descriptions and default values.

For most services in the CM Services group, you run trace for specific components, instead of enabling all trace for the service. The "Trace Field Descriptions" section lists the services for which you can run trace for specific components.

For most services in the Database and Admin Services group, you enable all trace for the service/library, instead of enabling trace for specific components. For Cisco Database Layer Monitor, you can run trace for specific components.

Choosing the Cisco Common User Interface option activates trace for the common code that multiple applications use; for example, Cisco Unified Operating System Administration and Cisco Unified Serviceability.

You enable all trace for each option/service, instead of running trace for specific components.

SOAP Services

Cisco SOAP Web Service and Cisco SOAPMessage Service

Choosing the Cisco SOAP Web Service option activates the trace for the AXL Serviceability API.

You enable all trace for this service, instead of running trace for specific components.

Platform Services

Cisco Unified OS Admin Web Service

The Cisco Unified OS Admin Web Service supports Cisco Unified Operating System Administration, which is the web application that provides management of platform-related functionality such as certificate management, version settings, and installations and upgrades.

You enable all trace for this service, instead of running trace for specific components.

Trace Field Descriptions

For some services, you can activate trace for specific components, instead of enabling all trace for the service. The following list includes the services for which you can activate trace for specific components. Clicking one of the cross-references takes you to the applicable section where a description displays for each trace field for the service. If a service does not exist in the following list, the Enable All Trace check box displays for the service in the Trace Configuration window.

The following services are applicable to Cisco Unified Communications Manager, Cisco Unified Communications Manager Business Edition, and Cisco Unity Connection:

Activates trace for the RISDC thread of the RIS data collector service (RIS).

Enable System Access Trace

Activates trace for the system access library in the RIS data collector.

Enable Link Services Trace

Activates trace for the link services library in the RIS data collector.

Enable RISDC Access Trace

Activates trace for the RISDC access library in the RIS data collector.

Enable RISDB Trace

Activates trace for the RISDB library in the RIS data collector.

Enable PI Trace

Activates trace for the PI library in the RIS data collector.

Enable XML Trace

Activates trace for the input/output XML messages of the RIS data collector service.

Enable Perfmon Logger Trace

Activates trace for the troubleshooting perfmon data logging in the RIS data collector. Used to trace the name of the log file, the total number of counters that are logged, the names of the application and system counters and instances, calculation of process and thread CPU percentage, and occurrences of log file rollover and deletion.

Activates trace of media termination point (MTP) devices. Used for normal debugging.

Enable All Gateway Trace

Activates trace of all analog and digital gateways.

Enable Forward and Miscellaneous Trace

Activates trace for call forwarding and all subsystems that are not covered by another check box. Used for normal debugging.

Enable MGCP Trace

Activates trace for media gateway control protocol (MGCP) devices. Used for normal debugging.

Enable Media Resource Manager Trace

Activates trace for media resource manager (MRM) activities.

Enable SIP Call Processing Trace

Activates trace for SIP call processing.

Enable SCCP Keep Alive Trace

Activates trace for SCCP keepalive trace information in the Cisco CallManager traces. Because each SCCP device reports keepalive messages every 30 seconds, and each keepalive message creates 3 lines of trace data, the system generates a large amount of trace data when this check box is checked.

Enable SIP Keep Alive (REGISTER Refresh) Trace

Activates trace for SIP keepalive (REGISTER refresh) trace information in the Cisco CallManager traces. Because each SIP device reports keepalive messages every 2 minutes, and each keepalive message can create multiple lines of trace data, the system generates a large amount of trace data when this check box is checked.

Tip Cisco recommends that you use the defaults unless a Cisco engineer instructs you to do otherwise.

Tip When you choose the CTIManager service from the Service Groups drop-down list box, the Trace Configuration window displays for SDI traces for this service. To activate SDI trace for the Cisco CTI Manager service, check the Enable All Trace check box in the Trace Configuration window for the Cisco CTIManager service. To access the SDL Configuration window, choose SDL Configuration from the Related Links drop-down list box; the settings that are described in Table 7-9 and Table 7-10 display.

Tip When you activate trace for the Cisco Extension Mobility Application service, you check the Enable All Trace check box in the Trace Configuration window for the Cisco Extension Mobility Application service.

Trace Output Settings Descriptions and Defaults

Caution When you change either the Maximum No. of Files or the Maximum File Size settings in the Trace Configuration window, the system deletes all service log files except for the current file, that is, if the service is running; if the service has not been activated, the system deletes the files immediately after you activate the service. Before you change the Maximum No. of Files setting or the Maximum File Size setting, download and save the service log files to another server if you want to keep a record of the log files; to perform this task, use Trace and Log Central in RTMT.

Table 7-17 Trace Output Settings

Field

Description

Maximum number of files

This field specifies the total number of trace files for a given service.

Cisco Unified Serviceability automatically appends a sequence number to the file name to indicate which file it is; for example, cus299.txt. When the last file in the sequence is full, the trace data begins writing over the first file. The default varies by service.

Maximum file size (MB)

This field specifies the maximum size of the trace file in megabytes. The default varies by service.