Serviceability Best Practices Guide for Cisco Unified ICM/Contact Center Enterprise, Release 10.0(1)
Unified ICM/Unified CC Trace Levels
Downloads: This chapterpdf (PDF - 1.32MB) The complete bookPDF (PDF - 6.12MB) | The complete bookePub (ePub - 2.36MB) | Feedback

Unified ICM/Unified CC Trace Levels

Contents

Unified ICM/Unified CC Trace Levels

Unified ICM and Unified Contact Center application utility tools provide centralized control for setting up each component trace level. You can also manually modify it from the registry key settings.

Unified ICM and Unified Contact Center application components write trace messages to trace log files on the local disk; these traces provide the following details about the operation of the component:

  • Error conditions (errors that may impair operation or performance are also reported in the Windows Event Log and sent via the syslog feed or, if sufficiently actionable, as SNMP notifications)
  • Debugging messages (to be used by troubleshooting engineers to diagnose problems)
  • Periodic performance metrics
  • Call state and/or call progress information
  • Configuration parameters or errors
  • Connectivity information (details about successful and failed connections)

The level of detail that is written to these trace logs can be controlled via numeric settings in the registry or via tools that interact directly with the application component to control tracing. The default settings (upon installation of the component) seek to balance performance with tracing detail with the scale tipped toward maximizing performance. Any increase in tracing levels has a corresponding adverse impact on performance (for example, agent capacity, IVR port capacity, inbound call load capacity) as additional computing resources are then consumed by the resulting disk I/O.

The amount of tracing that is stored on the local disk is controlled by the tracing infrastructure; a sliding (fixed size) window of tracing is maintained whereby the oldest data is deleted to make room for the newest data. You can control the size of this window by carefully editing parameters in the Windows registry. The tracing window size is represented in bytes (disk consumption), not by a time duration.

Routine capacity utilization measurements indicate the amount of computing resources that are available for added diagnostics (for more information, see Capacity Planning). If the deployment is already at high utilization, you must take care to understand the impact of enabling additional tracing to ensure that doing so does not adversely impact normal operation.

Before enabling additional tracing, monitor the Health Monitoring Performance Counters while the tracing change is in effect to ensure that the server is not exceeding maximum thresholds. For more information, see Platform Health Monitoring Counters.

What follows are the trace settings you must configure when you initially engage in diagnosing a problem. TAC may suggest some differences based upon their initial impressions of the problem symptoms. These are proposed for those who wish to take a quick, proactive approach in getting the trace levels up as quickly as possible to gather as much useful information as soon as possible.

Remember that TAC or BU engineers very likely may come back with additional settings based upon their initial log analysis.

Do not set what you believe to be maximum tracing – doing so could cause more problems than you had initially or even mask the problem by significantly changing timing.

Trace levels

Support personnel who debug the Unified Communication solution need not know the details of trace levels across Unified Communication solution applications. If debugging a problem requires more detailed debug information, three levels of trace setting exist that can map internally to a particular application or application component. The intent is not to revamp existing trace setting values but to map the levels to the relevant and existing trace settings for a particular component. Use the following defined trace levels with the Diagnostic Framework Portico (see Accessing the Diagnostic Framework through the Unified System CLI) and the Unified System CLI tools (see Accessing the Diagnostic Framework through the Unified System CLI).

The following trace levels are defined for the Unified Communication solution:

Trace Level

Trace Value

Description

Default

0

Default install, should have no or minimal performance impact

Warning

1

Log more detailed (plus default level) trace messages, small performance impact

Error

2

Log more detailed (plus warning/default level) trace messages, medium performance impact

Debug

3

Log most detailed (plus error/warning/default level) trace messages, high performance impact.

If the trace level does not match any of the defined levels, it displays custom (99).

Most EMSTraceMasks are based on this registry key: HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\<Instance>\<Component>\EMS\CurrentVersion\Library\Processes\<process>\EMSTraceMask

Get/set trace level and collect trace files are supported only for the following processes.


Note


If the trace mask is the same for multiple levels, the GetTraceLevel returns the highest level. For example, GetTraceLevel returns Level 3 for Logger/baimport.

Trace–All Nodes

Process

Level 0

(Default - Error)

Level 1

(Warning)

Level 2

(Informational)

Level 3

(Debug)

NM

0x00

0x0F

0x0F

0xFF

NMM

0x00

0x0F

0x0F

0xFF

The Diagnostic Framework does not support the Administrator Workstation.

Trace–Administration and Data Server (previously known as the Distributor Administrator Workstation)

Process

Level 0

(Default - Error)

Level 1

(Warning)

Level 2

(Informational)

Level 3

(Debug)

CONFIGLOGGER

0x00

0x0F

0xFF

0xFFF

CMSNODE

0x00

0x00

0x00

0xFFFFFFFF

CMS_JSERVER

0x00

0x00

0x00

0xFFFFFFFF

REPLICATION

0x00

0x0F

0xFF

0xFFF

RTCLIENT

0x00

0x0F

0xFF

0xFFF

RTDIST

0x00

0x0F

0xFF

0xFFF

UPDATEAW

0x00

0x0F

0xFF

0xFFF

ISEMAN

0x00

0x00

0x00

0x01

Trace–Router

Process

Level 0

(Default - Error)

Level 1

(Warning)

Level 2

(Informational)

Level 3

(Debug)

Notes

APPGW

0x00

0x01

0x07

0x3F

 

CCAGENT

0x00

0x03

0x0F

0xFF

 

DBAGENT

0x00

0x01

0xFF

0xFF

 

DBWORKER

0x00

0x01

0xFF

0xFF

 

MDSPROC

0x00

0x07

0xFF

0xFF

 

ROUTER *

Turn off everything

Route Requests

- Network VRU

- Trans Route

- VRU Bank

- CIC Request

- Script Select

- Call Queuing

- Agent changes

- Call Type Real Time

Use RTRTRACE or RTRTEST

Note: If you restart the Router process, the settings return to the default level.

RTSVR

0x00

0x0F

0xFF

0xFFF

 

Trace–Logger

Process

Level 0

(Default - Error)

Level 1

(Warning)

Level 2

(Informational)

Level 3(Debug)

BAIMPORT

0xFF

EMSUserData = 0xFFFF

0xFF

EMSUserData = 0xFFFF

0xFF

EMSUserData = 0xFFFF

0xFF

EMSUserData = 0xFFFF

CAMPAIGN MANAGER

0xFF

EMSUserData = 0xFFFF

0xFF

EMSUserData = 0xFFFF

0xFF

EMSUserData = 0xFFFF

0xFF

EMSUserData = 0xFFFF

CONFIGLOGGER

0x00

0x0F

0xFF

0xFFF

CSFS

0x00

0x00

0x00

0xFF

CW2KFEED

0x00

0x00

0x00

0x07

DTP

0x00

0x04

0x06

0x0F

HISTLOGGER

0x00

0x0F

0xFFF

0xFFF

RECOVERY

0x00

0x0F

0xFFF

0xFFF

REPLICATION

0x00

0x0F

0xFFF

0xFFF

Trace–Peripheral Gateway

Process

Level 0

(Default - Error)

Level 1

(Warning)

Level 2

(Informational)

Level 3

(Debug)

JTAPIGW *

JT_JTAPI_EVENT_ USED

JT_TPREQUESTS

JT_PIM_EVENT

JT_ROUTE_ MESSAGE

JT_CONNECTION *CONF*

JT_JTAPI* JT_HEX JT_ROUTE* JT_TERM* JT_LOW*

JT*

MDSPROC

0x00

0x07

0x0F

0xFF

MSGIS

0x00

0x00

0x00

0x3F

OPC **

default, cstacerEMSTraceMask = 0x40

agent, inrcmsg, closedcalls, tpmsg, routing EMSTraceMask = 0x40 Note: Remove "default" tracing set in Default(0) level, but include cstacer.

calls, NCT, simplified EMSTraceMask = 0x40Note:Remove "default" tracing set in Default(0) level, but include Level 1.

Missingdata, halfhour EMSTraceMask = 0x40Note: Remove "default" tracing set in Default(0) level, but include Level 2.

PGAGENT

0x00

0x03

0x0F

0xFF

EAGTPIM *

tp*  precall  *event  csta* call_object teld_agent_state opcrequest

periph* jtapi_dialed*

autoconfig* teld* call_match_timing timer*

lock* universal* service* threadid jtapi*

VRUPIM

EMSTraceMask= 0x0

EMSUserData= 0x71f7e0

EMSTraceMask= 0x0

EMSUserData= 0x71f7e0

00000000000000000000

00000000000000000000

00000000000000000000

000000000180

EMSTraceMask= 0x0

EMSUserData= 0x71f7e0

00000000000000000000

00000000000000000000

00000000000000000000

000000000180

EMSTraceMask= 0x0EMSUserData= 0xf1fff0

0000000000000000000

0000000000000000000

0000000000000000000

000000000000180

ACMIPIM

EMSUserData = (hex) 01, 7f, 46, 00, 00, 00, 00, 00, 00, 00, 00, 01, 00, 00, 00, 00, 00, 3f, ff, ff, ff, 67, cf, d7, fd, ef, ff, ff, ff, ff, ff, ff, ff, ff, ff, ff, f0, fa

For reference, this is the default + all_peripherals

EMSUserData = (hex) f5, 7f, 46, 00, 00, 00, 00, 00, 00, 00, 00, 01, 00, 00, 00, 00, 00, 3f, ff, ff, ff, 67, cf, d7, fd, ef, ff, ff, ff, ff, ff, ff, ff, ff, ff, ff, f0, fa

For reference this is level 0 + timer events

EMSUserData = (hex) f5, 7f, c6, 00, 00, 00, 00, 00, 00, 00, 00, 01, 00, 00, 00, 00, 00, 3f, ff, ff, ff, 67, cf, d7, fd, ef, ff, ff, ff, ff, ff, ff, ff, ff, ff, ff, f0, fa

For reference this is level 1 + Monitor Item traversal

EMSUserData = (hex) f5, 7f, f6, 00, 00, 00, 00, 01, ff, ff, fe, c1, 00, 00, 00, 00, 00, 3f, ff, ff, ff, 67, cf, df, fd, ef, ff, ff, ff, ff, ff, ff, ff, ff, ff, ff, ff, fe

For reference this is level 2 + locks + socket data

MRPIM

EMSUserData = 0x00

Procmon:

> trace mr* /off

EMSUserData = 0x40

Procmon:

> trace mr* /off

> trace mr_msg_comm_session /on

EMSUserData = 0x58

Procmon:

> trace mr* /off

> trace mr_msg_comm_session /on

> trace mr_*_mr /on

EMSUserData = 0x5F

Procmon:

> trace mr* /off

> trace mr_msg_comm_session /on

> trace mr_*_mr /on

> trace mr_*_inrc /on

> trace mr_*_csta /on

CTISRVR

0x000000f0

0x000000f6

0x000000fe

0x000000ff

CTIOS SERVER NODE

0x00060A0F

0x00240A2F

0x00260A2F

0x002E0A2F

BADIALER

EMSTraceMask= 0x0000001fEMSUserData= 0xFFFF

EMSTraceMask= 0x0000003fEMSUserData= 0xFFFF

EMSTraceMask= 0x0000007fEMSUserData= 0xFFFF

EMSTraceMask= 0x000000ffEMSUserData= 0xFFFF

Trace–Web Setup

Process

Level 0

(Default - Error)

Level 1

(Warning)

Level 2

(Informational)

Level 3

(Debug)

Web Setup

EMERGENCY

CRITICAL

WARNING

DEBUG

Websetup uses log4j.net for logging. Websetup uses a XML file (log4j.xml) through which you can set the trace levels. The XML file also contains other information you require for logging.

You can find the log4j.xml file here: <InstallDrive>:\icm\tomcat\webapps\setup\WEB-INF\classes\log4j.xml

Trace–Diagnostic Framework

Process

Level 0

(Default - Error)

Level 1

(Warning)

Level 2

(Informational)

Level 3

(Debug)

Notes

Diagnostic Framework

Info

Info

Info

Debug

 

When the Diagnostic Framework receives a request for its own trace level, if the trace level is at Info, Level 2 is returned. When the Diagnostic Framework receives a request to be set for Level 0, Level 1, or Level 2, the trace level is set to Info.

EMS Log Compression

To collect logs that span a greater period of time, EMS log files from the CTI OS Server and the following PG components are zipped:
  • CTI OS Server
  • OPC-CCE
  • OPC-TDM
  • CTISVR
  • EAGTPIM
  • JTAPIGATEWAY
  • VRUPIM

Note


These are the only components that currently support EMS log compression.

Dumplog

Dumplog handles the compressed EMS files and can be used in the normal way.  Dumplog looks for gzip.exe in <Install Drive>\icm\bin to unzip compressed EMS files before dumping logs.  If you must dump logs from compressed EMS files (with .gz extension) outside of a PG or CTI OS Server, the EMS files can be unzipped before using dumplog. 

EMS File Compression Control

To enable or disable compression of EMS log files, the EMSZipCompressionEnabled registry key in \EMS\CurrentVersion\Library\Processes\<process name> is used. Do not modify this registry key.  This key takes effect only on components that support EMS file compression.

Other registry keys

The following two other registry keys are also available in …\EMS\CurrentVersion\Library\Processes\<node name>

  • EMSZipFormat
  • EMSZipExtension

Note


Do not modify these registry keys.

Set Router Tracing

To set the Unified ICM/CCE Router, use the Router Trace utility. This is a single-form Windows GUI utility that is loaded on the Unified ICM/Unified CCE server.


Note


The router process must be running before you set router tracing or attempt to retrieve router traces. This applies to any tool which sets or retrieves router tracing, including, for example, RTTEST, RTRTRACE, and System CLI. (The router process must be running because the router trace settings are only stored in memory.)

All trace settings using "RTRTRACE" take effect immediately in the Router.

You can observe specific status of call routing, call type, skill group and schedule target variables using the following RTTEST command: rttest /cust <instance>

Also, the RTTEST "watch" command is very useful.

Procedure
    Step 1   Connect to server through remote desktop or go to local console.
    Step 2   Run command C:> \icm\bin\rtrtrace to invoke RTRTRACE from ICM\BIN
    Figure 1. Router Trace Utility



    Step 3   Set trace options.

    When a call routing failure occurs, the basic traces should at the minimum be "Route Requests" and "Translation Route" if translation routing is used.

    Additionally, the other tracing should be enabled depending on the specific problems seen.

    For... Enable...
    Any type of VRU Network VRU Tracing
    NAM-CICM (Hosted) CICR Requests
    Suspected queuing issues Call Queuing
    Call type reporting problems Call Type Real Time
    Agent issues Agent Changes

    How to Set OPC Tracing

    To set Unified ICM/Unified CCE OPC tracing, use the OPCTEST utility. This is a command-line utility and you require remote desktop or local console access.

    Command Syntax (launch):

    C:> opctest /cust <instance> /node <node>

    Where <instance> is the Unified ICM/Unified CCE instance name and <node> is the desired node name (for example, /cust cust1 /node PG1A).

    After you invoke the instance name, you are presented with an opctest: prompt where you can enter commands according to the syntax expected. To display all commands, enter a "?" at the opctest: prompt. However, OPCTEST is a powerful utility and if you use it incorrectly, it can have a negative effect on a production system in operation. Do not execute a command against a production system unless you are absolutely certain of the impact it can introduce.

    Use the following commands to alter default trace levels. Before using the commands, understand your current utilization to ensure there is sufficient capacity to accommodate the added tracing.

    General Diagnostics

    opctest:debug /on

    Diagnosing Network Transfer Issues

    opctest:debug /on
    opctest:debug /NCT

    Diagnosing Multi Media Issues

    opctest:debug /on
    opctest:debug /task /passthru

    Diagnosing VRU PG Issues

    opctest:debug /on

    opctest:debug /passthru

    The default is:

    opctest:debug /routing /agent /closedcalls /cstacer /rcmsg /tpmsg /simplified /inrcmsg

    and

    EMSTracemask = 0x40

    EMSTracemask is reset in the Windows registry.

    TAC directs you to alter or add additional tracing based upon the analysis of collected logs.

    How to Restore Default Trace Levels

    opctest:debug /on

    This parameter turns on the /default tracing, modifies the EMSTracemask to 0x40, and turns off all other enabled tracing.

    How to Display Trace Levels

    opctest:debug /showtrace

    This parameter displays current trace levels enabled on the peripheral.

    How to Set Unified CCM PIM Tracing

    To reset trace levels with the Unified Communications Manager Peripheral Interface Manager component (for example, "EAGTPIM"), use the ProcMon (process monitoring) utility. This is a command-line utility and you require remote desktop or local console access.

    Table 1 Setting Unified CCM PIM Tracing

    Command Syntax (launch)

    C:> ProcMon <instance> <node> pim<pim number>

    Example

    C:> ProcMon acme PG1A pim1

    Commands

    >>>debug /on

    How to Set JTAPI Gateway Tracing

    To reset trace levels for the Unified Contact Center JTAPI (Java Telephony Applications Programming Interface) Gateway component (for example, "JTAPIGW"), use the ProcMon (process monitoring) utility. This is a command-line utility and you require remote desktop or local console access.

    Table 2 Setting JTAPI Gateway Tracing

    Command Syntax (launch)

    C:> ProcMon <instance> <node> jgw<jtapigw number>

    Example

    C:> ProcMon acme PG1A jgw1

    Commands

    >>>trace * /off

    >>>debug /on

    How to Set JTAPI Gateway Default Tracing

    The default tracing for JTAPI gateway consists of a set of tracing levels that currently exist.

    To enable only the default tracing, enter the following commands in ProcMon:

    trace * /off

    Note: debug /on does not turn off non-default tracing so you need this first.

    debug /on This enables only default tracing.

    To turn off debug tracing, enter the following command in ProcMon:

    debug /off This turns off only default tracing. All other tracing is not affected.

    How to Set CTI Server Tracing

    To reset trace levels with the Unified ICM/Unified CCE CTI Server (for example, CTI Gateway or CG), use the Microsoft Registry Editor (regedit) to modify the trace mask saved in the Windows registry.

    Table 3 Setting CTI Server Tracing

    Registry Key

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\<instance>\<CG#A/B>\EMS\CurrentVersion\Library\Processes\ctisvr

    Example

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\acme\CG1A\EMS\CurrentVersion\Library\Processes\ctisvr

    Item

    EMSTraceMask

    Value

    F0 (hex)

    This is the default value. The value of F0 provides sufficient tracing information to troubleshoot most issues.

    Setting CTI Server Default Tracing

    The default tracing level for CTI Server is EMSTraceMask = 0xF0.  Do not enable any other tracing at the default trace level. EMSUserData should be NULL.

    ProcMon debug commands:

    debug /on sets the EMSTraceMask to the default value of 0xF0 and NULL out EMSUserData.  No other command is needed to set default tracing.

    debug /off sets EMSTraceMask to 0x00 and NULL out EMSUserData.

    Setting CTI OS Tracing

    Resetting trace levels with the Unified ICM/Unified CCE Cisco Computer Telephony Integration Option (CTI OS) is accomplished by altering the trace mask saved in the Windows registry. Use the Windows REGEDIT utility to change this numeric value.

    Table 4 Setting CTI Server Tracing

    Registry Key

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\<instance>\CTIOS\EMS\CurrentVersion\Library\Processes\ctios

    Example

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\acme\CTIOS\EMS\CurrentVersion\Library\Processes\ctios

    Item

    EMSTraceMask

    Value

    60A0F (hex)

    Increasing the trace levels (other than the Default 0x00060A0F) impacts the CTI OS Server performance. You must revert High Tracemask to the default trace levels after collecting the required logs.

    Levels

    Level 0:   0x00060A0F

    Level 1: 0x00240A2F

    Level 2: 0x00260A2F

    Level 3: 0x002E0A2F

    Setting VRU PIM Tracing

    Resetting trace levels with the Unified ICM/Unified CCE VRU Peripheral Interface Manager (PIM) is accomplishing by altering the trace mask and user data values saved in the Windows registry. Use the Windows REGEDIT utility to change these numeric values.

    Table 5 Setting VRU PIM Tracing

    Registry Key

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\<instance>\PG<PG number><A or B>\EMS\CurrentVersion\Library\Processes\pim<pim number>

    Example

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\acme\PG2A\EMS\CurrentVersion\Library\Processes\pim1

    Item

    EMSUserData

    Value

    7F F7 E0 (hex)

    Item

    EMSTraceMask

    Value

    0 (zero)

    When you collect the trace logs, collect both VRU PIM trace logs and the VRU trace capture file. To obtain VRU trace capture files, run the VRUTRACE tool in the following directory:

    \icm\<inst>\<pg><pg number><a or b>\vrucap

    For example: \icm\acme\pg2a\vrucap

    Setting VRU PIM Default Tracing

    The default tracing for VRU PIM consists of a set of tracing levels that currently exist.

    ProcMon debug commands:

    debug /off turns off all tracing

    debug /on enables default tracing only and turns off any previously enabled tracing

    Setting Outbound Option Tracing

    The utility tools provide centralized control to set up each component trace level. Additionally, you can manually modify the registry key values.

    How to Reset CampaignManager Tracing

    To reset CampaignManager trace levels, use the Microsoft Registry Editor (regedit) to modify the trace mask saved in the Windows registry.

    Registry Key:

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\<instance>\LoggerA\EMS\CurrentVersion\Library\Processes\CampaignManager

    Example:

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\m3pc1\LoggerA\EMS\CurrentVersion\Library\Processes\CampaignManager

    How to Reset baImport Tracing

    To reset baImport trace levels, use the Microsoft Registry Editor (regedit) to modify the trace mask saved in the Windows registry.

    Registry Key:

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\<instance>\LoggerA\EMS\CurrentVersion\Library\Processes\baImport

    Example:

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\m3pc1\LoggerA\EMS\CurrentVersion\Library\Processes\baImport

    How to Reset Dialer Tracing

    To reset Dialer trace levels, use the Microsoft Registry Editor (regedit) to modify the trace mask saved in the Windows registry.

    Registry Key:

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\<instance>\Dialer\EMS\CurrentVersion\Library\Processes\baDialer

    Example:

    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\m3pc1\Dialer\EMS\CurrentVersion\Library\Processes\baDialer

    Trace File Retention Settings

    You can modify several Windows registry values to adjust the trace log retention parameters, for example, increase the amount of trace data – extend the trace retention window. To modify the trace log parameters, use the Microsoft Registry Editor (regedit).

    Unified ICM/Unified CCE Event Management System (EMS) tracing is stored in a binary format in a set of files in a directory on the local drive following a specific structure.
    Trace log file location
    [Drive]:\icm\<instance>\<node>\logfiles
    Example
    C:\icm\acme\pg1a\logfiles
    Trace log file names
    Process_YYMMDD_HHMMSS.ems
    Example
    opc_090713_123025.ems

    This is an OPC trace log file that was created 13 July, 2009 at 12:30:25.

    Under the control of the Event Management System, the following rules apply while traces are written to the trace log files:
    • If the size of this file is greater than or equal to the maximum (configured) size that a single EMS trace log file is allowed, the file is closed and a new file is created.
    • If the maximum number of trace log files for this process is greater than the maximum (configured) number of trace log files, then the oldest trace log file is deleted.
    • If the total combined size of all process trace log files is greater than or equal to the maximum (configured) total size of all process trace log files, then the oldest trace log files are deleted until the total size is less than the configured maximum size.

    Registry Items

    You can change the following registry item values to increase or decrease the amount of disk space allocated for a single process.

    Registry key
    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\<instance>\<node>\EMS\CurrentVersion\ Library\Processes\<process>
    Example
    HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\acme\PG1A\EMS\CurrentVersion\Library\ Processes\opc
    Items
    EMSLogFileMax

    The maximum size, in bytes, of a single trace log file for this process.

    EMSLogFileCountMax

    The maximum number of trace log files permitted for this process.

    EMSAllLogFilesMax

    The total space allowed for all trace log files (combined size) for this process.


    Note


    EMSLogFileMax multiplied by EMSLogFileCountMax may be greater than EMSAllLogFilesMax and it often is by default; this is to ensure trace log files created by frequent process restarts (where a number of small trace log files are created) are not lost when the max count is exceeded but very little disk space is used. EMSAllLogFilesMax is used to guarantee that under any circumstances, the maximum amount of disk space allocated is never exceeded.


    The default values of these items are evaluated with every release of the Unified ICM/Unified CCE to determine the optimal limits based on disk usage of the application and typical disk capacity of servers available at the time of release. In nearly all cases, the default values are increased over time as disk drive sizes increase.

    Router full dump enabled by default

    In Release 10.0(1), router full dump is enabled by default. This change to the default setting is intended to provide more information to help troubleshoot the issue if a critical process crashes.

    The registry key that sets this default is EMSGenerateSmallMemoryDump, which is located here: HKLM\SOFTWARE\Cisco Systems, Inc.\ICM\<instanceID>\RouterA\EMS\CurrentVersion\Library\Processes\rtr.

    The value of 0x20000032 for this registry key indicates a router full dump will be generated. To generate a mini-dump rather than a full dump, change the last digit to 1 so that the value is 0x20000031.

    The middle six digits of the registry key value determine the number of dumps that are kept. If, for example, these digits are all zeros (0x20000002), CCE by default keeps only the last five generated dumps for any component. For the CCE router, however, only the three latest dumps are kept (0x20000032) by default, since the size of the full dump can be up to 2GB. Keep disk space usage in mind when selecting the number of dumps you want to retain.

    If the CCE Router crashes, provide the full dump (the .mdmp file generated under the icm\<instanceid>ra\logfiles directory), the PDB file (for example, router.pdb) from the icm\bin directory, and the associated executable (router.exe) from the icm\bin directory.


    Note


    The registry key value is set to the default value of 0x20000032 on a new install or upgrade, or whenever you run Web Setup.