The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Cisco Unified Serviceability provides trace tools to assist you in troubleshooting issues with your voice application. Cisco Unified Serviceability supports SDI (System Diagnostic Interface) trace, SDL (Signaling Distribution Layer) trace (for Cisco CallManager and Cisco CTIManager services, applicable to Cisco Unified Communications Manager only), and Log4J trace (for Java applications).
You use the Trace Configuration window to specify the level of information that you want traced as well the type of information that you want to be included in each trace file.
Cisco Unified Communications Manager only: If the service is a call-processing application such as Cisco CallManager or Cisco CTIManager, you can configure a trace on devices such as phones and gateway.
Cisco Unified Communications Manager only: In the Alarm Configuration window, you can direct alarms to various locations, including SDL trace log files. If you want to do so, you can configure trace for alerts in the Cisco Unified Real-Time Monitoring Tool (Unified RTMT).
After you have configured information that you want to include in the trace files for the various services, you can collect and view trace files by using the Trace and Log Central option in the Cisco Unified Real-Time Monitoring Tool.
Cisco Unified IM and Presence Serviceability provides trace tools to assist you in troubleshooting issues with your instant messaging and presence application. Cisco Unified IM and Presence Serviceability supports:
You can configure the level of information that you want traced (debug level), what information you want to trace (trace fields), and information about the trace files (such as number of files per service, size of file, and time that the data is stored in the trace files). You can configure trace for a single service or apply the trace settings for that service to all servers in the cluster.
In the Alarm Configuration window, you can direct alarms to various locations. If you want to do so, you can configure trace for alerts in the IM and Presence Unified RTMT.
After you have configured information that you want to include in the trace files for the various services, you can collect and view trace files by using the Trace and Log Central option in the Unified RTMT. You can configure trace parameters for any feature or network service that is available on any IM and Presence node in the cluster. Use the Trace Configuration window to specify the parameters that you want to trace for troubleshooting problems. If you want to use predetermined troubleshooting trace settings rather than choosing your own trace fields, you can use the Troubleshooting Trace Setting window.
Note |
Enabling Trace decreases system performance; therefore, enable Trace only for troubleshooting purposes. For assistance in using Trace, contact Cisco Technical Assistance Center (TAC). |
You can configure trace parameters for any feature or network service that displays in the Serviceability interface. If you have clusters, you can configure trace parameters for any feature or network service that is available on any server in the cluster. Use the Trace Configuration window to specify the parameters that you want to trace for troubleshooting problems.
You can configure the level of information that you want traced (debug level), what information you want to trace (trace fields), and information about the trace files (such as number of files per service, size of file, and time that the data is stored in the trace files). If you have clusters, you can configure trace for a single service or apply the trace settings for that service to all servers in the cluster.
If you want to use predetermined troubleshooting trace settings rather than choosing your own trace fields, you can use the Troubleshooting Trace window. For more information on troubleshooting trace, see Trace settings.
After you have configured information that you want to include in the trace files for the various services, you can collect trace files by using the trace and log central option in Unified RTMT. For more information regarding trace collection, see Trace collection.
The Troubleshooting Trace Settings window allows you to choose the services for which you want to set predetermined troubleshooting trace settings. In this window, you can choose a single service or multiple services and change the trace settings for those services to the predetermined trace settings. If you have clusters, you can choose the services on different servers in the cluster, so the trace settings of the chosen services get changed to the predetermined trace settings. You can choose specific activated services for a single server, all activated services for the server, specific activated services for all servers in the cluster, or all activated services for all servers in the cluster. In the window, N/A displays next to inactive services.
Note |
The predetermined troubleshooting trace settings for a feature or network service include SDL, SDI, and Log4j trace settings. Before the troubleshooting trace settings are applied, the system backs up the original trace settings. When you reset the troubleshooting trace settings, the original trace settings are restored. |
When you open the Troubleshooting Trace Settings window after you apply troubleshooting trace settings to a service, the service that you set for troubleshooting displays as checked. In the Troubleshooting Trace Settings window, you can reset the trace settings to the original settings.
After you apply Troubleshooting Trace Setting to a service, the Trace Configuration window displays a message that troubleshooting trace is set for that service. From the Related Links drop-down list box, you can choose the Troubleshooting Trace Settings option if you want to reset the settings for the service. For the given service, the Trace Configuration window displays all the settings as read-only, except for some parameters of trace output settings, for example, Maximum No. of Files. You can modify these parameters even after you apply troubleshooting trace settings.
Use Trace and Log Central, an option in the Cisco Unified Real-Time Monitoring Tool, to collect, view, and zip various service traces or other log files. With the Trace and Log Central option, you can collect SDL/SDI traces, Application Logs, System Logs (such as Event View Application, Security, and System logs), and crash dump files.
Tip |
Do not use Windows NotePad to view collected trace files to view collected trace files, because Windows NotePad does not properly display line breaks. |
Note |
Cisco Unified Communications Manager only: For devices that support encryption, the Secure Real-time Transport Protocol (SRTP) keying material does not display in the trace file. |
For more information about trace collection, see Cisco Unified Real-Time Monitoring Tool Administration Guide.
Called Party Tracing allows you to configure a directory number or list of directory numbers that you want to trace. You can request on-demand tracing of calls using the Session Trace Tool.
For more information, see the Cisco Unified Real-Time Monitoring Tool Administration Guide.
The following procedure provides an overview of the steps to configure and collect trace for feature and network services in the Serviceability interface.
This section provides information for configuring trace settings.
Note |
Enabling trace decreases system performance; therefore, enable trace only for troubleshooting purposes. For assistance in using trace, contact your technical support team. |
This section describes how to configure trace parameters for feature and network services that you manage through the Serviceability GUI.
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. For information on how to run trace in Cisco Unity Connection Serviceability, refer to the Cisco Unity Connection Serviceability Administration Guide . |
Step 1 |
Select . The Trace Configuration window displays. |
||
Step 2 | From the Server drop-down list box, select 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, select the service group for the service that you want to configure trace; then, click Go.
|
||
Step 4 |
From the Service drop-down list box, select the service for which you want to configure trace and, 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 11. To reset Troubleshooting Trace, see the Set up troubleshooting trace settings. 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 Communications Manager and IM and Presence 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 | Cisco Unity Connection only: If you are configuring SDL trace parameters, go to Step 10. | ||
Step 8 | Select the level of information that you want traced from the Debug Trace Level list box, as described in Debug trace level settings. | ||
Step 9 | Check the Trace Fields check box for the service that you chose, for example, Cisco Log Partition Monitoring Tool Trace Fields. | ||
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 | To limit the number and size of the trace files, specify the trace output setting. See Trace Ouput Settings for descriptions. | ||
Step 12 |
To save your trace parameters configuration, click the Save button. The changes to trace configuration take effect immediately for all services except Cisco Messaging Interface (Cisco Unified Communications Manager only). The trace configuration changes for Cisco Messaging Interface take effect in 3 to 5 minutes.
|
Cisco Unified Communications Manager |
|
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 lists the services for which you can run trace for specific components. |
||
Cisco Unified Communications Manager |
For these services, you can run trace for specific components, instead of enabling all trace for the service; see the Trace field descriptions. |
|||
Cisco Unified Communications Manager |
You enable all trace for each service, instead of running trace for specific components. In Cisco Unified Communications Manager CDR Analysis and Reporting, when reports are run that call stored procedures, Unified Communications Manager CDR Analysis and Reporting checks the configured debug trace level for the Unified Communications Manager CDR Analysis and Reporting Scheduler service and the Unified Communications Manager CDR Analysis and Reporting Web Service in the Trace Configuration window before stored procedure logging begins. For pregenerated reports, Unified Communications Manager CDR Analysis and Reporting checks the level for the Unified Communications Manager CDR Analysis and Reporting Scheduler service; for on-demand reports, Unified Communications Manager CDR Analysis and Reporting checks the level for the Cisco Unified Communications Manager CDR Analysis and Reporting Web Service. If you choose Debug from the Debug Trace Level drop-down list box, stored procedure logging gets enabled and continues until you choose another option from the drop-down list box. The following Unified Communications Manager CDR Analysis and Reporting reports use stored procedure logging: Gateway Utilization report, Route and Line Group Utilization report, Route/Hunt List Utilization report, Route Pattern/Hunt Pilot Utilization report, Conference Call Details report, Conference Call Summary report, Conference Bridge Utilization report, Voice Messaging Utilization report, and the CDR Search report. |
|||
IM and Presence Services |
|
See topics related to feature and network services in Cisco Unified IM and Presence Serviceability for a description of these services. |
||
Cisco Unified Communications Manager and Cisco Unity Connection:
Cisco Unified Communications Manager
IM and Presence Services: |
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 Extended Functions trace fields. Choosing the Cisco Role-based Security option, which supports Cisco Unified Communications Manager, activates trace for user-role authorization. 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.
|
|||
Cisco Unified Communications Manager and Cisco Unity Connection:
Cisco Unified Communications Manager: IM and Presence Services: |
Choosing the Cisco CCM NCS Web Library option activates trace for database change notification for the Java client. Choosing the Cisco Unity RTMT Web Service option activates trace for the Unity RTMT servlets; running this trace creates the server-side log for Unity RTMT client queries. |
|||
Cisco Unified Communications Manager |
You enable all trace for each service, instead of running trace for specific components. |
|||
Cisco Unified Communications Manager |
Cisco DirSync |
You enable all trace for this service, instead of running trace for specific components. |
||
You enable all trace for each service, instead of running trace for specific components. |
||||
Cisco Unified Communications Manager:
IM and Presence Services: |
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. |
|||
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. |
||||
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. |
The following table describes the debug trace level settings for services.
Traces alarm conditions and events. Used for all traces that are generated in abnormal path. Uses minimum number of CPU cycles. |
|||
Traces all Error conditions plus process and device initialization messages. |
|||
Traces all Special conditions plus subsystem state transitions that occur during normal operation. Traces call-processing events. |
|||
Traces all State Transition conditions plus media layer events that occur during normal operation. |
|||
Traces all Significant conditions plus entry and exit points of routines. |
|||
Traces all Entry/Exit conditions plus low-level debugging information. |
|||
Traces all Arbitrary conditions plus detailed debugging information. |
The following table describes the debug trace level settings for servlets.
Traces very severe error events that may cause the application to abort. |
|
Traces alarm conditions and events. Used for all traces that are generated in abnormal path. |
|
Traces the majority of servlet problems and has a minimal effect on system performance. |
|
Traces all State Transition conditions plus media layer events that occur during normal operation. |
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 and Cisco Unity Connection:
The following services are applicable to Cisco Unified Communications Manager:
The following table describes the Cisco Database Layer Monitor trace fields. The Cisco Database Layer Monitor service supports Cisco Unified Communications Manager and Cisco Unity Connection.
Activates the database change notification traces for C++ applications. |
|
Do not check this check box. Cisco engineering uses it for debugging purposes. |
The following table describes the Cisco RIS Data Collector trace fields. The Cisco RIS Data Collector service supports Cisco Unified Communications Manager and Cisco Unity Connection.
Activates trace for the RISDC thread of the RIS data collector service (RIS). |
|
Activates trace for the system access library in the RIS data collector. |
|
Activates trace for the link services library in the RIS data collector. |
|
Activates trace for the RISDC access library in the RIS data collector. |
|
Activates trace for the RISDB library in the RIS data collector. |
|
Activates trace for the PI library in the RIS data collector. |
|
Activates trace for the input/output XML messages of the RIS data collector service. |
|
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. |
The following table describes the Cisco CallManager SDI trace fields. The Cisco CallManager service supports Cisco Unified Communications Manager.
Activates the logging of ISDN type of DT-24+/DE-30+ device traces. |
|||
Activates trace of H.225 devices. Used for normal debugging. |
|||
Activates trace of miscellaneous devices.
|
|||
Activates trace of conference bridges. Used for normal debugging. |
|||
Activates trace of music on hold (MOH) devices. Used to trace MOH device status such as registered with Cisco Unified Communications Manager, unregistered with Cisco Unified Communications Manager, and resource allocation processed successfully or failed. |
|||
Activates Cisco Unified Communications Manager real-time information traces that the real-time information server uses. |
|||
Activates trace for the annunciator, a SCCP device that uses the Cisco IP Voice Media Streaming Application service to enable Cisco Unified Communications Manager to play prerecorded announcements (.wav files) and tones to Cisco Unified IP Phones, gateways, and other configurable devices. |
|||
Activates trace of phone devices. Trace information includes SoftPhone devices. Used for normal debugging. |
|||
Activates trace of media termination point (MTP) devices. Used for normal debugging. |
|||
Activates trace for call forwarding and all subsystems that are not covered by another check box. Used for normal debugging. |
|||
Activates trace for media gateway control protocol (MGCP) devices. Used for normal debugging. |
|||
Activates trace for media resource manager (MRM) activities. |
|||
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. |
|||
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. |
The following table describes the Cisco CallManager SDL trace filter settings. The Cisco CallManager service supports Cisco Unified Communications Manager.
Note |
Cisco recommends that you use the defaults unless a Cisco engineer instructs you to do otherwise. |
Activates Layer 2 Transmission Control Program (TCP) traces. |
|
Activates traces for user-to-user informational element (UUIE) output. |
|
The following table describes the Cisco CallManager SDL configuration characteristics.
Activates trace for intracluster communication protocol (ICCP) link state. |
|
Disables trace for pretty print of SDL. Pretty print adds tabs and spaces in a trace file without performing post processing. |
|
The following table describes the Cisco CTIManager SDL configuration trace filter settings. The Cisco CTIManager service supports Cisco Unified Communications Manager.
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 Cisco CTIManager SDL Configuration Trace Filter Settings table and Cisco CTIManager SDL Configuration Trace Characteristics table display. |
The following table describes the Cisco CTIManager SDL configuration trace characteristics.
Disables trace for pretty print of SDL. Pretty print adds tabs and spaces in a trace file without performing post processing. |
|
The following table describes the Cisco Extended Functions trace fields. The Cisco Extended Functions service supports Cisco Unified Communications Manager.
Activates quality report tool real-time information server trace. |
The following table describes the Cisco Extension Mobility trace fields. The Cisco Extension Mobility service supports Cisco Unified Communications Manager.
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. |
The following table describes the Cisco IP Manager Assistant trace fields. The Cisco IP Manager Assistant service supports Cisco Unified Communications Manager Assistant.
Activates trace for the changes that you make to the manager and assistant configurations. |
|
The information in this section does not apply to Cisco Unity Connection.
The following table describes the Cisco IP Voice Media Streaming App trace fields. The Cisco IP Voice Media Streaming App service supports Cisco Unified Communications Manager.
Activates traces to monitor the processed messages for media termination point (MTP). |
|
Activates traces for device-recovery-related information for MTP, conference bridge, and MOH. |
|
Activates trace for high-level, detailed WinSock-related information. |
|
Activates trace to monitor database setup and changes for MTP, conference bridge, and MOH. |
|
Activates traces to monitor the processed messages for conference bridge. |
|
Activates trace for low-level, general, WinSock-related information. |
|
Activates trace to monitor the download of MOH audio source files. |
The following table describes the Cisco TFTP trace fields. The Cisco TFTP service supports Cisco Unified Communications Manager.
The following table describes the Cisco Web Dialer Web Service trace fields. The Cisco Web Dialer Web Service supports Cisco Unified Communications Manager.
Parameter | Description |
---|---|
Enable Access Log Trace |
This parameter enables the proxy access log trace; the first line of each SIP message received by the proxy is logged. |
This parameter enables tracing for the Authentication module. |
|
This parameter enables tracing for the Method/Event routing module. |
|
This parameter enables tracing for the Number Expansion module. |
|
This parameter enables tracing of parser information related to the operation of the per-sipd child SIP parser. |
|
This parameter enables tracing for information about processing of PAI, RPID, and Diversion headers in relation to privacy requests. |
|
This parameter enables tracing for the SIP UA application module. |
|
This parameter enables tracing for information related to the operation of the per-sipd SIP state machine. |
|
This parameter enables tracing for information related to the TCP transport of SIP messages by TCP services. |
|
This parameter enables tracing for information related to the TLS transport of SIP messages by TCP services. |
|
This parameter enables tracing for the Presence Web Service. |
The following tables provide field descriptions for the services that support trace activation of specific components. For some services, you can activate trace for specific component instead of enabling all trace for the service. If a service is not included in this chapter, Enable All Trace displays for the service in the Trace Configuration window.
The following table describes the Cisco Access Log trace fields.
The following table describes the Cisco Authentication trace fields.
The following table describes the Cisco Calendar trace fields.
The following table describes the Cisco CTI Gateway trace fields.
The following table describes the Cisco Database Layer Monitor trace fields.
Activates the database change notification traces for C++ applications. |
|
Do not check. Cisco engineering uses it for debugging purposes. |
The following table describes the Cisco Enum trace fields.
The following table describes the Cisco Method/Event trace fields.
The following table describes the Cisco Number Expansion trace fields.
The following table describes the Cisco Parser trace fields.
The following table describes the Cisco Privacy trace fields.
The following table describes the Cisco proxy trace fields.
The following table describes the Cisco RIS Data Collector trace fields.
Activates trace for the RISDC thread of the RIS data collector service (RIS). |
|
Activates trace for the system access library in the RIS data collector. |
|
Activates trace for the link services library in the RIS data collector. |
|
Activates trace for the RISDC access library in the RIS data collector. |
|
Activates trace for the RISDB library in the RIS data collector. |
|
Activates trace for the PI library in the RIS data collector. |
|
Activates trace for the input/output XML messages of the RIS data collector service. |
|
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. |
The following table describes the Cisco Registry trace fields.
The following table describes the Cisco Routing trace fields.
The following table describes the Cisco Server trace fields.
The following table describes the Cisco SIP Message and State Machine trace fields.
The following table describes the Cisco SIP TCP trace fields.
The following table describes the Cisco SIP TLS trace fields.
The following table describes the Cisco Web Service trace fields.
The following table contains the trace log file descriptions.
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 Unity RTMT. |
This field specifies the total number of trace files for a given service. Cisco Unified Serviceability automatically appends a sequence number to the filename 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. |
|
This field specifies the maximum size of the trace file in megabytes. The default varies by service. |
The Troubleshooting Trace Settings window allows you to select the services in the Serviceability GUI for which you want to set predetermined troubleshooting trace settings. In this window, you can select the services on different nodes in the cluster. This populates the trace settings changes for all the services you choose. You can select specific active services for a single node, all active services for the node, specific active services for all nodes in the cluster, or all active services for all nodes in the cluster. In the window, N/A displays next to inactive services.
Note |
For IM and Presence the predetermined troubleshooting trace settings for an IM and Presence feature or network service include SDI and Log4j trace settings. Before the troubleshooting trace settings are applied, the system backs up the original trace settings. When you reset the troubleshooting trace settings, the original trace settings are restored. |
When you open the Troubleshooting Trace Settings window after you apply troubleshooting trace settings to a service, the service that you set for troubleshooting displays as checked. In the Troubleshooting Trace Settings window, you can reset the trace settings to the original settings.
After you apply Troubleshooting Trace Setting to a service, the Trace Configuration window displays a message that troubleshooting trace is set for that service. From the Related Links list box, you can select the Troubleshooting Trace Settings option if you want to reset the settings for the service. For the given service, the Trace Configuration window displays all the settings as read-only, except for some parameters of trace output settings, for example, Maximum No. of Files.
Review the tasks Set up trace configuration and Set up trace parameters.
Step 1 | Select . |
Step 2 | Select the server where you want to troubleshoot trace settings from the Server list box. |
Step 3 |
Select Go. A list of services display. The services that are not active display as N/A. |
Step 4 |
Perform one of the following actions:
|
Step 5 | Select Save. |
Step 6 |
Select one of the following buttons to restore the original trace settings:
|