UCCE Trace Settings and Log Collection
UCCE Trace Settings and Log Collection
UCCE Trace Settings and Log Collection
com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
Tech Zone Tech Zone Knowledge Base Unified Contact Center Knowledge Base Unified Contact Center Enterprise (UCCE) & ICM Knowledge Base Other UCCE Topics
Summary
This document describes how to set tracing in the Cisco Unified Contact Center Enterprise (UCCE) for clients, peripheral gateway (PG) services, the Cisco Customer Voice Portal (CVP),
the Cisco UCCE Outbound Dialer, Cisco Unified Communications Manager (CallManager) (CUCM), and Cisco gateways.
Notes:
Use the Command Lookup Tool (registered customers only) in order to obtain more information on the commands used in this section.
The Output Interpreter Tool (registered customers only) supports certain show commands. Use the Output Interpreter Tool in order to view an analysis of show command output.
Refer to Important Information on Debug Commands before you use debug commands.
Finesse
Log in to the Finesse server with the Secure Shell (SSH) and enter these commands in order to collect the logs you need. You are prompted to identify a SSH FTP (SFTP) server where
the logs will be uploaded.
Logs Command
Install logs file get install desktop-install.log
Desktop logs file get activelog desktop recurs compress
Servm logs file get activelog platform/log/servm*.\* compress
Platform Tomcat logs file get activelog tomcat/logs recurs compress
Voice Operating System (VOS) install logs file get install install.log
1. On the agent computer, go to the C:\Program Files\Cisco\Desktop\Config directory and open the Agent.cfg file.
2. Change the debug Threshold from OFF to DEBUG. TRACE can be used for deeper level.
[Debug Log]
Path=..\log\agent.dbg
Size=3000000
Threshold=DEBUG
agent0001.dbg
ctiosclientlog.xxx.log
1. On the agent computer, go to the the C:\Program Files\Cisco\Desktop\Config directory and open the supervisor.cfg file.
2. Change the debug THRESHOLD from OFF to DEBUG. TRACE can be used for deeper level.
[Debug Log]
Path=..\log\supervisor.dbg
Size=3000000
THRESHOLD=DEBUG
1 of 10 10-Jan-15 09:59 PM
UCCE Trace Settings and Log Collection - Tech Zone https://techzone.cisco.com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
7. Start the agent program, and recreate the problem. A debug file named supervisor0001.dbg is created and placed in C:\Program Files\Cisco\Desktop\log.
On the client PC where the CTIOS client is installed, use Regedt32 in order to turn up tracing. Change these settings:
Default output is created and placed in a text file named CtiosClientLog in the c:\Program Files\Cisco Systems\CTIOS Client\CTIOS Desktop Phones\ install directory.
Setting Value
Configuration file DirAccessSynSvr.cfg
Default location C:\Program Files\Cisco\Desktop\config
General issues Threshold=DEBUG
Output files DirAccessSynSvr.log
These are the settings to debug the CAD 6.0(X) RASCAL server:
Setting Value
Configuration file FCRasSvr.cfg
Default location C:\Program Files\Cisco\Desktop\config
General issues Range = 1-4, 50, 3000-8000
LDAP-related issues: Range = 4000-4999
LRM-related issues: Range = 1999-2000
Database-related issues Range = 50-59
Output files FCRasSvr.log, FCRasSvr.dbg
Default location C:\Program Files\Cisco\Desktop\log
Setting Value
Configuration file FCCServer.cfg
Default location C:\Program Files\Cisco\Desktop\config
General issues Threshold=DEBUG
Output files FCCServer.log, FCCServer.dbg
Default location C:\Program Files\Cisco\Desktop\log
Use the process monitoring (procmon) utility in order to turn trace levels on and off. These commands turn on CallManager peripheral interface manager (PIM) tracing:
>>>trace * /off
2. Select Trace/Configuration.
3. Select CM Services.
2 of 10 10-Jan-15 09:59 PM
UCCE Trace Settings and Log Collection - Tech Zone https://techzone.cisco.com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
7. Leave the number of files and their sizes at the default values.
8. In the Real-Time Monitoring Tool (RTMT), collect Cisco Call Manager and Cisco Computer Telephony Integration (CTI) Manager. Both have system diagnostic interface (SDI) and
signal distribution layer (SDL) logs.
This procedure describes how to enable CTISVR tracing on the active side:
1. Use the registry editor in order to edit HKLM\software\Cisco Systems, Inc\icm\<cust_inst>\CG1(a and b)\EMS\CurrentVersion\library\Processes\ctisvr.
Note: Commands are case sensitive. The Voice Response Unit (VRU) PG is different than the Cisco CallManager (CCM) PG.
>>>trace * /off
2. Use the registry editor in order to edit HLKM >> Software\Cisco Systems Inc.\ICM\<cust_inst\CTIOS\EMS\CurrentVersion\library\Processes\ctios.
3. Set:
EMSTraceMask = 0x60A0F
EMSTraceMask to one of these values, depending upon the release:
0x0A0F for Release 6.0 and earlier
0x20A0F for Release 7.0 and 7.1(1)
0x60A0F for Release 7.1(2) and later
The default trace mask is 0x3 in all releases except Release 7.0(0), where it is 0x20003.
If the trace mask has a high value (0xf or higher), there is a large impact on CTIOS server performance and call completion rate. Set the trace mask at a high value only when you are
debugging a problem; once you have collected the needed logs, you must set the trace mask back to its default value.
For troubleshooting purposes, set the CTIOS server trace mask to:
3 of 10 10-Jan-15 09:59 PM
UCCE Trace Settings and Log Collection - Tech Zone https://techzone.cisco.com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
Refer to How to Use the Dumplog Utility for additional details. Use the cdlog command in order to get to the logfiles directory, as shown in this example:
These examples show how to place output in the default file; in all cases, you can use in order to define a specific name for the output file:
SIP
This procedure describes how to enable tracing on CVP servers with Cisco SIP IP Phone software:
1. On the call server(s), go to the CVP diag tool (http://localhost(CallServer):8000/cvp/diag) in order to get the Session Initiation Protocol (SIP) stack.
3. Click Set.
4. Click DEBUG/41.
H323
This procedure describes how to enable tracing on CVP servers with an H323 gateway:
setcalltrace on
setinterfacetrace on
Collect the CVP *.log file and Error.log files for the time of the test period. These files are in the C:\Cisco\CVP\logs directory on both CVP servers.
These are the locations of the log files for Unified CVP, where CVP_HOME is the directory in which the Unified CVP software is installed.
4 of 10 10-Jan-15 09:59 PM
UCCE Trace Settings and Log Collection - Tech Zone https://techzone.cisco.com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
For custom voice XML applications such as a deployed Audium application, you can turn on a debug logger.
Add this line to the <loggers> section (the last section) of the settings.xml configuration file in the C:\Cisco\CVP\VXMLServer\applications\APP_NAME\data\application\ directory:
<logger_instance name="MyDebugLogger"
class="com.audium.logger.application.debug.ApplicationDebugLogger"/>
At runtime, this logger outputs a detailed VoiceXML log to the \Cisco\CVP\VXMLServer\applications\APP_NAME\MyDebuggerLogger directory.
Note: You can change the name of the logger in the settings.xml configuration file from MyDebugLogger to any name you choose.
This procedure describes how to increase the badialer process logs on the Outbound Dialer (which is usually found on a PG).
1. Ensure EMSDisplaytoScreen = 0.
3. Set:
EMSTraceMask = 0xff
EMSUserData = ff ff (four f's in binary mode)
5. Set DebugDumpAllEvents = 1.
Pull Logs
On the Importer
1. Use the registry editor in order to edit HKEY_LOCAL_MACHINE\SOFTWARE\Cisco Systems, Inc.\ICM\<instance>\LoggerA\EMS\CurrentVersion\Library\Processes\ baImport.
2. Set:
EMSTraceMask = 0xff
EMSUserData = ff ff (four f's in binary mode)
On the Campaignmanager
2. Set:
EMSTraceMask = 0xff
EMSUserData = ff ff (four f's in binary mode)
On the Avaya Communications Manager (ACD) PG, use the opctest utility in order to increase the following for both CallManager and Avaya.
This procedure describes how to increase the tracing for the ctisvr process.
2. Set EMSTraceMask = f8. You can leave the value at f0 if you want.
3. Click Connect.
agentchanges
routerequests
scriptselects
networkvrutracing
translationroute
callqueuing
calltyperealtime
5 of 10 10-Jan-15 09:59 PM
UCCE Trace Settings and Log Collection - Tech Zone https://techzone.cisco.com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
5. Click Apply.
For opctest Release 8.5, use the Diagnostic Framework Portico instead.
Use the dumplog utility in order to pull router logs from either router for the time period of the tests. Refer to How to Use the Dumplog Utility for additional details.
This is an example of a log request for logs on 10/21/2011 between 09:00:00 and 09:30:00 (in 24-hour time format). This output goes to the file C:/router_output.txt:
#conf t
service timestamps debug datetime msec
service timestamps log datetime msec
service sequence-numbers
no logging console
no logging monitor
logging buffered 5000000 7
end
clear logging
Note: Any change on a production Cisco IOS® software GW might cause an outage.
This is a very robust platform that can handle the suggested debugs at the provided call volume without issue. However, Cisco recommends that you:
Apply the debug commands one at a time, and check the CPU utilization after each one:
Note: If the CPU gets up to 70-80% CPU utilization, the risk of a performance-related service impact is greatly increased. Thus, do not enable additional debugs if the GW hits
60%.
After you make the call and simulate the issue, stop the debugging:
#undebug all
term len 0
show ver
show run
show log
CUSP Tracing
These commands turn on SIP tracing on the Cisco Unified SIP Proxy (CUSP):
(cusp)> config
(cusp-config)> sip logging
(cusp)> trace enable
(cusp)> trace level debug component sip-wire
6 of 10 10-Jan-15 09:59 PM
UCCE Trace Settings and Log Collection - Tech Zone https://techzone.cisco.com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
3. FTP to the CUSP IP address. Use the username (test) and password as defined in the previous step.
This procedure describes how to start problem analysis and how to determine what tracing to enable. The example gathers logs from these servers:
ROUTER-A/ROUTER-B
LOGGER-A/LOGGER-B
PGXA/PGXB
All CVP Call Servers
All CVP VXML/Media Servers (if present)
1. On each system in the list, open Unified System CLI on each server, and execute this command:
Replace the first string with a date and time that is approximately 15 minutes before the event.
Replace the second string with a date and time that is approximately 15 minutes after the event is resolved. If the event is still occurring, gather at least 15
minutes.
This produces a file named clioutputX.zip, where X is the next number in sequence.
2. Export each system's Windows Application/Security/System logs in comma-separated values (CSV) format, and save to the C:\Temp directory.
3. Add the Windows CSV logs to the zip from step 1, and rename the zip file in this format:
<SERVERNAME>-SystCLILogs-EvntOn-YYYYMMDD_HHMMSS.zip
4. On any agent PG, collect the logs in the directory C:\Program Files\Cisco\Desktop\logs every time the failure is seen. Zip the logs into a file with a name in this format:
<SERVERNAME>-CADLogs-EvntOn-YYYYMMDD_HHMMSS.zip
If you are using CAD-Browser Edition (CAD-BE) or any CAD web products, gather the logs from the C:\Program Files\Cisco\Desktop\Tomcat\logs directory, and add them to the same
zip file.
If you are running on any of the Windows 2008 x64 products, the log directory is under C:\Program Files (x86)\Cisco\Desktop\...
5. Attach these files to the service request, or upload the files to FTP if they are too large to email or attach.
CLI Example
Note: You are warned that these actions might impact the system, so you may want to do this work during off hours or during a slow time.
There are two tools: a Diagnostic Framework tool and the system CLI tool. Both are icons either on the desktop or under the Programs directory on each server.
This procedure describes how to use the Unified System CLI for tracing.
1. Click the Unified System CLI icon, then log in with the domain and the username. (In this example, the domain administrator has logged in before, so the CLI already knows the
domain (JecodyEntLab) and user name (Jcody).
7 of 10 10-Jan-15 09:59 PM
UCCE Trace Settings and Log Collection - Tech Zone https://techzone.cisco.com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
3. Enter the instance name; in this example, it is v802. Look on the PG at one of the services; the instance name is the first part of the service name.
4. A simple way to find the instance name is to look at the services that are running on the server.
1. Replace the first string with a date and time that is approximately 15 minutes before the event.
2. Replace the second string with a date and time that is approximately 15 minutes after the event is resolved.
4. This produces a file named clioutput .zip, where is the next number in sequence.
8 of 10 10-Jan-15 09:59 PM
UCCE Trace Settings and Log Collection - Tech Zone https://techzone.cisco.com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
6. Once the process completes, look for the clioutput .zip file in the directory:
Note: This file is typically very large because it contains all UCCE-related files for all the services on this server.
7. If you need only one log, you may find it easier to use the older dumplog utility or to use the Diagnostic Framework Portico:
Troubleshooting Methodology
UCCE Trace Settings
Data Analysis
Common Problems
UCCE Trace Setting
FAQ
9 of 10 10-Jan-15 09:59 PM
UCCE Trace Settings and Log Collection - Tech Zone https://techzone.cisco.com/t5/tkb/articleprintpage/tkb-id/ucc_ucce_other@tkb/article-id/63
10 of 10 10-Jan-15 09:59 PM