Cisco Unified Real-Time Monitoring Tool Administration Guide, Release 9.0(1)
Cisco Unified Real-Time Monitoring Tool
Downloads: This chapterpdf (PDF - 416.0KB) The complete bookPDF (PDF - 6.71MB) | 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 (RTMT), 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. 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 CM and Unified CM BE 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 CM 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 CM and Unified CM BE only: Alert Manager Enabled
  • Unified CM BE and Connection only: AlertMgr Enabled
  • Logger Enabled
  • Unified CM and Unified CM BE only: Alarm Enabled
  • Unified CM BE and 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 on the Server (RTMT Collector, Alert Manager, and RTMT Reporter)

RTMT Collector, a component that automatically gets 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, servers, call activities, and PPR. Each category uses a separate log file, and alert details also get logged in a separate file.

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


Tip


Unified CM 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 server to minimize call-processing interruptions.


The locally written log files appear in the primary collector server at cm/log/amc. For Cisco Unified Communications Manager clusters, the log files can exist on more than one server 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 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 RTMT.

Alternatively, from the command line interface (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 on using CLI commands, refer to the Command Line Interface Reference Guide for Cisco Unified Solutions.

Log files exist in csv format. New log files get created every day at 00:00 hours on the local system. For Cisco Unified Communications Manager clusters, new logs for devices, services, servers, and calls are created when the time zone changes, when a new server 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, generates every 24 hours for the following information:

  • Call Activity Status—Number of calls attempted and number of calls completed for each Cisco 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 server and overall cluster (if applicable).
  • Server Status—% CPU load,% memory used,% disk space used per server.
  • Service Status —(Unified CM and Unified CM BE only) 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 server. For Cisco 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 on default monitoring objects that allows you to track overall system health. The report includes information for the last 7 days for each server.

Tip


The RTMT reports display in English only.


The following service parameters apply to RTMT report generation: RTMT Reporter Designated server, RTMT Report Generation Time, and RTMT Report Deletion Age. For information on 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 Unified Communications Manager Administration and click the ? button.

Connection

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

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

Install RTMT

You can install RTMT on a computer that is running Windows 98, Windows XP, Windows 2000, Windows Vista, or Linux with KDE and/or Gnome client. The RTMT is suitable for resolutions 800*600 and above.


Note


While installing RTMT on a Windows Vista platform, you will see a User Account Control pop-up message that says, "An unidentified program wants to access your computer." Click Allow to continue working with RTMT.



Note


For information on installing RTMT on a Cisco Intercompany Media Engine server, refer to the Cisco Intercompany Media Engine Installation and Configuration Guide.


Before You Begin

Consider the following, before you install RTMT


Note


RTMT requires at least 128 MB in memory to run on a Windows OS platform.



Note


RTMT requires at least 300 MB of disk space to run on a Windows/Linux OS platform.


  • On a client machine, you can install RTMT client downloaded from only one product type—Unified Communication Manager or Unified Presence or Unity Connection or Unified Contact Center Express. Installing RTMT client from different product types on the same client machine is not supported.
  • The current RTMT download may not support earlier releases of Cisco Unified Communications Manager or Cisco Unity Connection. Some releases of Cisco Unified Communications Manager may require different versions of RTMT to be installed on your computer (one version per Cisco Unified Communications Manager release). Verify that the RTMT version that you install is compatible with the Cisco Unified Communications Manager that you are monitoring. If the RTMT version that you are using is not compatible with the server that you want to monitor, the system prompts you to download the compatible version.
  • Your computer stores the user preferences, such as the IP address and RTMT frame size, from the RTMT client that last exits.
  • To enable the single sign on feature in Cisco Unified CM, see "Single Sign On" chapter in Cisco Unified Communications Manager Features and Services Guide .
  • To enable the single sign on feature on RTMT, modify the Windows registry as follows:
    HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Lsa\Kerberos\Value Name: allowtgtsessionkey
    Value Type: REG_DWORD
    Value: 0x01
Procedure
    Step 1   Go to the Plug-ins window of the administration interface for your configuration:

    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.

    Unity Connection

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

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

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

    Step 4   Download the executable to the preferred location on your client.
    Step 5   To install the Windows version, double-click the RTMT icon that displays on the desktop or locate the directory where you downloaded the file and run the 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 RTMT welcome window displays, 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 RTMT. If you do not want to use the default location, click Browse and navigate to a different location. Click Next.

    Default installation paths are:

    1. Windows— C:\Program Files\Cisco\Unified-Communications-Manager Serviceability\JRtmt
    2. Linux— /opt/Cisco/Unified-Communications-Manager_Serviceability/JRtmt
    Step 10   To begin the installation, click Next.

    The Setup Status window displays. Do not click Cancel.

    Step 11   To complete the installation, click Finish.

    Uninstall RTMT


    Tip


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



    Note


    When you uninstall RTMT on a Windows Vista machine, the following User Account Control pop-up message displays: "An unidentified program wants to access your computer." Click Allow to continue working with RTMT.


    Procedure
    To uninstall RTMT, do one of the following:
    1. For a Windows client, choose Start > Settings > Control Panel > Add/Remove Programs
    2. For a Hat Linux with KDE and/or Gnome client, choose Start > Accessories > Uninstall Real-time Monitoring tool from the task bar.

    Launch RTMT

    When you launch RTMT, log into the same product type from which you downloaded the RTMT client application. If you log into a different product type, RTMT will not launch or work properly.


    Caution


    Unified CM 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.



    Note


    While using RTMT on a Windows Vista machine, you will a see a User Account Control pop-up message that says, "An unidentified program wants to access your computer." Click Allow to continue working with RTMT.


    Procedure
      Step 1   After you install the plug-in, perform one of the following tasks:
      1. From your Windows desktop, double-click the Real-Time Monitoring Tool icon.
      2. Choose Start > Programs > Cisco > Unified-Communications-Manager Serviceability > Real-Time Monitoring Tool > Real-Time Monitoring Tool.

        The login window displays.

      Step 2   In the Host IP Address field, enter either the IP address or host name of the Cisco Unified CM server or (if applicable) the first Cisco Unified CM server in a cluster.
      Step 3   Enter the port that the application will use to listen to the server. The default setting equals 8443.
      Note   

      The Trace and Log Central tool in 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 Cisco Unified Communications Manager nodes do not map to the same port number, then some RTMT tools can not 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.
      Step 5   Click OK.

      If single sign on feature is enabled in the Cisco Unified CM server, RTMT does not prompt for the user name and password; proceed to Step 8.

      If single sign on is not enabled, RTMT displays another window prompting for user name 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 server is unreachable, the tool prompts you to reenter the server and authentication details, or you can click the Cancel button to exit the application. After the authentication succeeds, RTMT launches the monitoring module from local cache or from a remote server, when the local cache does not contain a monitoring module that matches the backend version.

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

      Real-Time Monitoring Tool starts.

      Note   

      If you have logged in using the single sign on feature, RTMT prompts for user name and password once, when you click on 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
      • CallManager > Report > SAF forwarders
      • Analysis Manager Creating an RTMT-Only User

      What to Do Next

      Cisco Unified Communications Manager supports the creation of an RTMT user with restricted access to Cisco Unified Communications Manager Administration. You can create a user with a profile that is limited to Cisco Unified Communications Manager RTMT usage only. The user will have full access to RTMT but will not have permission to administer a Cisco Unified Communications Manager server.

      You can create an RTMT user by adding a new application user in Cisco Unified Communications Manager Administration and adding the user to the predefined Standard RealtimeAndTraceCollection group.

      For complete instructions on adding users and user groups, refer 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.

      RTMT 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 backend 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 CM clusters only: Default profile also dynamically monitors all registered phones for all Cisco Unified Communications Manager servers in a cluster. If your cluster contains five configured Cisco 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 Cisco Unified Communications Manager upgrade, the performance counters will not update during and after the upgrade. To continue monitoring performance counters accurately after the Cisco Unified Communications Manager upgrade completes, you must either reload the RTMT profile or restart the RTMT client.


      Default RTMT configuration profile

      When you initially load 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.

      Unified CM clusters only: Default monitors all registered phones dynamically in all the Cisco Unified Communications Manager servers in a cluster. If your cluster includes five Cisco 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 RTMT configuration profile

      With RTMT, you can customize your monitoring window by monitoring different performance counters, then create your own configuration profiles, so 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.

      The following procedure describes how to create a profile.

      Procedure
        Step 1   Choose System > Profile .

        The Preferences dialog box displays.

        Step 2   Click Save.

        The Save Current Configuration dialog box displays.

        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   

        You can enter whatever you want for the configuration profile name and description.

        Note   

        Unified CM clusters only: Profiles apply to all servers within a cluster, but the profile cannot be saved and applied to a different cluster.

        The system creates the new configuration profile.


        Restore RTMT profile

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

        Procedure
          Step 1   Choose System > Profile .

          The Preferences dialog box displays.

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

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


          Delete RTMT configuration profile

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

          Procedure
            Step 1   Choose System > Profile .

            The Preferences dialog box displays.

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