Real User Monitor (RUM) - Troubleshooting

Real User Monitor (RUM) - Troubleshooting

If the monitor has not polled data for a long time, follow the steps below for troubleshooting:

Step 1: Check the RUM Agent configuration

  1. Real User Monitor requires the RUM Agent to be installed and mapped to the Applications Manager. Refer the help page to know how to setup RUM Agent for Real User Monitoring.
  2. Access the RUM Agent web console by opening (http://agenthost:agentport) in a browser. Replace the agenthost and agentport with your RUM Agent host and port details.
  3. Applications Manager connectivity status should be success. In case of any error refer the below troubleshooting guide.
                              


Step 2: Verify the RUM script injection

  1. Real User Monitoring in Applications Manager requires Javascript injection in the website monitored.
  2. Make sure the RUM script shown in the RUM monitor details page in Applications Manager is injected properly in the webpage intended to be monitored. 
  3. Verify if the RUM agent protocol, host name, port and App key are specified correctly in the RUM script injected.
Info
(window,document,'$agentprotocol://$agenthost:$agentport/RUMScript.js?appKey=','apmr','$monitor_app_key');
    1. "agentprotocol" - RUM Agent protocol 'http' or 'https' .
    2. "agenthost" - Hostname or FQDN where the RUM Agent is installed.
    3. "agentport" - Port number in which the RUM Agent is running. The port number should correspond to the agent protocol.
    4. "monitor_app_key" - Unique key used to identify the monitor in Applications Manager. App Key can be seen in RUM monitor details page -> Copy Script tab.
  1. Make sure the script injected in the application belongs to the respective monitor. In case of mismatch data will be pushed to another monitor. 

Step 3: Ensure the connectivity between the client browser and RUM Agent

  1. Open any browser and its developer tool, Click Networks tab and search for "rum" in the developer tool.
  2. Access the webpage in which the RUM script is injected. Request for RUMScript.js can be seen.
  3. If the RUMScript.js request fails, verify the agent host and port details in the request.
End users accessing the website monitored in Applications Manager should have access to the RUM Agent. If the website is accessible in internet, RUM Agent ports should also be opened in firewall.
                                                

















  1. Mixed content error: If the website monitored is accessed in HTTPS and the script injected points to RUM HTTP port browser will block the request with mixed content error.
                                                
 Update the script injected in the application with RUM Agent HTTPS port and protocol to resolve the error.
  1. (window,document,'https://$agenthost:$agenthttpsport/RUMScript.js?appKey=','apmr','$monitor_app_key');
  1. Content security policy: If the web server has strict content security policy, browser will block the request with csp error. Troubleshooting Guide.
                                                
  1. If the RUMScript.js request is not seen, verify the script injection in the page monitored. Check if the Content security policy directive prevents the inline script. Troubleshooting Guide.
                                          

Step 4: Check the RUMScript.js response

  1. Open any browser and its developer tool, Click Networks tab and search for "rum" in the developer tool.
  2. Access the webpage in which the RUM script is injected.
  3. Check for error message in the RUMScript.js response.  

Step 5: Troubleshoot using the error message

APPMANAGER NOT REACHABLE
  1. Check if AppManager is accessible from the machine where RUM Agent is installed.
  2. Verify AppManager details provided in AppServer.properties file located under <RUMAgent_Home>/conf/ directory. 
  3. Refer the KB to know how to change AppManager details in RUM Agent.
  4. If Proxy is required to communicate with AppManager configure the same by referring the KB.
  5. Check if RUM Agent is compatible for AppManager.
INCOMPATIBLE VERSION
  1. Make sure you use compatible version of RUM Agent for AppManager. Refer the download page to know the compatibility matrix.
INVALID KEY
  1. Provide valid RUM API Key in AppServer.properties by referring the KB.
  2. RUM API Key will present in Settings -> REST API -> Real User Monitor in Applications Manager.
INCOMPATIBLE EDITION
  1. Real User Monitor is not supported in Free edition of Applications Manager.
  2. You need to purchase an license or use trial edition of Applications Manager.
RUM ADD-ON NEEDS TO BE PURCHASED
  1. You need to purchase an RUM addon for enabling RUM data collection. Refer the help page for pricing details.
AGENT MAPPING FAILED or INTERNAL ERROR
  1. Internal server error. Share SIF to analyze the issue.
PAGE VIEWS QUOTA EXCEEDED
  1. We allow only certain amount of page views per month based on the license purchased.
  2. When the page views have exceeded the limit allowed per month "PAGE VIEWS QUOTA EXCEEDED" message will be shown and data collection will be stopped.
  3. Page views used count will be reset to zero on every month start.
  4. Data collection will begin once page views used count is reset.
QuotePurchase license based on your customer base to avoid above case.
KEY NOT FOUND
  1. Restart RUM Agent and check again.
  2. Above message can also be seen when RUM Agent is trying to fetch monitor details from Applications Manager on RUM Agent startup. Wait till RUM Agent fetches RUM monitor details from AppManager.
  3. Above message will be shown when the respective monitor is deleted in AppManager or key has been modified in the script injected in the webpage.
    1. Note down the RUM monitor key from the script displayed in respective monitor details page in Copy Script Tab. Sample key AfHowG5D62YOiWQHXp84DpV8eC2waN2E10000217. Search for the same key in the script injected in the web page. If the key has been modified replace it with the exact key shown in respective monitor details page in Copy Script Tab.
Notes
Note : If the RUM monitor is mapped to specific RUM Agent, data collection can happen only in that specific agent.
MONITOR IS EITHER UNMANAGED OR UNDER MAINTENANCE IN APPMANAGER
  1. Monitor is either in unmanaged state or under maintenance (downtime scheduled for the monitor) in AppManager
  2. Manage the monitor in AppManager or wait until the data collection gets resumed after downtime for the monitor.
Notes
Note: After making above changes if the data collection did not begin restart RUM Agent once and check the issue.
Warning
❌ Dont's
  1. Placing multiple scripts in same webpage. It will affect RUM data collection.
  2. Placing same script in multiple webpages. It will populate multiple webpage data in single monitor from where the script was taken.
  3. Don't keep Applications Manager server down for long time. Applications Manager should be up for continuous data collection.
Other Help Links : 
  1. RUM Agent FAQS
  2. How to get ISP data in Real User Monitor?
  3. How to enable HTTPS connection between end user and RUM Agent?

      

                  New to ADSelfService Plus?

                    • Related Articles

                    • Self monitor Applications Manager using Real User Monitoring

                      We can monitor the Applications Manager using Real User Monitoring with a Java Script injection and this can be used to measure the Applications Manager's performance continuously. All you need is to install and setup the Real User Monitoring (RUM) ...
                    • How to get ISP and Region data in Real User Monitor?

                      The default setting of the Real User Monitor does not display ISP and region data for the end user. To obtain the data, you have the option to use a third-party Geolocation API. Currently, RUM exclusively supports APIs that provide responses in JSON ...
                    • How to enable HTTPS connection between end user and RUM Agent?

                      By default end user data will be collected and sent via HTTP connection to RUM Agent. To enable HTTPS connection you should have an valid SSL Certificate (keystore file basically), not a self signed certificate. For RUM Agent version below 4.0, Open ...
                    • Real User Monitoring Agent - Frequently asked questions

                      How to change Applications Manager details in RUM Agent? Open the AppServer.properties file located under <RUMAgent_Home>/conf/ directory in any text editor. Update Applications Manager hostname in apm.host key. Update Applications Manager SSL Port ...
                    • Troubleshoot - RUM Agent silent installation

                      RUM Agent silent installation can fail on various factors based on your environment, troubleshoot with the help of error message shown while running the script. Below are the list of the error messages thrown from the script and its troubleshooting ...