Configuring Real User Monitoring

---

To configure RUM monitors, you have to download the RUM agent and install it in a location accessible to the website you want to monitor. Once the agent is enabled, it will collect performance data from the end users and transmit it to the Applications Manager server. This data will then be processed by Applications Manager and used to measure the digital user experience of the web applications in the Real User Monitor.

Browse through the following topics to learn more about configuring RUM:

• Installing RUM agent
• Starting RUM agent
• Uninstalling RUM agent
• Creating a new Real User Monitor

Installing RUM agent

To start Real User Monitoring, you must first install the RUM agent. Please note that the RUM agent will work only if the Applications Manager server is running.

• Windows
• Linux

Windows

Follow the steps given below to install the RUM agent in Windows systems:

1. Download the RUM Agent (.exe) file for Windows.
2. Execute the downloaded file. The installshield wizard will open up. Click Next to continue. Read the license agreement and click the Next button.
3. Provide the location where the RUM Agent should be installed in your machine and click Next. Click Browse if you want to provide a different location of installation.
4. Specify the name of the folder to be placed in Programs folder and click Next. Default name and location is ManageEngine\RUMAgent.
5. Specify the details of your Applications Manager instance such as Hostname, SSL port, and RUM API Key (which is available under Settings → REST API → Real User Monitor). Click Next to proceed.
6. If you want to install RUM Agent as a service, select the Install Real User Monitoring Agent as Service option and click Next. Please note that you need to have administrative privileges to install the RUM agent as a service.
7. In the final step of the installation wizard, option to Launch the Real User Monitoring Agent Now will be available. Select the option if required. Click Finish to complete the installation process.

Linux

Follow the steps given below to install the RUM agent in Linux systems:

1. Download the RUM Agent (.bin) file for Linux.
2. Execute the downloaded file. The installshield wizard will open up. Click Next to continue. Read the license agreement and click the Next button.
3. Provide the location where the RUM Agent should be installed in your machine and click Next. Click Browse if you want to provide a different location of installation.
4. Specify the details of your Applications Manager instance such as Hostname, SSL port, and RUM API Key (which is available under Settings → REST API → Real User Monitor). Click Next to proceed.
5. Click Finish to complete the installation process.

Starting RUM agent

• Windows
• Linux

Windows

• Open command terminal from the newly-installed <RUMAgent_Home> directory. (Eg: C:\Program File\ManageEngine\RUMAgent)
• Execute the StartServer.bat command in the terminal to start the RUM Agent.
• Upon executing the command, the RUM agent will be started and a new window will open in the browser displaying all RUM Agent related information such as it's version, hostname, port, and the connectivity status of the agent with the Applications Manager console.
• You can stop the agent by executing the StopServer.bat -force command from command prompt.

Linux

• Open command terminal from the newly-installed <RUMAgent_Home> directory. (Eg: \home\test\ManageEngine\RUMAgent)
• Execute the sh StartServer.sh command in the terminal to start the RUM Agent.
• Upon executing the command, the RUM agent will be started and a new window will be opened in the browser displaying RUM Agent related information such as it's version, hostname, port, and the connectivity status of the agent with the Applications Manager console.
• You can stop the agent by executing the sh StopServer.sh -force command from command terminal.

Uninstalling RUM agent

• Windows
• Linux

Note: Before uninstalling, exit the command prompt and close all the files and folders opened in the <RUM Agent Home> directory. If the RUM agent is running, stop the agent before uninstalling it to remove all related files completely.

Windows

• If the RUM agent is running, stop the agent before uninstalling it. You can stop the agent by executing the StopServer.bat -force command from command prompt.
• Open Control Panel → Uninstall Program → right click on Applications Manager - RUM Agent → Click Uninstall. Then follow the instructions shown on screen to uninstall the agent.

Linux

• If the RUM agent is running, stop the agent before uninstalling it. You can stop the agent by executing the sh StopServer.sh -force command from command terminal.
• Open terminal from <RUM Agent Home>/_Applications Manager - RUM Agent_installation directory and execute "./Change\ Applications\ Manager\ -\ RUM\ Agent\ Installation" and follow the process.

Creating a new Real User Monitor

Follow the steps given below to create a new Real User Monitor:

1. Click on Add New Monitor link under New Monitor.
2. Select Real User Monitor under Web Server/Services category.
3. Enter the display name of the web application.
4. Enter the Website URL to be monitored.
5. Enter the Apdex Threshold response time (in milliseconds) used for calculating Apdex score and determining user experience.
6. Select the Application Framework Type of the web application to be monitored. (Traditional or Single Page Application)
7. Enable the Track Ajax calls checkbox to monitor the performance of Ajax calls.
8. Enable the Track cross-domain Ajax calls checkbox to monitor the performance of Ajax calls to domains other than parent domain (external domains).
9. Enter the domain names wherein you do not want to track or monitor your website's performance under Domains to exclude. You can add multiple domains, if required. (Eg: zoho.com)
10. Specify the User agents to excludeby entering the Browser name, OS or the complete string mentioned in the following format:
    Examples:
    • Mozilla/5.0 (Windows NT 10.0; Win64; x64)
    • AppleWebKit/537.36 (KHTML, like Gecko)
    • Chrome/68.0.3440.106 Safari/537.36
11. Enable the Track Resource Performance checkbox to capture individual resources and group them as first party, third party and CDN resources. By default, Applications Manager does not capture website resources.
12. Enable the Affect monitor availability in idle state checkbox for the monitor availability to be affected when the monitor has not polled data for more than the idle time value specified in the option Real User Monitor allowed idle time under Settings → Availability Settings.
13. Choose the Associate monitor instance with RUM Agent option from the dropdown to associate monitor to specific RUM Agent, so that data collection will happen only in that agent.
14. Choose the Monitor Group from the combo box with which you want to associate Real User Monitor (optional). You can choose multiple groups to associate your monitor.
15. Click on Add Monitor(s).

Upon adding the monitor, a script code will be generated in the Monitor Dashboard page under the Copy Script tab. Copy and paste the following script code to the header or footer of the index page or a common page of your application or website which you would like to monitor.

<agentProtocol>://<agentHost>:<agentPort>/RUMScript.js?appKey=','apmr','oY3zeVg61GSpN0TMKaeRxyLfub2Ih9sG10000234)

In the copied script, replace <agentProtocol> with http or https, then replace the <agentHost> and <agentPort> with RUM agent's host and port respectively. Finally, save the changes and start/restart the RUM agent.

The RUM monitor you added will appear on the main RUM dashboard and data collection will begin when the website is accessed. Use the option provided in the Copy Script tab in the monitor's dashboard to verify whether the RUM Script is injected in your application or not.

Learn more about the metrics shown in RUM monitor dashboard