Skip to content
CA Experience Collector
Documentation powered by DocOps

Implement the Browser Agent

Last update April 10, 2018

The Browser Agent implementation deploys the files that enable the default monitoring of your environment. You can modify the default monitoring to achieve the balance of visibility and performance that you require.


Browser Agent Deployment Scenarios

The Browser Agent has the following deployment scenarios:

  • CA APM only
  • CA APM and CA App Experience Analytics
  • CA App Experience Analytics only

For these scenarios, differences exist in where and how to edit the profile and the extension file.

CA APM-Only Deployment

You have the following options with the CA APM-only deployment:

  • Browser Agent is used for automatic snippet injection and the response decoration for business transaction matching support and end-to-end transaction trace correlation.
  • Browser Agent is used for the response decoration only for business transaction matching support and end-to-end transaction trace correlation. You add the JavaScript snippet manually.
  • No agent, you add the JavaScript snippet manually.

CA APM and CA App Experience Analytics and CA App Experience Analytics-Only Deployments

The CA App Experience Analytics server supplies the Browser Agent profile file and the Browser Agent extension file. The CA App Experience Analytics Web App configuration provides the snippet for manual or auto-injection. Follow the instructions in the CA App Experience Analytics documentation for updating the profile and the extension file.

How to Implement the CA APM-Only Deployment

After you install a supported agent, the CA APM-only deployment for the Browser Agent includes high-level steps:

  1. Use the snippet for manual or automatic snippet injection.
  2. Decide if you want transaction trace correlation and proceed accordingly.

The following diagram shows the steps for a CA APM-only deployment:

APM browser agent deployment

Verify the Browser Agent Prerequisites

Verify that you meet the following installation prerequisites:

  • APM is configured with Digital Experience Collector.
  • A licensed CA APM implementation with supported agents that are configured for application frameworks
  • Web pages whose Content-Type is text/HTML.
  • Cookies are enabled on the browsers and on the applications that you want to monitor.
  • Compatibility View in Internet Explorer is disabled; otherwise, the Browser Agent metrics might not be produced.
  • Browser Session Storage is enabled on the Browser Agent.

Note: For the agent support, browser and version support, and system requirements, see the Product Compatibility Matrix. If a browser is not supported, you can create a metric count per interval (15-second interval) for how much nonsupported browser activity is occurring. You can configure sustainability metrics to view the unsupported browsers.

Remove a Previous Installation

If you have a previous release of CA Browser Response Time Monitor, remove it before you install the current release.

Note: Some files might not exist depending on the previously installed version.

Valid for: Releases 9.5 through 10.0

Follow these steps:

  1. Remove the BRTM.jar and BRTMFilter.jar files. These files are typically in the <Agent_Home>/core/ext directory.
  2. Remove any BRTMFilter.jar reference in the application classpath or in the web.xml file.
  3. Remove any management modules or typeviews for CA Browser Response Time Monitor.

Valid for: Releases 10.1 through 10.3

Follow these steps:

  1. Remove the browseragent.pbd file. This file is typically in the <Agent_Home>/core/config directory.
  2. Remove the BrowserAgentExt.jar file. This file is typically in the <Agent_Home>/core/ext directory.  
  3. Remove the CA Browser Agent properties in the IntroscopeAgent.profile file.
  4. Remove any management modules or typeviews for CA Browser Agent.

Use an Earlier Release Browser Agent with Digital Experience Collector

Valid for: CA APM 10.3

For a Release 10.3 Java Agent, manual and automatic snippet injection are supported with the latest snippet format from App Experience Analytics or APM Release 10.5. App Experience Analytics or APM loads the latest Browser Agent JavaScript. If you want to have Browser Agent data in APM, use the following steps to point the 10.3 agent to the Digital Experience Collector. Otherwise, this configuration allows the App Experience Analytics or APM 10.5 snippet.

Note: The following steps disable Browser Agent metric/trace reporting to APM. App Experience Analytics or APM 10.5 Browser Agent JavaScript is not compatible with APM 10.3 Browser Agent data collection by the Java agent. App Experience Analytics or APM 10.5 require a Digital Experience Collector from either App Experience Analytics or APM to receive data. If APM 10.5 is not receiving Browser Agent data from Digital Experience Collector, then transaction traces, APM Team Center and Investigator metrics are not represented with Browser Agent-specific information. In this case, App Experience Analytics transaction trace drill-down integration correlates to the Servlet or Business Segment using the Correlation ID provided by the Browser Agent cookie.

Follow these steps:

  1. Ensure that the Java Agent is installed and Browser Agent is configured.
  2. Copy the snippet.js file from the <Agent_Home>/examples/APM/BrowserAgent/js directory. Save the snippet.js file in your local directory.
    Do one of the following changes:
    For automatic injection: Open the snippet.js file and replace all the contents with the App Experience Analytics or Digital Experience Collector snippet. Save and close the file.
    For manual injection: Open the snippet.js file and delete all the contents. Save and close the file.
  3. Go to <Agent_Home>/core/config and open the IntroscopeAgent.profile file in a text editor.
  4. Add the following property in the IntroscopeAgent.profile file to point to the local file:
    
introscope.agent.browseragent.snippetLocation=<Path_To_File>/snippet.js

  5. Save the IntroscopeAgent.profile file.

  6. Restart the agent.

Note: If you have custom code in BAExt.js, you must rewrite this code.

More Information:

Add the Snippet to Web Pages

Browser Typeview

A typeview is a construct that WebView uses to present a desired view of metrics. The typeview is associated with metrics that correspond with a selected node in the Investigator tree.

Note: The Digital Experience Collector agents have DXC Agent as the agent process name as a default. If you change the agent process name, the typeview will not be available.

The details of the typeview are in an XML file. The file is available for browser metrics:

<EM_HOME>/ext/xmltv/businesssegment.typeviewers.xml

(Optional) Use the Legacy Browser Typeview

Valid for: 10.3 agents

You can download the older version of the typeview and use the legacy browser typeview. This capability supports older agents which do not use updated browser page load metric names. Non-DXC Agents show the older version of the typeview.

Follow these steps:

  1. Go to CA APM Community DOC-231171772 document. 
  2. Save the businesssegment.legacyBrowserMetricnames.tv.xml file to this location:

    <EM_HOME>/ext/xmltv/  
  3. Restart WebView.
  4. In the WebView Investigator, navigate to the Business Segment node, and then click the Browser tab. Verify that the desired browser metrics appear.
Was this helpful?

Please log in to post comments.

  1. Adrien Stozicky
    2017-11-15 08:06

    Hi the Browser Agent Profile Management Hyperlink is redirecting to a wrong page

    1. Carey Feldstein
      2017-12-15 01:35

      Hi Adrien,

      I corrected the link.

      Thank you for your feedback!

      Carey

  2. Adrien Stozicky
    2018-04-09 06:44

    "Follow the instructions in the CA App Experience Analytics documentation for updating the profile and the extension file." It would be nice to add a link redirecting to the right AXA documentation

    1. Carey Feldstein
      2018-04-10 12:52

      Hi Adrien,

      I added a link to the AXA documentation.

      Thanks,

      Carey