Cisco Unified Real-Time Monitoring Tool Administration Guide, Release 9.0(1)
Installation and configuration of Real-Time Monitoring Tool (RTMT)
Downloads: This chapterpdf (PDF - 369.0KB) The complete bookPDF (PDF - 6.71MB) | Feedback

Installation and configuration of Real-Time Monitoring Tool (RTMT)

Installation and configuration of Real-Time Monitoring Tool (RTMT)

How to install and upgrade RTMT

The IM and Presence service Real-Time Monitoring Tool (RTMT), which runs as a client-side application, monitors real-time behavior of IM and Presence components. The Real-Time Monitoring Tool uses Hypertext Transfer Protocol Secure (HTTPS) and Transmission Control Protocol (TCP) to monitor system performance, device status, device discovery, and Computer Telephony Integration (CTI) applications for IM and Presence. The 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.


The Real-Time Monitoring Tool 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 emails, for objects when values go over/below user-configured thresholds
  • Collect and view traces in various default viewers that exist in RTMT
  • View syslog messages in SysLog Viewer
  • Work with performance-monitoring counters

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.

Before You Begin
  • Ensure that the RTMT version that you install is compatible with the IM and Presence service version that runs in your cluster; for example, the RTMT version that supports IM and Presence 9.x does not support previous versions of IM and Presence.
  • If you have previously installed RTMT for use with an IM and Presence server that is running Microsoft Windows, you must install RTMT for IM and Presence in a different folder on your local computer.
  • To achieve SSO for the Real-Time Monitoring Tool (RTMT), you must create the following new registry key on your Desktop client (Windows XP or Windows 7): allowtgtsessionkey of type REG_DWORD with value set to 1. This new registry key should be stored at either of the locations below, depending on your Operating system:
    Windows XP - HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Lsa\Kerberos\Value Name: allowtgtsessionkey
    Value Type: REG_DWORD
    Value: 0x01
    Windows Vista/Windows 7 - HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\Kerberos\Parameters
Procedure
    Step 1   Select Application > Plugins in Cisco Unified CM IM and Presence Administration.
    Step 2   Select Find.
    Step 3   Perform one of the following actions:
    1. If you are planning to install the RTMT tool on a computer that is running the Microsoft Windows operating system, select Download for the IM and Presence Real-Time Monitoring Tool-Windows.
    2. If you are planning to install the RTMT tool on a computer that is running the Linux operating system, select Download for the IM and Presence Real-Time Monitoring Tool-Linux.
    Step 4   Download the executable file to your preferred location.
    Step 5   Perform one of the following actions:
    1. To install the Windows version, double-select 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.
    2. 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 6   Select Next.
    Step 7   Select Yes to accept the license agreement.
    Step 8   Perform one of the following actions:
    1. Select the location where you want to install RTMT.
    2. If you do not want to use the default location, select Browse and navigate to a different location. Select Next.
    Step 9   Select Next.
    Step 10   Select Finish to complete the installation.

    Troubleshooting Tips
    • Do not select Cancel when the Setup Status window displays.
    • While installing RTMT on a Windows Vista computer, a User Account Control pop-up message displays stating that, "An unidentified program wants to access your computer." Select Allow to continue working with RTMT.

    What to Do Next

    See the Cisco Unified Serviceability Administration Guide for more information.

    Upgrade RTMT

    When you use the RTMT, it saves user preferences and downloaded module jar files locally on the client computer. The system saves user-created profiles in the IM and Presence database, so you can access these items in RTMT after you upgrade the tool.

    Before You Begin

    To ensure compatibility, Cisco recommends that you upgrade RTMT after you complete the IM and Presence service upgrade on all servers in the cluster.

    Procedure
      Step 1   Select Application > Plugins in Cisco Unified CM IM and Presence Administration.
      Step 2   Select Find.
      Step 3   Perform one of the following actions:
      1. If you are planning to install the RTMT tool on a computer that is running the Microsoft Windows operating system, select Download for the IM and Presence Real-Time Monitoring Tool-Windows.
      2. If you are planning to install the RTMT tool on a computer that is running the Linux operating system, select Download for the IM and Presence Real-Time Monitoring Tool-Linux.
      Step 4   Download the executable to your preferred location.
      Step 5   Perform one of the following actions:
      1. To install the Windows version, double-select 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.
      2. 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 6   Select Next.
      Step 7   Because you cannot change the installation location for upgrades, select Next.
      Step 8   Select Finish.

      Troubleshooting Tips

      Do not select Cancel when the Setup Status window displays.


      Multiple installations of RTMT

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

      • An IM and Presence product on one server.
      • A node 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.

      Multiple copies of RTMT that are installed on your computer let you simultaneously monitor multiple IM and Presence products that are installed on different servers.


      Note


      Beware of the following limitations:

      To monitor clusters that are running different versions of the IM and Presence service simultaneously, you must install multiple versions of RTMT (one version per IM and Presence release). If you install multiple versions of the plug-in, you can install the versions on the same client as long as the version exist in different folders. If the installation detects another version in the folder, a message displays. To continue the installation, install the version in a different folder.


      When you install multiple copies of RTMT on a single computer, you must install RTMT in different folders. Cisco recommends installing no more than four copies of RTMT on a computer.

      Because installing another copy of RTMT overwrites the shortcut icon, you should complete the following tasks:

      1. Create another icon by creating a shortcut to jrtmt.exe in the folder with the previous installation.
      2. Rename the icon accordingly.

      If the installation detects another version in the selected folder, a message displays. To continue the installation, install the version in a different folder.


      Note


      Your computer stores the user preferences, such as the IP address and RTMT frame size, from the RTMT client that last exits.


      Services, servlets, and service parameters on server

      To support the RTMT client, there are a number of services that needs 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 that exists on nodes in the cluster. The IM and Presence service automatically assigns the first node as the primary collector. For RTMT to continue to retrieve information when the primary collector fails, you must configure a subsequent node as the failover collector in Service Parameters in Cisco Unified CM IM and Presence Administration.
        The following list comprises some Cisco AMC service parameters that are associated with RTMT. For the latest list of parameters, select System > Service Parameters in Cisco Unified CM IM and Presence Administration. Then, select the server and the Cisco AMC service.
        • Primary Collector
        • Failover Collector
        • Data Collection Enabled
        • Data Collection Polling Rate
        • Server Synchronization Period
        • RMI Registry Port Number
        • RMI Object Port Number
        • Alert Manager Enabled
        • Logger Enabled
        For information about these service parameters, select the ? button that displays in the Service Parameter configuration window of Cisco Unified CM IM and Presence Administration.
        The following list comprises some network services/servlets that are associated with RTMT. In Cisco Unified IM and PresenceServiceability, Select Tools > Control Center - Network Services to view these services.
        • Cisco CallManager Serviceability RTMT—Supports the IM and Presence Real-Time Monitoring Tool, this service starts up automatically after the installation.
        • Cisco RIS Data Collector—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 Real-Time Monitoring Tool, SOAP applications, and AlertMgrCollector (AMC) to retrieve the information that is stored on the server.
        • Cisco Tomcat Stats Servlet—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—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—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—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—The Cisco SOAP-Real-Time Service APIs, which start up automatically after the installation, allow RTMT to collect real-time information for devices and CTI applications.
        • Cisco SOAP-Performance Monitoring APIs—This service, which starts up automatically after the installation, allows RTMT to use performance monitoring counters for various applications through SOAP APIs.
        • Cisco RTMT Reporter servlet—This service, which starts up automatically after the installation, allows you to publish reports for RTMT

      Navigation of RTMT

      This section describes how to launch RTMT and the RTMT interface.

      Launch RTMT

      Before You Begin

      Cisco AMC Service automatically starts up after installation. The IM and Presence service automatically assigns the first node as the Primary Collector. For RTMT to continue to retrieve information when the primary collector fails, you must configure a subsequent node as the Failover Collector in Cisco Unified CM IM and Presence Administration.

      Procedure
        Step 1   After you install the plug-in, select Start > All Programs > Cisco > Presence Serviceability > Real-Time Monitoring Tool 9.0.
        Step 2   Enter either the IP address or host name of the publisher node in the Host IP Address field.
        Step 3   Enter the port that the application will use to listen to the server. The default port number is 8443.
        Step 4   Check Secure connection.
        Step 5   Select Ok.

        If the single sign-on feature is enabled, RTMT does not prompt for the username and password, proceed to Step 8. See the Cisco Unified Communications Operating System Administration Guide for more information about single sign-on for the IM and Presence server.

        Step 6   If the single sign-on feature is not enabled, enter the CCMAdministrator application user username in the User Name field, for example, the default username for this user is CCMAdministrator.
        Step 7   If the single sign-on feature is not enabled, enter the CCMAdministrator application user password that you established for the username in the Password field.
        Step 8   Select Yes to add the certificate store.

        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

        Troubleshooting Tips

        • While using RTMT on a computer running Windows Vista operating system, a User Account Control pop-up message displays stating that, "An unidentified program wants to access your computer." Select Allow to continue working with RTMT.
        • If the username and password authentication fails, or if the server is unreachable, the tool prompts you to reenter the server and authentication details, or you can select Cancel to exit the application.
        • After the authentication succeeds, 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 backend IM and Presence version.

        RTMT interface

        The RTMT window comprises the following main components:

        • Menu Bar, which includes the following menu options:
          • File—Allows you to save, restore, and delete existing RTMT profiles, monitor Java Heap Memory Usage, manage certificates, access the Cisco Unified Reporting Tool, go to the Serviceability Report Archive window in Cisco Unified IM and Presence Serviceability, and sign off or exit RTMT.
          • System—Allows you to monitor system summary, monitor server resources, work with performance counters, and work with alerts, collect traces, view syslog messages, and access plugins.
          • IM and Presence—Allows you to view IM and Presence and Cisco Jabber summary information on the 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—Allows you to browse the web pages for Administration and Serviceability and access RTMT plug-ins for download.
          • Help—Allows you to access RTMT documentation and online help and view the RTMT version.
        • Quick Launch Channel—Pane on the left side of RTMT window with tabs that you can select on to display information on the server or information on the applications. The tabs contain groups of icons that you can select on to monitor various objects.
        • Monitor pane—Pane on the right side of the RTMT window where monitoring results display.

        Nonconfigurable components on server (RTMT Collector and Alert Manager)

        The RTMT Collector component is automatically installed with the application. It logs preconfigured monitoring objects information while Alert Manager, also automatically installed, logs alert histories into log files.

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


        Tip


        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 and Alert Manager run on the first node to minimize performance impact.


        Uninstall RTMT

        When you use RTMT, it saves user preferences and the module jar files (the cache) locally on the client computer. The system also saves the cache in the server database. When you uninstall RTMT, you select whether to delete or save the cache.

        Procedure
          Step 1   Perform one of the following actions to uninstall RTMT:
          1. Select Start > All Programs > Cisco > Presence Serviceability > Uninstall Real-Time Monitoring Tool 9.0.
          2. Select Start > Accessories > Uninstall Real-time Monitoring tool on a Red Hat Linux with KDE and/or Gnome client.
          Step 2   Finish uninstalling the plug-in.

          Troubleshooting Tips

          • While uninstalling RTMT on a Windows Vista computer, a User Account Control pop-up message displays stating that, "An unidentified program wants to access your computer." Select Allow to continue working with RTMT.