Trace and Log Central
Note |
For Trace and Log Central to work, you must resolve DNS lookup for all nodes in the cluster on the client machine. |
Preparation
Import Certificates
Follow this procedure to import the node certificates.
You can import the server authentication certificate that the certificate authority provides for the node or for each node in the cluster.
We recommend that you import the certificates before using the trace and log central option. If you do not import the certificates, the Trace and Log Central option displays a security certificate for the nodes each time that you sign in to Unified RTMT and access the Trace and Log Central option. You cannot change any data that displays for the certificate.
Procedure
Step 1 |
To import the certificate, choose .A messages appears that states that the system imported the node certificates. |
Step 2 |
Click OK. |
Types of trace support
This section describes the types of trace support.
Trace and Log Central disk IO and CPU throttling
Unified RTMT supports the throttling of critical Trace and Log Central operations and jobs, whether they are running on demand, scheduled, or automatic.
When you make a request for an on-demand operation when the node is running under high IO conditions, the system displays a warning that gives you the opportunity to cancel the operation. Be aware that the IO rate threshold values that control when the warning displays are configurable with the following service parameters (Cisco RIS Data Collector service):
-
TLC Throttling CPU Goal
-
TLC Throttling IOWait Goal
The values of these parameters are compared to the actual system CPU and IOWait values. If the goal (the value of the service parameter) is lower than the actual value, the system displays the warning.
View Trace and Log Central Options
Follow this procedure to view Trace and Log Central options in Unified RTMT.
Note |
From any option that displays in the tree hierarchy, you can specify the services and applications for which you want traces, specify the logs and servers that you want to use, schedule a collection time and date, configure the ability to download the files, configure zip files, and delete collected trace files. |
Note |
For devices that support encryption, the SRTP keying material does not display in the trace file. |
Before you begin
Before you begin, import the security certificates.
Procedure
Step 1 |
Perform one of the following actions to access Trace and Log Central:
|
Step 2 |
Perform one of the following tasks after you display the Trace and Log Central options in the Real-Time Monitoring Tool:
|
Collect files
Collect Trace Files
Use the Collect Files option in Trace and Log Central to collect traces for services, applications, and system logs on one or more nodes in the cluster. You specify date and time range for which you want to collect traces, the directory in which to download the trace files and whether to delete the collected files from the node.
Follow this procedure to collect traces using the trace and log central feature.
Note |
The services that you have not activated also appear, so you can collect traces for those services. |
Use the Query Wizard if you want to collect trace files that contain search criteria that you specify or you want to use trace collection criteria that you saved for later use.
Before you begin
Perform one or more of the following actions:
-
Configure the information that you want to include in the trace files for the various services from the Trace Configuration window in Cisco Unified Serviceability. For more information, see the Cisco Unified Serviceability Administration Guide.
-
If you want alarms to be sent to a trace file, choose an SDI or SDL trace file as the alarm destination in the Alarm Configuration window in Cisco Unified Serviceability. For more information, see the Cisco Unified Serviceability Administration Guide.
-
Configure the throttling of critical Trace and Log Central operations and jobs by setting the values of the TLC Throttling CPU Goal and TLC Throttling IOWait Goal service parameters (Cisco RIS Data Collector service). For more information on configuring service parameters, see the System Configuration Guide for Cisco Unified Communications Manager .
Procedure
Step 1 |
Open the Trace and Log Central options. |
||||
Step 2 |
In the Trace & Log Central tree hierarchy, double-click Collect Files. The Trace Collection wizard appears. The services that you have not activated also appear, so you can collect traces for those services.
|
||||
Step 3 |
Cisco Unity Connection users go to Step 4. For Unified Communations Manager or Cisco Business Edition, perform one of the following actions in the Select CCM Services/Application tab: |
||||
Step 4 |
In the Select CUC Services/Application tab, perform one of the following tasks:
|
||||
Step 5 |
In the Select System Services/Application tab, perform one of the following tasks: |
||||
Step 6 |
In the Collection Time pane, specify the time range for which you want to collect traces. Choose one of the following options:
|
||||
Step 7 |
In the Download File option group list, specify the options that you want for downloading traces. From the Select Partition drop-down list, choose the partition that contains the logs for which you want to collect traces. Cisco Unified Serviceability stores the logs for the version of application that you are logged in to in the active partition and stores the logs for the other version (if installed) in the inactive directory. This means that when you upgrade from one version of Unified Communications Manager, Cisco Business Edition 5000, or Cisco Unity Connection that is running on an appliance node to another version, and you restart the node with the new version, Cisco Unified Serviceability moves the logs of the previous version to the inactive partition and stores logs for the newer version in the active partition. If you log back in to the older version, Cisco Unified Serviceability moves the logs for the newer version to the inactive partition and stores the logs for the older version in the active directory.
|
||||
Step 8 |
To specify the directory in which you want to download the trace files, click the Browse button next to the Download File Directory field, navigate to the directory, and click Open. The default specifies <rtmt_users_directory>\<server name or server IP address>\<download time>. |
||||
Step 9 |
To create a zip file of the trace files that you collect, choose the Zip File radio button. To download the trace files without zipping the files, choose the Do Not Zip Files radio button. |
||||
Step 10 |
To delete collected log files from the node, check the Delete Collected Log Files from the server check box. |
||||
Step 11 |
Click Finish or, to abort the settings, click Cancel. If you clicked Finish, the window shows the progress of the trace collection. When the trace collection process is complete, the message "Completed downloading for node <Server name or IP address>" appears at the bottom of the window. |
||||
Step 12 |
To view the trace files that you collected, you can use the Local Browse option of the trace collection feature.
|
Query Wizard
The Trace Collection Query Wizard allows you to collect and download trace files that contain search criteria that you specify as well as to save trace collection criteria for later use. To use the Trace Collection Query Wizard, perform the procedures to start a query and execute a query.
Before You Begin
-
Configure the information that you want to include in the trace files for the various services from the Trace Configuration window.
-
If you want alarms to be sent to a trace file, select an SDI trace file as the alarm destination in the Alarm Configuration window.
Start a Query
Procedure
Step 1 |
Open Trace & Log Central. |
|||||||||||||||
Step 2 |
Double-select Query Wizard in the tree hierarchy. |
|||||||||||||||
Step 3 |
Perform one of the following actions:
|
|||||||||||||||
Step 4 |
Select Next. |
|||||||||||||||
Step 5 |
Perform one of the following actions:
|
|||||||||||||||
Step 6 |
Select Next. |
|||||||||||||||
Step 7 |
Perform one of the following actions:
|
|||||||||||||||
Step 8 |
Perform one of the following actions to specify the time range for which you want to collect traces:
|
|||||||||||||||
Step 9 |
Enter the word or phrase in the Search String field to search by phrases or words that exist in the trace file. The tool searches for an exact match to the word or phrase that you enter. |
What to do next
Execute a query.
Execute a Query
-
If any node in the cluster is not available, a dialog box displays with a message that indicates which node is not available. The unavailable node does not display in the Trace & Log Central windows.
-
You can install some listed services or applications only on a particular node in the cluster. To collect traces for those services or applications, make sure that you collect traces from the node on which you have activated the service or application.
-
The services that you have not activated also display, so you can collect traces for those services.
-
After you have downloaded the trace files, you can view them by using the Local Browse option of the trace and log central feature.
-
An error message displays if the service parameter values are exceeded or if the system is in code yellow.
Procedure
Step 1 |
Select Run Query to execute the query. |
||||||||||||||
Step 2 |
Select Save Query to save the query and continue with the next step. |
||||||||||||||
Step 3 |
Select OK when the dialog box displays that indicates that the query execution completed. |
||||||||||||||
Step 4 |
Perform the following actions:
|
||||||||||||||
Step 5 |
Browse to the location to store the query, enter a name for the query in the File Name field. |
||||||||||||||
Step 6 |
Select Save. |
||||||||||||||
Step 7 |
Perform one of the following actions:
|
||||||||||||||
Step 8 |
Perform one of the following actions after the query execution completes:
|
Schedule Trace Collection in Cisco Unified Communications Manager
You can use the Schedule Collection option of the trace and log central feature to schedule up to six concurrent trace collections and to download the trace files to a SFTP or FTP server on your network, run another saved query, or generate a syslog file. To change a scheduled collection after you have entered it in the system, you must delete the scheduled collection and add a new collection event.
Important |
From Release 14SU3 onwards, FTP server is no longer supported. We recommend that you use SFTP server for scheduled trace collections. |
Note |
You can schedule up ten trace collection jobs, but only six trace collection can be concurrent. That is, only six jobs can be in a running state at the same time. |
Before you begin
Note |
For large deployments, we recommend that you use a dedicated trace archive server and set up scheduled trace collections to this trace server. |
Perform one or more of the following actions:
-
Configure the information that you want to include in the trace files for the various services from the Trace Configuration window of Cisco Unified Serviceability. For more information, see the Cisco Unified Serviceability Administration Guide.
-
If you want alarms to be sent to a trace file, choose an SDI or SDL trace file as the alarm destination in the Alarm Configuration window. For more information, see the Cisco Unified Serviceability Administration Guide.
Procedure
Step 1 |
Open the Trace and Log Central options. |
||||||||
Step 2 |
In the Trace and Log Central tree hierarchy, double-click Schedule Collection. The Schedule Collection wizard appears.
|
||||||||
Step 3 |
Perform one of the following actions in the Select CCM Services/Application tab:
|
||||||||
Step 4 |
In the Select System Services/Application tab, perform one of the following actions:
|
||||||||
Step 5 |
Specify the node time zone and the time range for which you want to collect traces. The time zone of the client machine provides the default setting for the Select Reference Server Time Zone field. All the standard time zones, along with a separate set of entries for all time zones that have Daylight Saving settings, appear in the Select Time Zone drop-down list. |
||||||||
Step 6 |
To specify the date and time that you want to start the trace collection, click the down arrow button next to the Schedule Start Date/Time field. In the Date tab, choose the appropriate date. In the Time tab, choose the appropriate time. |
||||||||
Step 7 |
To specify the date and time that you want to end the trace collection, click the down arrow button next to the Schedule End Date/Time field. In the Date tab, choose the appropriate date. In the Time tab, choose the appropriate time.
|
||||||||
Step 8 |
From the Scheduler Frequency drop-down list, choose how often you want to run the configured trace collection. |
||||||||
Step 9 |
From the Collect Files that are generated in the last drop-down list, specify the time (in minutes, hours, days, weeks, or months) prior to the current time for which you want to collect traces. |
||||||||
Step 10 |
To search by phrases or words that exist in the trace file, enter the word or phrase in the Search String field. The tool searches for a match to the word or phrase that you enter and collects those files that match the search criteria. If you want to search for an exact match to the word or phrase that you entered, check the Case Sensitive check box |
||||||||
Step 11 |
To create a zip file of the trace files that you collect, check the Zip File check box. |
||||||||
Step 12 |
To delete collected log files from the node, check the Delete Collected Log Files from the Server check box. |
||||||||
Step 13 |
Choose one or more of the following actions:
|
||||||||
Step 14 |
In the SFTP/FTP Server Parameters group box, enter the node credentials for the node where the trace and log central feature downloads the results and click Test Connection. Enter the fingerprint values, when asked. After the trace and log central feature verifies the successful connection to the SFTP or FTP server, click OK.
The Download Directory Path field specifies the directory in which the trace and log central feature stores collected files. By default, the trace collection stores the files in the home directory of the user whose user ID you specify in the SFTP or FTP parameters fields: /home/<user>/Trace.
You can choose Localhost download option when downloading traces. This option is available only for Cisco Intercompany Media Engine servers. If you download trace files to the local host directories on the Cisco Intercompany Media Engine server, you can offload the files to a remote SFTP server by using the file get CLI command.
|
||||||||
Step 15 |
If you chose the Run Another Query Option, click the Browse button to locate the query that you want to run, and click OK.
|
||||||||
Step 16 |
Click Finish. A message indicates that the system added the scheduled trace successfully.
|
||||||||
Step 17 |
Click OK. |
||||||||
Step 18 |
To view a list of scheduled collections, click the Job Status icon in the Trace portion of the Quick Launch Channel.
|
Schedule Trace Collection in Cisco Unity Connection
You can use the Schedule Collection option of the trace and log central feature to schedule up to six concurrent trace collections and to download the trace files to a SFTP or FTP server on your network, run another saved query, or generate a syslog file. To change a scheduled collection after you have entered it in the system, you must delete the scheduled collection and add a new collection event. To schedule trace collection, perform the following procedure.
Important |
From Release 14SU3 onwards, FTP server is no longer supported. We recommend that you use SFTP server for scheduled trace collections. |
Note |
You can schedule up ten trace collection jobs, but only six trace collection can be concurrent. That is, only six jobs can be in a running state at the same time. |
Before you begin
Perform one or more of the following actions:
-
Configure the information that you want to include in the trace files for the various services from the Trace Configuration window of Cisco Unified Serviceability. For more information, see the Cisco Unified Serviceability Administration Guide.
-
If you want alarms to be sent to a trace file, choose an SDI or SDL trace file as the alarm destination in the Alarm Configuration window. For more information, see the Cisco Unified Serviceability Administration Guide.
Procedure
Step 1 |
Open the Trace and Log Central options. |
||||||
Step 2 |
In the Trace & Log Central tree hierarchy, double-click Schedule Collection. The Schedule Collection wizard appears.
|
||||||
Step 3 |
In the Select CUC Services/Application tab, perform one of the following actions:
|
||||||
Step 4 |
In the Select System Services/Application tab, perform one of the following actions:
|
||||||
Step 5 |
Specify the node time zone and the time range for which you want to collect traces. The time zone of the client machine provides the default setting for the Select Reference Server Time Zone field. All the standard time zones, along with a separate set of entries for all time zones that have Daylight Saving settings, appear in the Select Time Zone drop-down list box. |
||||||
Step 6 |
To specify the date and time that you want to start the trace collection, click the down arrow button next to the Schedule Start Date/Time field. In the Date tab, choose the appropriate date. In the Time tab, choose the appropriate time. |
||||||
Step 7 |
To specify the date and time that you want to end the trace collection, click the down arrow button next to the Schedule End Date/Time field. In the Date tab, choose the appropriate date. In the Time tab, choose the appropriate time.
|
||||||
Step 8 |
From the Scheduler Frequency drop-down list box, choose how often you want to run the configured trace collection. |
||||||
Step 9 |
From the Collect Files that are generated in the last drop-down list boxes, specify the time (in minutes, hours, days, weeks, or months) prior to the current time for which you want to collect traces. |
||||||
Step 10 |
To search by phrases or words that exist in the trace file, enter the word or phrase in the Search String field. The tool searches for a match to the word or phrase that you enter and collects those files that match the search criteria. If you want to search for an exact match to the word or phrase that you entered, check the Case Sensitive check box |
||||||
Step 11 |
To create a zip file of the trace files that you collect, check the Zip File check box. |
||||||
Step 12 |
To delete collected log files from the node, check the Delete Collected Log Files from the Server check box. |
||||||
Step 13 |
Choose one or more of the following actions:
|
||||||
Step 14 |
In the SFTP/FTP Server Parameters group box, enter the node credentials for the node where the trace and log central feature downloads the results and click Test Connection. After the trace and log central feature verifies the connection to the SFTP or FTP server, click OK. The Download Directory Path field specifies the directory in which the trace and log central feature stores collected files. By default, the trace collection stores the files in the home directory of the user whose user ID you specify in the SFTP or FTP parameters fields: /home/<user>/Trace.
You can choose Localhost download option when downloading traces. This option is available only for Cisco Intercompany Media Engine servers. If you download trace files to the local host directories on the Cisco Intercompany Media Engine server, you can offload the files to a remote SFTP server by using the file get CLI command.
|
||||||
Step 15 |
If you chose the Run Another Query Option, click the Browse button to locate the query that you want to run, and click OK.
|
||||||
Step 16 |
Click Finish. A message indicates that the system added the scheduled trace successfully.
|
||||||
Step 17 |
Click OK. |
||||||
Step 18 |
To view a list of scheduled collections, click the Job Status icon in the Trace portion of the Quick Launch Channel.
|
Start a schedule
Before you begin
- Configure the information that you want to include in the trace files for the various services from the Trace Configuration window.
- If you want alarms to be sent to a trace file, select an SDI trace file as the alarm destination in the Alarm Configuration window.
Procedure
Step 1 |
Open Trace & Log Central. |
||||||||||
Step 2 |
Double-select Schedule Collection in the tree hierarchy. |
||||||||||
Step 3 |
Perform one of the following actions to collect trace on node logs:
|
||||||||||
Step 4 |
Perform one of the following actions to collect traces on system logs:
|
||||||||||
Step 5 |
Specify the node time zone and the time range for which you want to collect traces. |
||||||||||
Step 6 |
Perform the following actions to specify the date and time that you want to start the trace collection:
|
||||||||||
Step 7 |
To specify the date and time that you want to end the trace collection, perform the following actions: |
What to do next
Execute a schedule
Procedure
Step 1 |
Select how often you want to run the configured trace collection from the Scheduler Frequency list box. |
Step 2 |
Specify the time (in minutes, hours, days, weeks, or months) prior to the current time for which you want to collect traces. |
Step 3 |
Enter the word or phrase in the Search String field to search by phrases or words that exist in the trace file. The tool searches for an exact match to the word or phrase that you enter and only collects those files that match the search criteria. |
Step 4 |
Check Zip All Files to create a zip file of the trace files that you collect. |
Step 5 |
Check Delete Collected Log Files from the Server to delete collected log files from the server. |
Step 6 |
Perform one or more of the following actions:
|
Step 7 |
Select Finish. Troubleshooting Tips
|
View Trace Collection Status
Follow this procedure to view the trace collection event status and to delete scheduled trace collections.
Procedure
Step 1 |
Open the Trace & Log Central tree hierarchy. |
||
Step 2 |
Double-click Job Status. The Job Status window appears. |
||
Step 3 |
From the Select a Node drop-down list box, choose the server for which you want to view or delete trace collection events. This list of scheduled trace collections appears. Possible job types include the following:
Possible statuses include the following:
|
||
Step 4 |
To delete a scheduled collection, choose the event that you want to delete and click Delete.
|
Generate Problem Reporting Tool
The Problem Reporting Tool (PRT) on the Cisco IP Phone allows you to collect and send phone logs to your administrator. These logs are necessary for troubleshooting in case you run into issues with the phones.
Generate PRT for Endpoints
Use the Generate PRT option in Trace and Log Central to remotely trigger the log collection on the phone and upload it to the log server configured in the "Customer support upload URL" parameter.
Procedure
Step 1 |
Open the Trace and Log Central options. |
||
Step 2 |
In the Trace & Log Central tree hierarchy, choose Generate PRT. |
||
Step 3 |
Enter the Device name as configured in the Find and List Phones page in the Cisco Unified CM Administration user interface. |
||
Step 4 |
Click Generate PRT. The generated report is uploaded at the Customer support upload URL.
|
Real-Time Trace
The real-time trace option of the Trace and Log Central feature allows you to view the current trace file that is being written on the server for each application. If the system has begun writing a trace file, the real-time trace starts reading the file from the point where you began monitoring rather than at the beginning of the trace file. You cannot read the previous content.
The real-time trace provides the option to view real-time data and monitor user events.
View Real-Time Data
The view real-time data option of the trace and log central feature allows you to view a trace file as the system writes data to that file. You can view real-time trace data in the generic log viewer for up to ten services, with a limit of three concurrent sessions on a single node. The log viewer refreshes every 5 seconds. As the traces are rolled into a new file, the generic log viewer appends the content in the viewer.
Note |
Depending on the frequency of the traces that a service writes, the View Real Time Data option may experience a delay before being able to display the data in the generic log viewer. |
Procedure
Step 1 |
Open the Trace & Log Central tree hierarchy. |
||||
Step 2 |
Double-click Real Time Trace.
|
||||
Step 3 |
Double-click View Real Time Data. The View Real Time Data wizard appears. |
||||
Step 4 |
From the Nodes drop-down list box, choose the node for which you want to view real-time data and click Next. |
||||
Step 5 |
Choose the product, service, and the trace file type for which you want to view real-time data.
|
||||
Step 6 |
Click Finish. The real-time data for the chosen service displays in the generic log viewer. |
||||
Step 7 |
Perform one of the following actions:
|
||||
Step 8 |
Repeat this procedure to view data for additional services. A message appears if you attempt to view data for too many services or too many services on a single node. |
||||
Step 9 |
After you finish with viewing the real-time data, click Close on the generic log viewer.
|
Monitor User Event
The monitor user event option of the trace and log central feature monitors real-time trace files and performs a specified action when a search string appears in the trace file. The system polls the trace file every 5 seconds. If the search string occurs more than once in one polling interval, the system performs the action only once.
Before you begin
If you want to generate an alarm when the specified search string exists in a monitored trace file, enable the LogFileSearchStringFound alert.
Procedure
Step 1 |
Open the Trace & Log Central tree hierarchy. |
||||||||||||||||||||
Step 2 |
Double-click Real Time Trace.
|
||||||||||||||||||||
Step 3 |
Double-click Monitor User Event. The Monitor User Event wizard appears. |
||||||||||||||||||||
Step 4 |
Perform one of the following actions:
|
||||||||||||||||||||
Step 5 |
Choose the node that you want the system to monitor from the Nodes drop-down list box and click Next. |
||||||||||||||||||||
Step 6 |
Choose the product, service, and the trace file type that you want the system to monitor and click Next.
|
||||||||||||||||||||
Step 7 |
In the Search String field, specify the phrases or words that you want the system to locate in the trace files. The tool searches for an exact match to the word or phrase that you enter. |
||||||||||||||||||||
Step 8 |
Specify the node time zone and the time range (start and end date and time) for which you want the system to monitor trace files. The time zone of the client machine provides the default setting for the Select Reference Server Time Zone field. All the standard time zones, along with a separate set of entries for all time zones that have Daylight Saving settings, display in the Select Time Zone drop-down list box. Trace and Log Central downloads the files with a time range that is based on your Selected Reference Server Time Zone field. If you have nodes in a cluster in a different time zone, TLC adjusts for the time change and get files for the same period of time. For example, if you specify files from 9:00 a.m. to 10:00 a.m. and you have a second node (node x) that is in a time zone that is one hour ahead, TLC downloads files from 10:00 a.m. to 11:00 a.m. from node x. To set the date range for which you want to monitor traces, choose the drop-down list box in the From Date/Time and To Date/Time fields. |
||||||||||||||||||||
Step 9 |
Choose one or more of the following actions that you want the system to perform when it encounters the search string that you specified in the Search String field:
The system polls the trace files every 5 seconds and performs the specified actions when it encounters the search string. If more than one occurrence of the search string occurs in a polling interval, the system performs the action only once. The following message appears: |
||||||||||||||||||||
Step 10 |
Click Finish. |
Collect Crash Dump in Cisco Unified Communications Manager
Follow this procedure to collect a core dump of trace files.
Procedure
Step 1 |
Open the Trace & Log Central tree hierarchy. |
||||||
Step 2 |
Double-click Collect Crash Dump. The Collect Crash Dump wizard appears.
|
||||||
Step 3 |
Perform one of the following actions in the Select CCM Services/Application tab:
|
||||||
Step 4 |
In the Select System Services/Application tab, perform one of the following actions:
|
||||||
Step 5 |
In the Collection Time group box, specify the time range for which you want to collect traces. Choose one of the following options:
|
||||||
Step 6 |
From the Select Partition drop-down list box, choose the partition that contains the logs for which you want to collect traces. Cisco Unified Serviceability stores the logs for the version of application that you are logged in to in the active partition and stores the logs for the other version (if installed) in the inactive directory. When you upgrade from one version of your product that is running on the Linux platform to another version, and you restart the node with the new version, Cisco Unified Serviceability moves the logs of the previous version to the inactive partition and stores logs for the newer version in the active partition. If you log in to the older version, Cisco Unified Serviceability moves the logs for the newer version to the inactive partition and stores the logs for the older version in the active directory.
|
||||||
Step 7 |
To specify the directory in which you want to download the trace files, click the Browse button next to the Download File Directory field, navigate to the directory, and click Open. The default specifies <rtmt_users_directory>\<server name or server IP address>\<download time>. |
||||||
Step 8 |
To create a zip file of the crash dump files that you collect, choose the Zip File radio button. To download the crash dump files without zipping the files, choose the Do Not Zip Files radio button.
|
||||||
Step 9 |
To delete collected crash dump files from the node, check the Delete Collected Log Files from Server check box. |
||||||
Step 10 |
Click Finish. A message appears that states that you want to collect core dumps. To continue, click Yes.
|
Collect Crash Dump in Cisco Unity Connection
Follow this procedure to collect a core dump of trace files.
Procedure
Step 1 |
Open the Trace & Log Central tree hierarchy. |
||||||
Step 2 |
Double-click Collect Crash Dump. The Collect Crash Dump wizard appears.
|
||||||
Step 3 |
In the Select CUC Services/Application tab, perform one of the following actions:
|
||||||
Step 4 |
In the Select System Services/Application tab, perform one of the following actions:
|
||||||
Step 5 |
In the Collection Time group box, specify the time range for which you want to collect traces. Choose one of the following options:
|
||||||
Step 6 |
From the Select Partition drop-down list box, choose the partition that contains the logs for which you want to collect traces. Cisco Unified Serviceability stores the logs for the version of application that you are logged in to in the active partition and stores the logs for the other version (if installed) in the inactive directory. When you upgrade from one version of your product that is running on the Linux platform to another version, and you restart the node with the new version, Cisco Unified Serviceability moves the logs of the previous version to the inactive partition and stores logs for the newer version in the active partition. If you log in to the older version, Cisco Unified Serviceability moves the logs for the newer version to the inactive partition and stores the logs for the older version in the active directory.
|
||||||
Step 7 |
To specify the directory in which you want to download the trace files, click the Browse button next to the Download File Directory field, navigate to the directory, and click Open. The default specifies <rtmt_user_directory>\<server name or server IP address>\<download time> where <rtmt_user_directory> specifies the directory where RTMT is installed. |
||||||
Step 8 |
To create a zip file of the crash dump files that you collect, choose the Zip File radio button. To download the crash dump files without zipping the files, choose the Do Not Zip Files radio button.
|
||||||
Step 9 |
To delete collected crash dump files from the node, check the Delete Collected Log Files from Server check box. |
||||||
Step 10 |
Click Finish. A message appears that states that you want to collect core dumps. To continue, click Yes.
|
Collect Installation Logs
Follow this procedure to collect installation and upgrade logs.
Procedure
Step 1 |
Choose .The Trace & Log Central window appears. |
Step 2 |
In the Trace & Log Central tree hierarchy, double-click Collect Install Logs. The Collect Install Logs wizard appears. |
Step 3 |
In the Select Servers Options box, specify from which server you would like to collect the install logs.
|
Step 4 |
In the Download File Options, specify the directory where you want to download the log file. To specify the directory in which you want to download the log files, click Browse next to the Download File Directory field, navigate to the directory, and click Open. The default specifies <rtmt_users_directory>. |
Step 5 |
Click Finish. |
Collect audit logs
Browse Audit Logs
Procedure
Step 1 |
Open the Trace & Log Central tree hierarchy. |
||||
Step 2 |
Double-click Collect Audit Logs. The Collect Audit Logs Action Options wizard appears. |
||||
Step 3 |
Check the Browse Audit Logs check box. |
||||
Step 4 |
Click Next. The Nodes Selection Options wizard appears. |
||||
Step 5 |
Perform one of the following actions in the Action Options window:
|
||||
Step 6 |
Click Finish. |
||||
Step 7 |
The Remote Browse is Ready window appears. Click Close. The Nodes pane appears. |
||||
Step 8 |
On the left side of the Nodes pane, double-click the Nodes folder. Navigate through the tree hierarchy until the Audit App folder appears. |
||||
Step 9 |
After the audit log file names display in the pane on the right side of the window, you can either right-click the mouse to select the type of program that you want to use to view each file or double-click the selected file to display the file in the default viewer. |
||||
Step 10 |
Select an audit log file and perform one of the following actions:
You have completed the steps for Browse Audit Logs. |
Download Audit Logs
Procedure
Step 1 |
Open the Trace & Log Central tree hierarchy. |
||||||||||||
Step 2 |
Double-click Collect Audit Logs. The Collect Audit Logs Action Options wizard appears. |
||||||||||||
Step 3 |
Check the Download Audit Logs check box. |
||||||||||||
Step 4 |
Click Next. The Nodes Selection Options wizard appears. |
||||||||||||
Step 5 |
Perform one of the following actions in the Action Options window:
|
||||||||||||
Step 6 |
Click Finish. |
||||||||||||
Step 7 |
To download audit logs, click Next. The Download Audit Logs window appears. |
||||||||||||
Step 8 |
In the Nodes Selection Options pane, perform one of the following actions:
|
||||||||||||
Step 9 |
In the Collection Time pane, click one of the following radio buttons:
|
||||||||||||
Step 10 |
In the Download File Options pane, select one of the following options: |
||||||||||||
Step 11 |
Click Finish. You have completed the steps for the download of audit logs. |
Schedule Audit Log Download
Procedure
Step 1 |
Open the Trace & Log Central tree hierarchy. |
||||||||
Step 2 |
Double-click Collect Audit Logs. The Collect Audit Logs Action Options wizard appears. |
||||||||
Step 3 |
Check the Schedule Download of Audit Logs check box. |
||||||||
Step 4 |
Click Next. The Nodes Selection Options wizard appears. |
||||||||
Step 5 |
Perform one of the following actions in the Action Options window:
|
||||||||
Step 6 |
Click Finish. The Schedule Download of Audit Logs window appears. |
||||||||
Step 7 |
In the Nodes Selection Options pane, perform one of the following actions:
|
||||||||
Step 8 |
In the Schedule Time pane, perform the following actions:
|
||||||||
Step 9 |
In the Action Options pane, check the Download Files check box. |
||||||||
Step 10 |
Enter the following information:
You have completed the steps to schedule the download of audit logs. |
Display Downloaded Trace Files Using Local Browse
After you collect trace files and download them to your PC, you can view them with a text editor that can handle UNIX variant line terminators such as WordPad on your PC, or you can view them by using the viewers within Unified RTMT.
Tip |
Do not use NotePad to view collected trace files. |
Follow this procedure to display the log files that you collected with the Trace and Log Central feature. If you zipped the trace files when you downloaded them to your PC, you need to unzip the files to view them by using the viewers within Unified RTMT.
Note |
You can open a maximum of five concurrent files for viewing within Trace and Log Central, which includes using the Query Wizard, Local Browse, and RemoteBrowse features. |
Before you begin
Collect the required traces files. See topics related to collecting trace files, downloading trace files using Query Wizard, and scheduling trace collection for instructions.
Procedure
Step 1 |
Open Trace and Log Central. |
Step 2 |
Double-click Local Browse. |
Step 3 |
Browse to the directory where you stored the log file and choose the file that you want to view. |
Step 4 |
To display the results, double-click the file. If the file type has a viewer that is already associated with it, the file opens in that viewer. Otherwise, the Open With dialog box appears. |
Step 5 |
Click the program that want to use to view the file. If your preferred program is not on the list, choose another program by clicking Other. If you want to use this program as your default viewer, check the Always use this program to open these files check box. Unified RTMT displays the file in the appropriate viewer for the file type. If no other appropriate viewer applies, Unified RTMT opens files in the Generic Log Viewer. |
Display and Download Trace Files in Cisco Unified Communications Manager
After the system generates trace files, you can view them on the node by using the viewers within Unified RTMT. You can also use the remote browse feature to download the traces to your PC.
Follow this procedure to display and download the log files on the node with the Trace and Log Central feature.
Note |
You can open a maximum of five concurrent files for viewing within Trace and Log Central. This includes using the Query Wizard, Local Browse, and RemoteBrowse features. |
Before you begin
Collect the required traces files. See topics related to collecting trace files, downloading trace files using Query Wizard, and scheduling trace collection.
Procedure
Step 1 |
Open the Trace and Log Central options. |
||||||
Step 2 |
Double-click Remote Browse. |
||||||
Step 3 |
Choose the appropriate radio button, and click Next.
|
||||||
Step 4 |
Perform one of the following actions in the Select CCM Services/Application tab:
|
||||||
Step 5 |
In the Select System Services/Application tab, perform one of the following actions:
|
||||||
Step 6 |
Perform one of the following actions in the Select CCM Services/Application tab:
|
||||||
Step 7 |
In the Select System Services/Application tab, perform one of the following tasks:
|
||||||
Step 8 |
Click Finish. |
||||||
Step 9 |
After the traces become available, a message appears. Click Close. |
||||||
Step 10 |
Perform one of the following actions:
|
Display And Download Trace Files in Cisco Unity Connection
After the system generates trace files, you can view them on the node by using the viewers within Unified RTMT. You can also use the remote browse feature to download the traces to your PC.
Follow this procedure to display and download the log files on the node with the Trace and Log Central feature.
Note |
You can open a maximum of five concurrent files for viewing within Trace and Log Central. This includes using the Query Wizard, Local Browse, and RemoteBrowse features. |
Before you begin
Collect the required traces files. See topics related to collecting trace files, downloading trace files using Query Wizard, and scheduling trace collection.
Procedure
Step 1 |
Open the Trace and Log Central options. |
||||||
Step 2 |
Double-click Remote Browse. |
||||||
Step 3 |
Choose the appropriate radio button, and click Next.
|
||||||
Step 4 |
In the Select CUC Services/Application tab, perform one of the following actions:
|
||||||
Step 5 |
In the Select System Services/Application tab, perform one of the following actions:
|
||||||
Step 6 |
In the Select CUC Services/Application tab, perform one of the following tasks:
|
||||||
Step 7 |
In the Select System Services/Application tab, perform one of the following tasks:
|
||||||
Step 8 |
Click Finish. |
||||||
Step 9 |
After the traces become available, a message appears. Click Close. |
||||||
Step 10 |
Perform one of the following actions:
|
Set Trace Collection Attributes
Before you begin
Collect traces files.
Procedure
Step 1 |
Open Trace & Log Central. |
||||||||||||
Step 2 |
Double-select Remote Browse. |
||||||||||||
Step 3 |
Select the appropriate radio button, Trace Files or Crash Dump. |
||||||||||||
Step 4 |
Select Next. |
||||||||||||
Step 5 |
Perform one of the following actions:
|
||||||||||||
Step 6 |
Perform one of the following actions in the Voice/Video or IM and Presence Applications/Services tab:
|
||||||||||||
Step 7 |
Perform one of the following actions in the Select System Services/Application tab:
|
||||||||||||
Step 8 |
Perform one of the following actions in the Voice/Video or IM and Presence Applications/Services tab:.
|
||||||||||||
Step 9 |
Perform one of the following actions in the Select System Services/Application tab:.
|
||||||||||||
Step 10 |
Select Finish. |
What to do next
View trace results.
View Trace Results
-
You can install some listed services/applications only on a particular node in the cluster. To select traces for those services/applications, make sure that you select traces from the server on which you have activated the service/application.
-
The services that you have not activated also display, so you can select traces for those services.
-
After you have downloaded the trace files, you can view them by using the Local Browse option of the trace and log central feature.
-
To sort the files that displays in the pane, select a column header; for example, to sort the files by name, select the Name column header.
-
The Real-Time Monitoring Tool displays the file in the appropriate viewer for the file type. If no other appropriate viewer applies, the Real-Time Monitoring Tool opens files in the Generic Log Viewer.
-
The IM and Presence service does not support the Q931 Translator. IM and Presence does not support QRT report information.
Before you begin
Set your trace collection attributes.
Procedure
Step 1 |
Select Close when a message states that the trace results are available. |
||||||||||||||||||
Step 2 |
Perform one of the following actions:
|
Display Report Information
You can view the QRT log files by either viewing the files on the server or by downloading the files onto your computer.
Note |
This section applies only to Unified Communications Manager. |
You can view the IP phone problem reports that the Quality Report Tool generates by using the QRT viewer. QRT serves as a voice-quality and general problem-reporting tool for Cisco Unified IP Phones. After you collect the QRT log files, you can use the following procedure to list and view Unified Communications Manager IP Phone problem reports by using the QRT viewer. The QRT viewer allows you to filter, format, and view phone problem reports that are generated. For more information about how to configure and use QRT, see the System Configuration Guide for Cisco Unified Communications Manager .
Before you begin
Collect or view the Quality Report Tool (QRT) log files. See topics related to collecting trace files, scheduling trace collection, and downloading trace files using either Query Wizard or the Remote Browser.
Procedure
Step 1 |
Display the log file entries by using the Query Wizard, the Remote Browse, or the Local Browse option in Trace and Log Central. The QRT Viewer window appears.
|
||||
Step 2 |
From the Extension drop-down list box, choose the extension or extensions that you want the report to include. |
||||
Step 3 |
From the Device drop-down list box, choose the device or devices that you want the report to include. |
||||
Step 4 |
From the Category drop-down list box, choose the problem category that you want the report to include. |
||||
Step 5 |
From the Select Fields drop-down list box, choose the fields that you want the report to include.
|
||||
Step 6 |
To view the report in the QRT Report Result pane, click Display Records. |
Log Compression
In Unified Communications Manager 8.0 onward, the log compression feature only compresses the following log files:
-
cm/trace/cti/sdl
-
cm/trace/cti/sdi
-
cm/trace/ccm/sdl
-
cm/trace/ccm/sdi
The other log files are not compressed and are written directly to the hard disk.
The compressed files have a .gz extension. The file that is being actively written to the disk will have a .gzo extension.
All the CLI commands used to view and tail the files will work on the compressed files and will automatically uncompress them for viewing or tailing. The only difference is in specifying file names with the .gz and .gzo extension.
The following option is available with the file tail command:
file tail activelog cm/trace/cti/sdl recent
The recent option, when used with a compressed directory, continually tails the most recent log file. You do not need to switch to a newer log file when the currently written-to log file is closed, so it is an infinite and ongoing tail. This option is only available with the compressed log files.
The log files are compressed in the gzip format. For uncompressing the log files, the open source program 7-Zip is available at http://www.7-zip.org, and works on all Windows platforms. You can use 7-Zip on any computer, including a computer in a commercial organization. You do not need to register or pay for 7-Zip. On a Linux platform, you can use the gzip or gunzip commands.
Edit Trace Settings
Follow this procedure to edit trace settings for Unified RTMT.
Note |
The Error radio button is the default setting. |
Procedure
Step 1 |
Choose |
Step 2 |
Click the radio button that applies. The system stores the rtmt.log file in the Documents and Settings directory for the user; for example, on a Windows machine, the log is stored in C:\Documents and Settings\<userid>\.jrtmt\log. |