Table Of Contents

Configuring Trace

Configuring Trace Parameters

Service Groups in Trace Configuration

Debug Trace Level Settings

Trace Field Descriptions

Cisco Database Layer Monitor Trace Fields

Cisco RIS Data Collector Trace Fields

Trace Output Settings Descriptions and Defaults

Related Topics

Configuring Trace

---

---

Note Enabling trace decreases system performance; therefore, enable trace only for troubleshooting purposes. For assistance in using trace, contact your technical support team.

---

This chapter contains the following topics:

•Configuring Trace Parameters

•Service Groups in Trace Configuration

•Debug Trace Level Settings

•Trace Field Descriptions

•Trace Output Settings Descriptions and Defaults

•Related Topics

Configuring Trace Parameters

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

---

Tip 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 Serviceability Administration Guide for Cisco Unity Connection.

---

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.

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 9. 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.

---

Tip The Apply to All Nodes check box does not apply to Cisco Unity Connection.

---

Step 5 Check the Trace On check box.

Step 6 From the Debug Trace Level drop-down list box, choose the level of information that you want traced, as described in "Debug Trace Level Settings" section.

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

Step 8 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 the trace check boxes that you want to enable, as described in the following sections:

•Cisco Database Layer Monitor Trace Fields

•Cisco RIS Data Collector Trace Fields

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

Step 10 To save your trace parameters configuration, click the Save button.

The changes to trace configuration take effect immediately for all services.

---

Note To set the default, click the Set Default button.

---

---

Additional Information

See the "Related Topics" section.

Service Groups in Trace Configuration

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

Table 7-1 Service Groups in Trace Configuration 

Service Group	Services and Trace Libraries	Notes
Database and Admin Services	Cisco AXL Web Service, Cisco CCM DBL Web Library, Cisco CCMAdmin Web Service, Cisco Database Layer Monitor	For a description of these services (not the Cisco CCM DBL Web Library), see the "Understanding Services" section on page 9-1. Choosing the Cisco CCM DBL Web Library option activates the trace for database access for Java applications. For database access for C++ applications, activate trace for Cisco Database Layer Monitor, as described in the "Cisco Database Layer Monitor Trace Fields" section.   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.
Performance and Monitoring Services	Cisco AMC Service, Cisco CCM NCS Web Library, Cisco Log Partition Monitoring Tool, Cisco RIS Data Collector, and Cisco RTMT Web Service	For a description of these services (not the Cisco CCM NCS Web Library or the Cisco RTMT Web Service), see the "Understanding Services" section on page 9-1. Choosing the Cisco CCM NCS Web Library option activates trace for database change notification for the Java client. Choosing the Cisco RTMT Web Service option activates trace for the RTMT servlets; running this trace creates the server-side log for RTMT client queries.
Backup and Restore Services	Cisco DRF Local and Cisco DRF Master	For a description of these services, see the "Understanding Services" section on page 9-1. You enable all trace for each service, instead of running trace for specific components.
System Services	Cisco CCMRealm Web Service, Cisco CCMService Web Service, Cisco Common User Interface, and Cisco Trace Collection Service	For a description of the Cisco Trace Collection service, see the "Understanding Services" section on page 9-1. Choosing the Cisco CCMRealm Web Service option activates trace for login authentication. 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. Choosing the Cisco CCMService Web Service option activates trace for the Cisco Unified Serviceability web application (GUI). You enable all trace for each option/service, instead of running trace for specific components.
SOAP Services	Cisco SOAP Web 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.

Debug Trace Level Settings

Table 7-2 describes the debug trace level settings for services.

Table 7-2 Debug Trace Levels for Services 

Level	Description
Error	Traces alarm conditions and events. Used for all traces that are generated in abnormal path. Uses minimum number of CPU cycles.
Special	Traces all Error conditions plus process and device initialization messages.
State Transition	Traces all Special conditions plus subsystem state transitions that occur during normal operation. Traces call-processing events.
Significant	Traces all State Transition conditions plus media layer events that occur during normal operation.
Entry/Exit	Note Not all services use this trace level. Traces all Significant conditions plus entry and exit points of routines.
Arbitrary	Traces all Entry/Exit conditions plus low-level debugging information.
Detailed	Traces all Arbitrary conditions plus detailed debugging information.

Table 7-3 describes the debug trace level settings for servlets.

Table 7-3 Debug Trace Levels for Servlets 

Level	Description
Fatal	Traces very severe error events that may cause the application to abort.
Error	Traces alarm conditions and events. Used for all traces that are generated in abnormal path.
Warn	Traces potentially harmful situations.
Info	Traces the majority of servlet problems and has a minimal effect on system performance.
Debug	Traces all State Transition conditions plus media layer events that occur during normal operation. Trace level that turns on all logging.

Additional Information

See the "Related Topics" section.

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.

•Cisco Database Layer Monitor Trace Fields

•Cisco RIS Data Collector Trace Fields

Cisco Database Layer Monitor Trace Fields

Table 7-4 describes the Cisco Database Layer Monitor trace fields.

Table 7-4 Cisco Database Layer Monitor Trace Fields 

Field Name	Description
Enable DB Library Trace	Activates database library trace for C++ applications.
Enable Service Trace	Activates service trace.
Enable DB Change Notification Trace	Activates the database change notification traces for C++ applications.
Enable Unit Test Trace	Do not check this check box. Cisco engineering uses it for debugging purposes.

Additional Information

See the "Related Topics" section.

Cisco RIS Data Collector Trace Fields

Table 7-5 describes the Cisco RIS Data Collector trace fields.

Table 7-5 Cisco RIS Data Collector Trace Fields 

Field Name	Description
Enable RISDC Trace	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.

Additional Information

See the "Related Topics" section.

Trace Output Settings Descriptions and Defaults

Table 7-6 contains the trace log file 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-6 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.

Additional Information

See the "Related Topics" section.

Related Topics

•Configuring Trace Parameters

•Service Groups in Trace Configuration

•Debug Trace Level Settings

•Trace Field Descriptions

•Trace Output Settings Descriptions and Defaults