Administration Guide for the Cisco Unified Application Environment (2.4)
Maintaining the Cisco Unified Application Environment
Downloads: This chapterpdf (PDF - 193.0KB) The complete bookPDF (PDF - 1.64MB) | Feedback

Maintaining the Cisco Unified Application Environment

Table Of Contents

Maintaining the Cisco Unified Application Environment

Viewing Log Information

Viewing Statistical Information

Viewing Statistics

Viewing a Summary Graph of Time by Metric Type

Viewing a Summary Graph of All Metrics by Time

Troubleshooting

Backing Up the System

Restoring the System

Reinitializing the Server


Maintaining the Cisco Unified Application Environment


This chapter describes how to view log files and statistics, how to use log files for troubleshooting the Cisco Unified Application Server software, and how to reinitialize the server

This chapter includes these topics:

Viewing Log Information

Viewing Statistical Information

Troubleshooting

Backing Up the System

Restoring the System

Reinitializing the Server

Viewing Log Information

These management console logs provide diagnostic information:

Server Logs—Information about server activity.

Event Log—Information about system events (such as whether the H.323 stack is unavailable).

Audit Log—All Application Environment activity.

The Cisco Unified Application Environment supports log level filtering. The log level determines the amount of recorded detail about logged events (Table 5-1).

Table 5-1 Logging Levels 

Log Level
Description

Off

No logging

Error

Only error messages written to log

Warning

Only warning and error messages written to log

Information

Warning, error, and terse event information messages written to log

Verbose

Warning, error, and detailed event information messages to log


Each log file is assigned a unique name, which consists of a date code and identifier, as in this server log example: 20070423-10261650.log.

You can archive or delete server log folders from the list of server logs or individual log files from the individual server log pages.

This section includes these topics:

Viewing Server Logs

Archiving Server Log Folders or Files

Deleting Server Log Folder or File Contents

Viewing Event or Audit Logs

Viewing Server Logs

To view server logs, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Logs, click Server Logs.

Step 3 The Server Logs page opens.

Step 4 Click the underlined log name to display the list of log files for that server. Figure 5-1 shows an example excerpt from the AppServer log.

Figure 5-1 Server Log Files

Step 5 Click an underlined log file name to display the file contents. If the log list takes up multiple pages, use the links at the bottom of the page for navigation.

Archiving Server Log Folders or Files

To archive log folders or files, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Logs, click Server Logs.

Step 3 Select folders or files to archive:

To archive log folders, use the checkboxes to select one or more log folders, or choose Select All to select all of the log folders.

To archive log files, first click the underlined log name to open the log folder. Then use the checkboxes to select one or more log files, or choose Select All to select all of the log files.

Step 4 Click Archive Selected Logs.

The archive is created and a download page opens.

Step 5 Click Download Archive File or Download Log Archive download the files or folders to your computer.


Deleting Server Log Folder or File Contents

To delete log files or the contents of log folders, follow these steps:


Note When you delete a log folder, the entire folder and all contents are deleted, provided that the service that uses the folder is stopped. If the service is running when the folder delete occurs, the folder and the currently open log remain. The folder is automatically recreated when the first log is generated by the service.


Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Logs, click Server Logs.

Step 3 Select folders or files to delete:

To delete the contents of log folders, use the checkboxes to select one or more log folders, or choose Select All to select all of the log folders.

To delete log files, first click the underlined log name to open the log folder. Then use the checkboxes to select one or more log files, or choose Select All to select all of the log files.

Step 4 Click Delete Selected Logs.

The logs are deleted. There is no confirmation message.


Viewing Event or Audit Logs

To view event or audit logs, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Logs, click Event Log or Audit Log.

Step 3 The Event Log or Audit Log page opens. Figure 5-2 shows an example excerpt from the Event log.

Figure 5-2 Event Log

Step 4 To open the Details page for the event, click the underlined ID or Details link. If the log list takes up multiple pages, use the links at the bottom of the page for navigation.


Viewing Statistical Information

You can display graphical the following real-time, statistical information for various metrics in use by the server:

Application sessions (script instances)

Calls

Voice ports

RTP ports

Enhanced RTP ports

Conference port

Conference slots

Conferences

Text-to-speech ports

Use the Statistics page (Figure 5-3) to see how many concurrent instances of each resource type are being currently used or to generate graphs for:

Every preset time interval for a particular metric

Every metric for a preset interval

The graphs display the maximum amount recorded for the metrics on a per-sample basis. Metrics sampling occurs every 5 seconds, and each metrics sample is averaged during that 5-second period. For example, if two script instances are running at the start of one 5-second period, and midway through that period one script instance ends, the number recorded for that sample would be 1.5 script instances.

Each graph is an at-a-glance approximation of current usage of the Cisco Unified Application Environment.


Note For greater metrics granularity, use SNMP monitoring software. The Cisco Unified Application Environment sends SNMP traps and provides readable fields for all the metrics shown in the Statistics page.


Figure 5-3 Statistics Page

This section includes these topic:

Viewing Statistics

Viewing a Summary Graph of Time by Metric Type

Viewing a Summary Graph of All Metrics by Time

Viewing Statistics

To view how many concurrent instances of each resource type are being currently used, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click Statistics.

The list of concurrent instances of each resource type being currently used appears.


Viewing a Summary Graph of Time by Metric Type

To view every preset time (last hour, six hours, twelve hours, day, week, month, and year) interval for a particular metric, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click Statistics.

Step 3 From View graphs of select the metric type, then click View.

A graph appears.


Viewing a Summary Graph of All Metrics by Time

To view every metric for a preset interval, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click Statistics.

Step 3 From View graphs of all metrics for the last select the time interval, then click View.

A graph appears.


Troubleshooting

Follow these high-level tasks when troubleshooting application server problems:

1. Check the AppServer log files (choose Server Logs > AppServer from the Main Control Panel).

2. The default logging level for most components is Warning. To aid in diagnosing a problem, choose a higher logging level, such Verbose (see the "Core Components" section). The Verbose setting allows all inner components to log freely according to their own log level settings.

Specifically, if the application server is not under heavy load, turn up the master log filter for the Log Server to Verbose (Core Components > Logger > Log Server Sink Log Level = Verbose). The Verbose setting allows all inner components to log freely according to their own log level setting. Also set the Telephony Manager component log level to Verbose (Core Components > Telephony Manager > Log Level = Verbose).

3. Run the application again to generate logs under the verbose conditions.

Backing Up the System

Use the system backup feature to take a snapshot of the current configuration settings in the management console, to save applications, and to save application configurations. A system backup generates a tar file that can be stored in a safe location.


Note A backup can only be used to restore a system of the same version.


Cisco recommends backing up systems regularly to prevent data loss in the unlikely event of system failure. See Restoring the System for instructions on restoring a previously backed up system.

To perform system backups, follow these steps:

Procedure


Step 1 Use the server console or VNC to open a command window.

Step 2 Change the current directory to C:\Program Files\Cisco Systems\Unified Application Environment\Framework\1.0, and locate the executable file: cuae-backup.exe


Note Arguments with spaces in their names must have double quotes around them.


For example:

cd "C:\Program Files\Cisco Systems\Unified Application Environment\Framework\1.0"

Step 3 Enter the following command:

cuae-legacy-backup.exe [ +database_name ...]

where +database_name is the name of a database you want to backup in addition to the system database.


Note The system database is automatically backed up during the backup process. If you do not need to back up additional application-specific databases, do not specific database_names.


In general, if you have any applications that use their own, customized, MySQL database on the server, you will need to specify their database names. Check with the developers who created the applications that are installed on the system to find out if there are custom databases associated with the applications, and whether they should be backed up. For example, to back up only the system database, enter:

cuae-backup.exe

After running the cuae-backup.exe tool, the backup file is saved in C:\Program Files\Cisco Systems\Unified Application Environment\Backups. Cisco strongly recommends you remove the backup file from the MCS server and store it elsewhere for safe keeping.


Restoring the System

Use the system restore feature to install and activate a previously-generated system backup file. (See Backing Up the System.)


Caution The configuration in the backup folder overwrites the current configuration. Once started, the process cannot be stopped or undone. Always back up the system before you restore a system backup file.

To restore a backup, follow these steps:

Procedure


Step 1 Place the Backup folder anywhere on the MCS server.

Step 2 Log in to the Cisco Unified Application Environment management console.

Step 3 From the Main Control Panel, under System, click Service Control, then stop all the services.

Step 4 Use the server console or VNC to open a command window.

Step 5 Change the current directory to C:\Program Files\Cisco Systems\Unified Application Environment\Framework\1.0, and locate the executable file: cuae-restore.exe


Note Arguments with spaces in their names must have double quotes around them.


For example:

cd "C:\Program Files\Cisco Systems\Unified Application Environment\Framework\1.0"

Step 6 Enter the following command to restore the data:

cuae-restore.exe [path_to_backup_file]

where path_to_backup_file is the location of the file generated by the cuae-legacy-backup tool, which is located in the Backup folder on the server.

For example, if you want to restore a file called backup1.cuae located in the C:\Program Files\Cisco Systems\Unified Application Environment\Backups folder, enter:

cuae-restore.exe "C:\Program Fil"s\Cisco Systems\Unified Application Environment\Backups\backup1.cuae"

Step 7 Return to the Main Control Panel, and click Service Control, then click Restart for the Watchdog Server.

This restarts all of the services in order of dependency.


Reinitializing the Server

Use the DVDs that are shipped with the server to re-image the system to the factory settings. For details, see Installing the Cisco Unified Application Environment, Release 2.4 at the following URL: http://www.cisco.com/en/US/products/ps7058/prod_installation_guide09186a00807fb85e.html