Cisco Unified Real-Time Monitoring Tool Administration Guide, Release 9.1(1)
Cisco Unified Real-Time Monitoring Tool
Downloads: This chapterpdf (PDF - 1.32 MB) The complete bookPDF (PDF - 7.57 MB) | Feedback

Cisco Unified Real-Time Monitoring Tool

Cisco Unified Real-Time Monitoring Tool

About Cisco Unified Real-Time Monitoring Tool

The Cisco Unified Real-Time Monitoring Tool, which runs as a client-side application, uses HTTPS and TCP to monitor system performance, device status, device discovery, CTI applications, and voice messaging ports. Unified RTMT can connect directly to devices via HTTPS to troubleshoot system problems.


Note


Even when RTMT is not running as an application on your desktop, tasks such as alarm and performance monitoring updates continue to take place on the server in the background.


RTMT allows you to perform the following tasks:

  • Monitor a set of predefined management objects that monitor the health of the system.

  • Generate various alerts, in the form of e-mails, for objects when values go over/below user-configured thresholds.

  • Collect and view traces in various default viewers that exist in RTMT.

  • Unified Communications Manager and Cisco Business Edition only: Translate Q931 messages.

  • View syslog messages in SysLog Viewer.

  • Work with performance-monitoring counters.

A single copy of RTMT that is installed on your computer lets you monitor one server or one cluster at a time. For example, you can monitor either of the following entities:

  • A Cisco Unified Communications Manager product on one server.

  • A server on a cluster to monitor the health of the cluster.

To monitor a product on a different server or node, you must first sign off the server or node before you can sign on to the other server.

Services, Servlets, and Service Parameters for RTMT

To support the RTMT client, several services need to be active and running on the server. RTMT uses the following services/servlets:

  • Cisco AMC service: This service starts up automatically after the installation and allows RTMT to retrieve real-time information from the server or from a server in a cluster (if applicable).


Caution


Unified Communications Manager clusters only: You must configure a second server as the failover collector in Cisco Unified Communications Manager Administration, so RTMT can continue to retrieve information if the primary collector fails. Otherwise, RTMT cannot retrieve information if the primary collector has failed.


The following list comprises some Cisco AMC service parameters that are associated with RTMT:

  • Primary Collector

  • Failover Collector

  • Data Collection Enabled

  • Data Collection Polling Rate

  • Server Synchronization Period

  • RMI Registry Port Number

  • RMI Object Port Number

  • Unified Communications Manager and Cisco Business Edition only: Alert Manager Enabled

  • Cisco Business Edition and Cisco Unity Connection only: AlertMgr Enabled

  • Logger Enabled

  • Unified Communications Manager and Cisco Business Edition only: Alarm Enabled

  • Cisco Business Edition and Cisco Unity Connection only: PerfMon Log Deletion Age


Note


For the latest list of parameters, go to the Service Parameters window of the Cisco Unified CM Administration interface; then, choose Cisco AMC service.


For information on these service parameters, see the service parameter Help.
  • Cisco Communications Manager servlet (in the Control Center: Network Services window in Cisco Unified Serviceability): This service, which supports the Cisco Unified Real-Time Monitoring Tool (RTMT), starts up automatically after the installation.

  • Cisco RIS Data Collector (in the Control Center: Network Services window in Cisco Unified Serviceability): The Real-time Information Server (RIS) maintains real-time information such as performance counter statistics, critical alarms generated, and so on. The Cisco RIS Data Collector service provides an interface for applications, such as Cisco Unified Real-Time Monitoring Tool (RTMT), SOAP applications, and AlertMgrCollector (AMC) to retrieve the information that is stored on the server.

  • Cisco Tomcat Stats Servlet (in the Control Center: Network Services window in Cisco Unified Serviceability): The Cisco Tomcat Stats Servlet allows you to monitor the Tomcat perfmon counters by using RTMT or the Command Line Interface. Do not stop this service unless you suspect that this service is using too many resources, such as CPU time.

  • Cisco Trace Collection Servlet (in the Control Center: Network Services window in Cisco Unified Serviceability): The Cisco Trace Collection Servlet, along with the Cisco Trace Collection Service, supports trace collection and allows users to view traces by using the RTMT client. If you stop this service on a server, you cannot collect or view traces on that server.

  • Cisco Trace Collection Service (in the Control Center: Network Services window in Cisco Unified Serviceability): The Cisco Trace Collection Service, along with the Cisco Trace Collection Servlet, supports trace collection and allows users to view traces by using the RTMT client. If you stop this service on a server, you cannot collect or view traces on that server.

  • Cisco Log Partition Monitoring Tool (in the Control Center: Network Services window in Cisco Unified Serviceability): This service, which starts up automatically after the installation, monitors the disk usage of the log partition on a server.

  • Cisco SOAP-Real-Time Service APIs (in the Control Center: Network Services window in Cisco Unified Serviceability): The Cisco SOAP-Real-Time Service APIs, which start up automatically after the installation, allow you to collect real-time information for devices and CTI applications.

  • Cisco SOAP-Performance Monitoring APIs (in the Control Center: Network Services window in Cisco Unified Serviceability): This service, which starts up automatically after the installation, allows you to use performance monitoring counters for various applications through SOAP APIs.

  • Cisco RTMT Reporter servlet (in the Control Center: Network Services window in Cisco Unified Serviceability): This service, which starts up automatically after the installation, allows you to publish reports for RTMT.

  • Cisco Serviceability Reporter (in the Control Center: Feature Services window in Cisco Unified Serviceability): The Cisco Serviceability Reporter service allows you to publish reports for RTMT.

Nonconfigurable Components

RTMT Collector, a component that is automatically installed with the application, logs preconfigured monitoring objects information while Alert Manager, also automatically installed, logs alert histories into log files. Each preconfigured object belongs to one of several categories: devices, services, nodes, call activities, and PPR. Each category uses a separate log file, and alert details are also logged in a separate file.

The system also records important perfmon object values in performance log files.


Tip


Unified Communications Manager clusters only: Although they require no configuration tasks to run, RTMT Collector and Alert Manager support redundancy. If the primary collector or manager fails for any reason, the secondary collector and manager perform the tasks until primary support becomes available. RTMT Collector, Alert Manager, and RTMT Reporter run on the first node to minimize call-processing interruptions.


The locally written log files appear in the primary collector node at cm/log/amc. For Unified Communications Manager clusters, the log files can exist on more than one node in the cluster because the primary collector changes in failover and fallback scenarios.

You can display log files, except an alert log file, by using the Performance log viewer in Unified RTMT or by using the native Microsoft Performance viewer. You can view an alert log file by using any text editor.

To download log files to a local machine, you can use the collect files option in Trace and Log Central in Unified RTMT.

Alternatively, from the CLI, you can use the file list command to display a list of files and the file get command to download files by SFTP. For more information about using CLI commands, see the Command Line Interface Reference Guide for Cisco Unified Communications Solutions.

Log files exist in CSV format. New log files are created every day at 00:00 hours on the local system. For Unified Communications Manager clusters, new logs for devices, services, nodes, and calls are created when the time zone changes, when a new node is added to the cluster, or during failover/fallback scenarios. The first column of all these logs comprises the time zone information and the number of minutes from the Greenwich Meridian Time (GMT). RTMT Reporter uses these log files as a data source to generate daily summary reports. The report, which is based on the default monitoring objects, is generated every 24 hours for the following information:

  • Call Activity Status: Number of calls attempted and number of calls completed for each Unified Communications Manager, each gateway, trunk, and overall cluster (if applicable). Number of channels available, in-service for each gateway.

  • Device Status: Number of registered phones, gateways, and trunks per each node and overall cluster (if applicable).

  • Server Status: percentage CPU load, percentage memory that is used, percentage disk space that is used per node.

  • Service Status: (Unified Communications Manager and Cisco Business Edition) For each CTI Manager, number of opened devices and lines. For each TFTP server, number attempted and failed requests.

  • Alert Status: Number of alerts per node. For Unified Communications Manager clusters, number of alerts per severity level for the cluster, including the top 10 alerts in the cluster.

  • Performance Protection Report: Trend analysis information about default monitoring objects that allows you to track overall system health. The report includes information for the last 7 days for each node.


Tip


The Unified RTMT reports appear in English only.


The following service parameters apply to Unified RTMT report generation: RTMT Reporter Designated node, RTMT Report Generation Time, and RTMT Report Deletion Age. For information about these parameters, go to the service parameter Help for your configuration:

Cisco Unified Communications Manager

Choose Cisco Serviceability Reporter in the Service Parameter window in Cisco Unified Communications Manager Administration and click the ? button.

Cisco Business Edition 5000

Choose Cisco Serviceability Reporter in the Service Parameter window in Cisco Cisco Unified Communications Manager IM and Presence Administration and click the ? button.

Cisco Unity Connection

On the Service Parameters window, in the Service drop-down list box, click a service and click Help > This Page.

For more information about the Serviceability reports, see the "Serviceability Reports" chapter in the Cisco Unified Serviceability Administration Guide.

Install Unified RTMT

Procedure
    Step 1   Go to the Plug-ins window of the administration interface for your configuration:

    Interface

    How to access

    Cisco Unified Communications Manager

    From Cisco Unified Communications Manager Administration, choose Application > Plugins.

    Cisco Business Edition 5000

    From Cisco Unified Communications Manager Administration, choose Application > Plugins.

    Cisco Unity Connection

    From Cisco Unity Connection Administration, choose System Settings > Plugins.

    Step 2   Click Find.
    Step 3   To install Unified RTMT on a client that is running the Microsoft Windows operating system, click the Download link for the Real-Time Monitoring Tool - Windows.

    To install Unified RTMT on a client that is running the Linux operating system, click the Download link for the Real-Time Monitoring Tool - Linux.

    Tip   

    When you install Unified RTMT on Windows 7 or later, ensure that you perform the installation as an administrator.

    Step 4   Download the executable to the preferred location on your client.
    Step 5   To install the Windows version, double-click the Unified RTMT icon that appears on the desktop or locate the directory where you downloaded the file and run the Unified RTMT installation file.

    The extraction process begins.

    Step 6   To install the Linux version, ensure that the file has execute privileges; for example, enter the following command, which is case sensitive: chmod +x CcmServRtmtPlugin.bin
    Step 7   After the Unified RTMT welcome window appears, click Next.
    Step 8   To accept the license agreement, click I accept the terms of the license agreement; then, click Next.
    Step 9   Choose the location where you want to install Unified RTMT. If you do not want to use the default location, click Browse and navigate to a different location. Click Next.
    Step 10   To begin the installation, click Next.

    The Setup Status window appears.

    Step 11   To complete the installation, click Finish.

    Uninstall Unified RTMT


    Note


    Unified RTMT saves user preferences and the module jar files (the cache) locally on the client machine. When you uninstall Unified RTMT, you choose whether to delete or save the cache.



    Note


    When you uninstall Unified RTMT on a Windows Vista or 7 machine, the following User Account Control popup message appears: "An unidentified program wants to access your computer." Click Allow to continue working with Unified RTMT.


    Procedure
      Step 1   Close any active sessions of Unified RTMT.
      Step 2   To uninstall Unified RTMT, perform one of the following actions:
      1. For a Windows client, choose Start > Settings > Control Panel > Add/Remove Programs
      2. For a Red Hat Linux installation with KDE or GNOME client, choose Start > Accessories > Uninstall Real-time Monitoring tool from the task bar.
      Step 3   Finish uninstalling the plug-in.

      Launch Unified RTMT

      Before You Begin

      For single sign-on in Windows XP, Vista, or 7, run Unified RTMT as an administrator.

      Procedure
        Step 1   After you install the plug-in, open Unified RTMT.

        If you have a Windows XP, Vista, or 7 client and you want to use the single sign-on feature, right click the Unified RTMT shortcut on your desktop or start menu and click Run as Administrator.

        Important:

        Before launching RTMT on Windows 7 or Vista, ensure that User Account Control (UAC) feature is disabled. For more information on UAC feature, refer http://msdn.microsoft.com/en-us/library/aa511445.aspx.

        Step 2   In the Host IP Address field, enter either the IP address or hostname of the node or (if applicable) the node in a cluster.
        Step 3   Enter the port that the application will use to listen to the node.
        Note   

        The default setting is 8443 for secure connections. If firewall is disabled, specify the port as 443.

        Note   

        The Trace and Log Central tool in Unified RTMT uses the port number that you specify to communicate with all the nodes in a cluster. If your system uses port mapping and all nodes do not map to the same port number, then some Unified RTMT tools cannot connect to those nodes. The tools that will fail to connect include Trace and Log Central, Job Status, SyslogViewer, Perfmon Log Viewer, and FTP/SFTP Configuration.

        Step 4   Check the Secure Connection check box.
        Note   

        If you uncheck the Secure Connection check box, you must manually change the port to 80.

        Step 5   Click OK.
        • If the single sign-on feature is enabled, Unified RTMT does not prompt for the username and password; proceed to step 8.
        • If the single sign-on is not enabled, Unified RTMT displays another window prompting for username and password. Enter the details as given in the following steps.
        Step 6   In the User Name field, enter the Administrator username for the application.
        Step 7   In the Password field, enter the Administrator user password that you established for the username.
        Note   

        If the authentication fails or if the node is unreachable, the tool prompts you to reenter the node and authentication details, or you can click the Cancel button to exit the application. After the authentication succeeds, Unified RTMT launches the monitoring module from local cache or from a remote node, when the local cache does not contain a monitoring module that matches the back-end version.

        Step 8   When prompted, add the certificate store by clicking Yes.

        Unified RTMT starts.

        Note   

        If you sign in using the single sign-on feature, Unified RTMT prompts once for a username and password after you click any one of the following menus:

        • System > Performance > Performance log viewer

        • System > Tools > Trace and Log Central

        • System > Tools > Job status

        • System > Tools > Syslog Viewer

        • CallManager > CallProcess > Session Trace

        • CallManager > CallProcess > Called Party Tracing

        • CallManager > Report > Learned Pattern

        • Voice/Video > Report > SAF forwarders

        • Analysis Manager


        What to Do Next

        You can create a user with a profile that is limited only to Unified RTMT usage. The user will have full access to Unified RTMT but will not have permission to administer a node.

        You can create a Unified RTMT user by adding a new application user in the administration interface and adding the user to the predefined Standard RealtimeAndTraceCollection group.

        For complete instructions for adding users and user groups, see the Cisco Unified Communications Manager Administration Guide and Cisco Unified Communications Manager System Guide.

        RTMT Navigation

        The RTMT window comprises the following main components:

        • Menu Bar, which includes some or all of the following menu options, depending on your configuration:

          • File—Allows you to save, restore, and delete existing RTMT profiles, monitor Java Heap Memory Usage, go to the Serviceability Report Archive window in Cisco Unified Serviceability, log off, or exit RTMT.


            Note


            The RTMT menu option File > Cisco Unified Reporting lets you access Cisco Unified Reporting from RTMT. You can use the Cisco Unified Reporting application to snapshot Cisco Unified Communications Manager cluster data for inspection or troubleshooting. Refer to the Cisco Unified Reporting Administration Guide for more information.


          • System—Allows you to monitor system summary, monitor server resources, work with performance counters, work with alerts, collect traces, and view syslog messages.

          • Communications Manager—Allows you to view Cisco Unified Communications Manager summary information on the server; monitor call-processing information; and view and search for devices, monitor services, and CTI.

          • Unity Connection—Allows you to view the Port Monitor tool.

          • IME Service—Allows you monitor server and network activity of the Cisco Intercompany Media Engine server.

          • Edit—Allows you to configure categories (for table format view), set the polling rate for devices and performance monitoring counters, hide the quick launch channel, and edit the trace setting for RTMT.

          • Window—Allows you to close a single RTMT window or all RTMT windows.

          • Application—Depending on your configuration, allows you to browse the applicable web pages for Cisco Unified Communications Manager Administration, Cisco Unified Serviceability, Cisco Unity Connection Administration, and Cisco Unity Connection Serviceability.

          • Help—Allows you to access RTMT documentation online help or to view the RTMT version.

        • Quick Launch Channel—You can click this pane with tabs on the left side of the RTMT window to display information about the server or information about the applications. The tab contains groups of icons that you can click to monitor various objects.

        • Monitor pane—Pane where monitoring results display.

        Configuration Profiles

        You can use RTMT to connect to a server or to any server in a Cisco Unified Communications Manager cluster (if applicable). After you log in to a server, RTMT launches the monitoring module from the local cache or from a remote server when the local cache does not contain a monitoring module that matches the back-end version.

        RTMT includes a default configuration that is called Default. The first time that you use RTMT, it uses the Default profile and displays the system summary page in the monitor pane.

        Unified Communications Manager clusters only: Default profile also dynamically monitors all registered phones for all Unified Communications Manager servers in a cluster. If your cluster contains five configured Unified Communications Manager servers, CM-Default displays the registered phones for each server in the cluster, as well as calls in progress and active gateway ports and channels.

        You can configure RTMT to display the information that interests you, such as different performance counters for different features, in the monitor pane of RTMT and save the framework of your configuration in a profile. You can then restore the profile at a later time during the same session or the next time that you log in to RTMT. By creating multiple profiles, so each profile displays unique information, you can quickly display different information by switching profiles.


        Note


        If you are running the RTMT client and monitoring performance counters during a Unified Communications Manager upgrade, the performance counters will not update during and after the upgrade. To continue monitoring performance counters accurately after the Unified Communications Manager upgrade completes, you must either reload the RTMT profile or restart the RTMT client.


        Default Configuration Profile

        When you initially load Unified RTMT, the system includes a default profile that is called Default. The first time that you use RTMT, it will use the Default profile and display the system summary page in the monitor pane.

        You can configure RTMT to display the information that interests you, such as different performance counters for different features, in the monitor pane of RTMT and save the framework of your configuration in a profile. You can then restore the profile at a later time during the same session or the next time that you sign in to RTMT. By creating multiple profiles, so each profile displays unique information, you can quickly display different information by switching profiles.

        Cisco Unified Communications Manager clusters only: Default monitors all registered phones dynamically in all the Unified Communications Manager servers in a cluster. If your cluster includes five Unified Communications Manager-configured servers, Default displays all registered phones for each server in the cluster, as well as calls in progress and active gateway ports and channels.

        Add Configuration Profile

        With RTMT, you can customize your monitoring window by monitoring different performance counters and then create your own configuration profiles. You can restore these monitoring windows in a single step rather than opening each window again.

        You can switch between different profiles during the same RTMT session or use the configuration profile in subsequent RTMT sessions.

        Follow this procedure to create a profile.

        Procedure
          Step 1   Choose File > Profile.

          The Preferences dialog box appears.

          Step 2   Click Save.

          The Save Current Configuration dialog box appears.

          Step 3   In the Configuration name field, enter a name for this particular configuration profile.
          Step 4   In the Configuration description field, enter a description of this particular configuration profile.
          Note   

          Profiles apply to all nodes within a cluster, but you cannot save and apply the profile to a different cluster.

          The system creates the new configuration profile.


          Restore Configuration Profile

          Perform the following procedure to restore a profile that you configured:

          Procedure
            Step 1   Choose File > Profile.

            The Preferences dialog box appears.

            Step 2   Click the profile that you want to restore.
            Step 3   Click Restore.

            All windows with precanned settings or performance monitoring counters for the restored configuration open.


            Delete Configuration Profile

            Perform the following procedure to delete a profile that you configured:

            Procedure
              Step 1   Choose File > Profile.

              The Preferences dialog box appears.

              Step 2   Click the profile that you want to delete.
              Step 3   Click Delete.
              Step 4   Click Close.