Configuring Real User Monitoring
The V2 RUM includes a simpler and smoother onboarding process by allowing users to skip the manual installation of the RUM Agent by offering users a script that downloads the latest compatible RUM Agent for the Applications Manager version, install the agent, starts it and maps it to the tool.
Browse through the following topics to learn more about configuring V2 RUM:
Creating a new Real User Monitor
To create a new Real User Monitor, navigate to Add New Monitor → Web Server/Services → Real User Monitor, and enter the following details:
- Basic Details
- Enter the website URL to be monitored.
- Choose a name for the monitor of the website.
- Specify Apdex Threshold (in ms) to be used to calculate the Apdex score and determine user experience.
- Click on Next.
- Agent Configuration
- Associate monitor instance with RUM Agent of your choice.
Note: For each RUM Agent, we can add only up to 5 websites (5 monitors)
- To deploy the RUM agent click on the Want to deploy agent? option.
- Choose between Windows and Linux as the OS in which you wish to deploy the agent.
- Download the script file to be executed on the server where you want to install the RUM Agent. The script will automatically start the RUM Agent. If necessary, users can also choose to change the installation path before downloading it.
- For Windows:
Open Powershell and run the following sample command
installrum.ps1
- For Linux:
Open command terminal and run the following sample command
sh installrum.sh
If you encounter any issues, please refer to this page.
- Click on Next to successfully complete monitor addition and move to the RUM Script Injection details.
- JS injection
- Select Application: Select the application framework type (Node.js, PHP, .NET, Java, or others).
- Application Types: Select the application subtype for the selected application (Eg: Subtypes for Node.js - Express and Pug, Express and Swig, Hap.js and Handlebar, or others).
- Script File: Copy the code snippet displayed and paste it in your html file to complete the script injection. Refer to this help page to learn more.
- Click on Complete.
- On successfully completeing the script injection, the page will be automatically redirected to the monitor details page.
Additional Configuration Options
Once a Real User Monitor is added, you can fine-tune its behavior from the Edit Monitor page. These options are not available during monitor creation but can be configured later if needed:
- Track Ajax calls: Monitor the performance of asynchronous requests.
- Track cross-domain Ajax calls: Monitor Ajax requests made to external domains.
- Domains to exclude: Specify domain names (e.g., zoho.com) to skip from tracking.
- User agents to exclude: Filter out specific browser/OS types or full user-agent strings.
- Track Resource Performance: Capture and group page resources as first-party, third-party, or CDN. Disabled by default.
- Affect monitor availability in idle state: Monitor availability is affected when no data is polled beyond the idle timeout set under Settings → Availability Settings.
- Capture JavaScript Errors: Enable to track client-side JavaScript errors. Disabled by default.
These configurations help you tailor Real User Monitoring to your specific requirements and refine data collection.
Starting the RUM agent
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 start and a new window will be opened in the browser displaying all RUM Agent related information such as it's agent 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.
Note:
- Above steps are for non-service installations alone. In the case of Service installations, you can start the RUM agent directly by starting the ManageEngine Real User Monitoring Agent service from Windows services.
- In case you want to change Application Manager's instance details in RUM Agent after installation, refer here.
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 information such as agent 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.
Note: To change Application Manager's instance details in the RUM Agent after installation,
refer here.
Following steps are applicable only for RUM Agent version 4.4 and above.
- Starting RUM Agent as a Linux Service:
- Go to <RUM Agent Home>/bin directory, execute the installService.sh file. On executing this file, ManageEngine Real User Monitoring Agent service will be added in Linux Services and the startup type will be set as Automatic, by default.
Note: For installing RUM Agent as a service, you need to have root privileges in that system.
- Now, when you start a Linux system, RUM Agent will start automatically. You can swap between Automatic and Manual modes.
- To uninstall this service, go to <RUM Agent Home>/bin directory and execute the uninstallService.sh file.
Uninstalling the RUM agent
Note: Before uninstalling the agent, 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, you should 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, you should 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.
Thank you for your feedback!