Web Agent on Apache
Use the following steps to enable UXM Web agent on an Apache application server.
After installation the Web agent will automatically be injected on all your pages.
Steps
- Download the JavaScript agent from Download agent software.
- Unzip the zip file to a location where your application server is able to load the file.
- Activate mod_substitute in the httpd.conf
- Activate filter_module in the httpd.conf (May be required in later versions of Apache)
Activate modules in Apache
1) To activate mod_substitute go yo your httpd.conf
Remove # from the line #LoadModule substitute_module modules/mod_substitute.so
Before: #LoadModule substitute_module modules/mod_substitute.so
After: LoadModule substitute_module modules/mod_substitute.so
If needed also add the filter_module
Remove # from the line #LoadModule filter_module modules/mod_filter.so
Before: #LoadModule filter_module modules/mod_filter.so
After: LoadModule filter_module modules/mod_filter.so
2) Create a mod_subtitute rule at the bottom of your httpd.conf
Please remember to change the parameters in the script.
In the version we are adding the script to the <Head> section. You can change this to and add the script where applicable in your application.
# APM EUMJS injection into HTML pages via mod_substitute
<Location />
AddOutputFilterByType SUBSTITUTE text/html
Substitute "s|</head>|<script src=\"/uxm_web_agent.min.js\" data-uem-config=\"type: '', key: 'ServerName_WebSiteName', captureAjax: false, server: 'customername.saas.mcg.dk'\" type=\"text/javascript\"></script></head>|ni"
</Location>
| Parameter | Example Value | Value to change | Comment |
|---|---|---|---|
| src |
src="/uxm_web_agent.min.js" |
/uxm_web_agent.min.js | Path to where the agent is installed (unzipped). Please note the server needs to be able to load the agent or no monitoring occurs. |
| key | Key: 'Servername_Websitename' | Servername_Websitename | Usually the name of the server _ the name of the app pool or web site |
| captureAjax | captureAjax: true | true | false |
Monitor ajax calls. |
| server | server: 'customername.saas.mcg.dk' | customername.saas.mcg.dk |
The name of the controller where agent data is send to. |
For complete list and description of all agent options please see Agent Options.
3) Restart the Apache service to complete the setup.
Validating the installation
Verify that the Web agent is loaded by checking the output of the monitored application. (Default placement is after the title or head section)
Open the application URL and select View -> Source
Our script will be placed after </title> or the <head> tag
Please validate the Web agent script does not conflict with the monitored application.
We recommend clicking through the application and ensure that no new JavaScript errors occurs and that we do not break any AJAX or Frames functionality.
Upgrading
To upgrade the UXM Web Agent on Apache please use the instructions found under Web agent manually installation. Modules are updated with Apache, only the JavaScript file have to be replaced to upgrade the script.