Installing the eG RUM Collector

You can install the eG RUM Collector using one of the following methodologies:

  • Using the eGRUM executable; (OR)
  • Using the rumcollector.war file

Both these methodologies are described in the sub-sections below.

Installing Using the eGRUM Executable

The eG RUM collector is provided as a self-extracting, 64-bit program named eGRUM. This program can be executed only on a Windows 2008 (64-bit) or Windows 2012 (64-bit) host. This means that with the help of the eGRUM executable, you can install the RUM collector on a Windows 2008 (64-bit) or Windows 2012 (64-bit) host only.

To begin the installation, first double-click on eGRUM on the target Windows host. The resulting installation wizard will guide you through the setup process.

  1. The Welcome screen appears first (see Figure 1).

    Figure 1 : The Welcome screen

  2. Click Next in Figure 1 to continue with the installation. Figure 2 will then appear.

    Figure 2 : The End User License Agreement

  3. Click the Yes button in Figure 2 to accept the terms of the license agreement. This will invoke Figure 3.

    Figure 3 : Selecting a JDK version to use for collector installation

  4. Setup then automatically discovers all the versions of JDK available on the target host, and lists them as depicted by Figure 3. The user will have to simply select the JDK version he/she wants to use for their collector installation from the displayed list. It is recommended that you use JDK 1.7 (or its variants) for installing the eG RUM collector.

  5. Upon selecting a JDK version, eG Enterprise automatically determines the location of the JDK-related files on the target host, and uses them to configure the eG user’s Java execution environment to execute Java programs to proceed with the installation. Clicking on the Next button in Figure 3.8 will then lead the user straight to step 8 of the setup process.

  6. On the other hand, if the JDK version the user wishes to use is not listed in Figure 3 for some reason, he/she can pick the Other option from Figure 3. Figure 4 then appears, where the user is prompted to specify if his/her environment contains the required JDK. It is recommended that you use JDK 1.6 (or its variants) for installing the eG RUM collector.

    Figure 4 : Setup enquiring the availability of JDK in the environment

  7. If JDK is already available in the environment, specify the Java home directory to enable the setup process to configure the eG user’s execution environment to execute Java programs as in Figure 5. The user can also use the Browse button to select the location of the Java home directory.

    Figure 5 : Specifying the location of the Java home directory for installing the eG RUM collector

  8. The setup process now requires the hostname and port number of the host on which the eG RUM collector is being configured (see Figure 6). By default, setup auto-discovers the host name and the IP address(es) of the eG RUM collector, and makes it available for selection in Figure 6. You can pick the host name or any of the IP addresses listed therein to take the installation forward. If the IP address/host name that you want to use for your collector is not discovered for some reason, then, you can choose the Other option in Figure 6. This will invoke Figure 7 where you can manually specifiy the IP address/host name of the eG RUM collector. If the domain name service is used in the target environment, use the full hostname. Otherwise, specify the IP address. However, 7080 is the default port. You can change this port if you so need.

    Figure 6 : Selecting the IP address/host name of the collector

    Figure 7 : Manually specifying the IP address/host name of the collector host

    Note:

    • While specifying the host name (and not the IP address) of the collector, please take care of the following aspects:

      1. Use this name (and not the IP address) when configuring the eG RUM collector in the eG administrative interface.
      2. Make sure that forward and reverse lookups for this name are enabled via the DNS service in the target environment.
    • When providing an IP address for the eG RUM collector, note that only an IPv4 address can be provided. To configure the eG collector on a host that has an IPv6 address, you will have to provide the fully-qualified host name of that host or an alias name, in Figure 3.12.

  9. Setup then prompts you to indicate if the eG RUM collector is to be SSL-enabled. If so, click Yes in Figure 8. If not, click No.

    Figure 8 : Indicating whether/not to SSL-enable the eG RUM collector

  10. Next, use the Browse button in Figure 9 that appears to specify where the eG RUM collector is to be installed. Then, click Next to proceed.

    Figure 9 : Specifying the install directory of the eG RUM collector

  11. Then, view a quick summary of the specifications and click Next in Figure 10 to proceed.

    Figure 10 : A summary of the specifications

  12. If the configuration process succeeds, the following screen will be displayed (see Figure 11). The Setup requires the user to restart the system. This can be done immediately or at a later point of time. Clicking on the Finish button will exit the Setup.

    Figure 11 : Setup program indicating the completion of the eG RUM collector installation

Since the eG RUM collector is a Tomcat-based application, the eGRUM executable is bundled with Apache Tomcat v6. An Apache Tomcat server therefore, gets automatically installed on the target Windows host when deploying the collector.

Installing Using the WAR File

The eG RUM collector is also available as a war file named rumcollector.war in the /opt/egurkha/manager/tomcat/webapps (on Unix; on Windows, this will be the <EG_INSTALL_DIR>\manager\tomcat\webapps) folder of the eG manager. This war file can either be installed on an Apache Tomcat server v6 (or above) or on an Oracle WebLogic server v10.x/11.x/12.x.

To deploy the war file on a Tomcat server, follow the steps below:

  1. Copy the rumcollector.war file from the eG manager host to any location on the target RUM collector host.
  2. Stop the Tomcat on the server where the RUM collector is to be installed.
  3. Open the shell prompt on the target host, and switch to the <TOMCAT_HOME>/webapps directory on the host.
  4. Run the following command to copy the rumcollector.war file available in a temporary location on the host to the <TOMCAT_HOME>/webapps:

    cp /tmp/rumcollector.war .

     

    Here /tmp/rumcollector.war refers to the temporary location of the rumcollector.war.

  5. Next, start the Tomcat server by running the following command from the <TOMCAT_HOME>/bin directory:

    catalina.sh run

     

  6. Starting the Tomcat server will automatically start the rumcollector application deployed within. In the startup messages, look for the following line to confirm deployment:

    INFO: Deploying web application archive rumcollector.war

     

  7. Once Tomcat starts, switch to the <TOMCAT_HOME>/webapps folder from the shell prompt, and run the following command to view the contents of the folder:

    ls -alt

     

  8. Look for the rumcollector application file in the folder. If you find it, it is the first indication that the RUM collector has been successfully deployed on the target.
  9. Next, from a remote host in the environment, launch a browser and connect to the following URL:

    http://<Tomcat_IP>:<Tomcat_connector_port>/rumcollector/Welcome.jsp

  10. If this URL returns a page with the text Welcome! , it indicates the successful deployment of the RUM collector.

To deploy the rumcollector.war file on a WebLogic server, do the following:

  1. Login to the target WebLogic server.
  2. Copy the rumcollector.war file from the eG manager host to any location on the WebLogic server.
  3. Launch a browser and then connect to the WebLogic console.
  4. Login to the console as a WebLogic administrator.
  5. Figure 12 will then appear.

    Figure 12 : The WebLogic console

  1. Click on the Deployments node in the Domain Structure tree in the left panel of Figure 12. Figure 13 will then appear.

    Figure 13 : List of applications deployed on the server

  1. To install the eG RUM Collector web application, click on the Install button in the right panel of Figure 13. This will open Figure 14.

    Figure 14 : Clicking the 'upload your file(s)' link

  1. Click on the upload your file(s) link against Note: in the right panel of Figure 14. Figure 15 will then appear, where you have to choose the rumcollector.war file that you wish to upload. For that, use the button Choose in Figure 15.

    Figure 15 : Choosing the rumcollector.war file to be uploaded

  2. Then, click the Next button in Figure 15 to proceed. If the upload is successful, Figure 16 that appears next will display a message to that effect. Click Next in Figure 16 to proceed.

    Figure 16 : Message confirming the successful file upload

  1. When Figure 17 appears, click the Next button again.

    Figure 17 : Clicking the Next button to proceed

  1. Click the Finish button in Figure 18 to end the war file installation.

    Figure 18 : Clicking Finish to end the war file installation

  1. Figure 19 then appears. If the rumcollector.war has been deployed successfully, then, in the Deployments list of Figure 19, you should be able to find an entry for the rumcollector, with State as Active and Health as OK. If you find such an entry, you can confirm the successful installation of the eG RUM Collector.

    Figure 19 : Successful installation of the eG RUM Collector

  2. Finally, log out of the WebLogic console.