This document describes the dumplog utility, which allows you to view Cisco Intelligent Contact Management (ICM) process logs.
Cisco recommends that you have knowledge of these topics:
- How to troubleshoot software issues
- Cisco ICM
The information in this document is based on the Cisco ICM.
The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, ensure that you understand the potential impact of any command.
What Does the Dumplog Utility Do?
The dumplog utility converts binary log files written by Cisco ICM processes into readable format. Once converted, the log file contents can be referenced in order to gain insight into the ICM operation. Typically, dumplog is used as a tool to troubleshoot, but it can be educational as well.
The dumplog utility can be invoked from either a command prompt directly on the ICM server, or from a Telnet session to the ICM server.
Note: The next examples assume that ICM is installed on the C drive. If the ICM is installed on a different drive, then directory locations are changed accordingly.
For server name conventions used in this document, see ICM Server Name Conventions.
How to Get to the Logfile Directory
The path to the Cisco ICM logfile directory is <root>\icm\customer instance name\node name, where <root> is the drive where ICM is installed, for example, C, D, or E.
For example, if you consider that Cisco ICM Call Router is installed on the C drive, the logfile directory on geocscortra would be located at: c:\icm\csco\rtra\logfiles.
Note: This can be used as a shortcut to the logfiles directory: c:\>cdlog <cust_inst> <ICM_Node>.
Command-line options for the dumplog utility are shown in this section. They can help you solve problems since they allow you to view Cisco ICM log files within a specific time period. The time period is definable with the /bd, /bt, /ed, and /et switches. The user can also search for a specific string in order to further isolate and troubleshoot questionable ICM behavior.
This information can also be found in the Cisco Intelligent Call Router Administrator Guide.
dumplog [ProcessName(s)] [/dir Dirs] [/if InputFile] [/o]
[/c] [/bd BeginDate(mm/dd/yyyy)] [/bt BeginTime(hh:mm:ss)]
[/ed EndDate(mm/dd/yyyy)] [/et EndTime(hh:mm:ss)] [/hr HoursBack]
[/all] [/last] [/prev] [bin] [/m MatchString] [/x ExcludeString] [/ms] [/debug]
[/unzipCmdPrefix Prefix for Unzip command]
[/unzipCmdInfix Infix for Unzip command]
[/unzipCmdPostfix Postfix for Unzip command]
[/unzipTempfile Temporary filename for unzip command]
[/zipPostfix Postfix of zipped files]
||The command dumps the current day log for this process, unless you specify different dates or times with other arguments.
||Directory specifies the location of the log files for any processes listed on the command line after the /dir switch. If no /dir switch is used, the current directory is used by default.
||InputFile specifies a specific .ems file to dump. The /if token is optional. If you specify an input file, the /bd, /bt, /ed, /et, /hr, and /all arguments are ignored.
||Writes output to a text file in the \logfiles directory. The filename is formed when you add the .txt suffix to the specified process prefix or input file name (without the .ems suffix). The file is written to the current directory.
||OutputFile specifies an output text file; for example, c:\temp\mylog.txt.
||Specifies continuous output. The command does not exit after it reaches the end of the log. Instead, it waits and writes any further entries that appear in the log.
||BeginDate(mm/dd/yyyy) specifies the begin date. If used with /bt, this specifies a range of dates. Otherwise, dumplog dumps events for only the specified date.
||BeginTime(hh:mm:ss) specifies the begin time. Use with /et in order to specify a range of time.
||EndDate(mm/dd/yyyy) specifies the end date. Use with /bd in order to specify a range of days.
||EndTime(hh:mm:ss) specifies the end time. Use with /bt in order to specify a range of time.
||HoursBack specifies a number of hours back from the current time.
||Displays all information from the specified process log files.
||Displays information from the most recent log file for the process.
||Displays information from the next to last log file for the process.
||MatchString displays only events that contain a match for the specified string.
||ExcludeString displays only events that do not contain a match for the specified string.
||Displays milliseconds in time stamps.
||Use multiple colors when you dump merged logs. Each process is given a different color. You must specify either a ProcessPrefix or an InputFile. If you give only a ProcessPrefix value (for example, rtr, nm, or lgr), dumplog displays the current day log for that process by default.
||Enables the CiscoLog functionality.
||Prefix parameters for unzip, for example gzip -d -c.
||Infix parameter for unzip, for example ">".
||Postfix parameter for unzip, for example "".
||Temp file for unzip, for example "temp.ems".
||File postfix parameter, for example ".gz".
||When the EMS files are copied to a system in a different timezone, or if the timezone on the system is changed, without this option, all the queries made are relative to the machine on which the logfiles were generated. Otherwise, /tzadjustoff is used in order to switch the behavior where queries are made with respect to this machine time.
Note: In order to view redirected log files with Microsoft Notepad, save the log file to a text file (use the dumplog /of argument), and open the text file from the command prompt with the notepad filename command.
Sample Dumplog Usage
This example shows how to dump the rtr log file on the router from April 29, 1999 until April 30, 1999. It outputs to a log file called rtr.txt. The file rtr.txt can now be viewed with a standard text editor such as Notepad.
c:\icm\csco\rtra\logfiles dumplog rtr /bd 04/29/1999 /ed 04/30/1999 /o
This command dumps the pgag log file from a peripheral gateway (PG) begin at the last time a new log file was open for output.
c:\icm\csco\rtra\logfiles dumplog pgag /last
This command dumps logs from several processes in the interlaced manner and writes the output into a single output file.
dumplog /ms /hr 1 /of output.txt rtr mds rts
14:51:40:298 ra-rts Trace: Received 1 System Capacity Real Time records
14:51:40:298 ra-rts Trace: Updating base System Capacity Real Time record for ID1 1 and ID2 0, cbRecSize=96
14:51:43:298 ra-rtr Trace: TIP: TIPUpLink::sendCongestionControlTIPMsg Sent CongestionControlEvent
14:51:46:298 ra-rtr Trace: TIP: TIPUpLink::sendCongestionControlTIPMsg Sent CongestionControlEvent
14:51:49:298 ra-rtr Trace: TIP: TIPUpLink::sendCongestionControlTIPMsg Sent CongestionControlEvent
14:51:49:688 ra-mds MDS Process is reporting periodic overall metering statistics.
A syntax with hyphens is also supported.
dumplog -ms -hr 1 -of output.txt rtr mds rts