Integrate with CA Application Performance Management

CA Application Performance Management (APM) monitors end-user business services and transactions.  provides the transaction context and metadata for each request to an application that CA APM monitors. Upon integration, the Business Transaction and Services context moves from  to CA APM. The end-user experience is then shown based on the originating device platform in CA APM WebView. Monitoring this data helps you to identify performance problems for an application at any time during its execution. Early detection of a problem helps you to address the problem before degraded performance affects the users.
caaxa164
CA Application Performance Management (APM) monitors end-user business services and transactions. 
Application Performance Management
provides the transaction context and metadata for each request to an application that CA APM monitors. Upon integration, the Business Transaction and Services context moves from 
Application Performance Management
to CA APM. The end-user experience is then shown based on the originating device platform in CA APM WebView. Monitoring this data helps you to identify performance problems for an application at any time during its execution. Early detection of a problem helps you to address the problem before degraded performance affects the users.
Application Performance Management
 analyzes the performance that is based on different parameters. The parameters can be top performing transactions, slow transactions, total number of occurrences of a transaction, failed, or crashed transactions. If the application transaction crashes because of a back-end issue, then 
Application Performance Management
correlates the crash details with the CA APM parameters. You can thus track the issue end-to-end. 
This article contains the following topics:
If you installed CA APM already but did not install CA App Experience Analytics, you can enable the integration when installing 
Application Performance Management
. This article covers only the 
Application Performance Management
configurations that you must perform to enable this integration. For more information about how to configure CA APM, see CA APM Documentation.
Review the Integration Prerequisites
Before you integrate 
Application Performance Management
 with CA APM, verify the following prerequisites:
  • Application Performance Management
     is installed. 
  • Applications (mobile and web) to be monitored are integrated with 
    Application Performance Management
     SDK.
  • CA APM is installed. For more information, see the CA APM documentation
    The CA APM implementation includes:
    • WebView
    • A deployed Java or .Net agent that monitors the back-end application with which the native mobile app communicates.
Understand How Integration Works
Application Performance Management
 annotates the HTTP calls that applications make with an external CA APM Application Transaction by injecting a header parameter
x-apm-bt
. This parameter names the application service and transaction that the request belongs to. The parameter also encodes data that is relevant to the transaction. CA APM then processes this header to identify the transaction that these requests belong to.
The
x-apm-bt
header parameter consists of two segments that a dollar sign ($) separates. The two segments consist of several semicolon-separated attributes. The second segment of the parameter contains the identifying attributes of the transaction and follows a specified order. The header parameter structure is as follows:
x-apm-bt:t=<MAA-TenantID>;d=<UDID>;v=<MAA-SDK-Version>;n=<NetworkNAME>;l=<LinkType>;g=<GeographicalLocation>;a=<AppNAME>$bs=<BusinessServiceName>;bt=<BusinessTransactionName>;p=<PlatformNAME>;pv=<PlatformVersion>
Example: HTTP Header Parameter
x-apm-bt:t=4F2504E0-4F89-9B0C-0305E82C2301;d=2b6f0cc904d137be2e1730235f5664094b831186;v=1.0;n=ATT;l=3g;g=36.9125,30.6897222;a=Trade App$bs=Trade App;bt=BuyOptions;p=iOS;pv=7.1
The following table lists the attributes of the header and what they identify.
Attribute Name
Description
Required
t
CA SaaS tenant.
No
d
Unique ID of the device that is used for the transaction.
No
v
Version of the 
Application Performance Management
SDK that is integrated with the app.
No
n
Network provider that the originator device is connected to, at the time of the request. For example, Verizon, AT&T.
No
l
Network connection type that the originator device was utilizing at the time of the request. For example, WiFi, LTE.
No
g
Comma-separated values for longitude and latitude, indicating where the transaction originated.
No
a
Application name as registered with
Application Performance Management
.
No
bs
Parent Business Service Name for this request. This value is the copy of the mobile application name or the name that is used to register the app.
Yes
bt
Parent Business Transaction Name for this request.
Yes
p
Operating system of the device. For example, iOS7 or Android.
No
pv
Operating system version of the device. For example, 4 or 7.1.
No
Enable the Integration
You can enable the integration during or after the installation.
These steps are applicable only to integrate
Application Performance Management
16.4.2 and CA APM 10.5, CA APM 10.5.1, or CA APM 10.5.2.
Enable During Installation Using the Installer
Type Yes to integrate when prompted during the
Application Performance Management
 installation and provide the following information:
  • CA APM version
  • CA APM Webview URL. For example, http(s)://<webview_host>:<webview_port>
  • Enterprise Manager hostname
  • Enterprise Manager listening port
Enable After Installation
This section describes the steps to enable integration after the installation. Perform these steps if you have typed No to integrate during the 
Application Performance Management
 installation.
  • CA APM is installed with Digital Experience Collector
    Perform these steps only if you have installed CA APM with Digital Experience Collector.
Follow these steps:
    1. Navigate to the <
      ExperienceCollectorBundle>/integration
       directory.
    2. Run the following command: 
      ./apm-axa-integration.sh
    3. Provide the following information that you collect about
      Application Performance Management
      :
      • Specify the AXA TENANT ID. Tenant Id from the
        Application Performance Management
         Snippet. For example, C8215398-4D0D-7A47-D1ED-77FD4B6C635C
      • Specify the AXA COLLECTOR URL. (
        Application Performance Management
        (CA Experience Collector) Collector host and Port). For example: http://apm-axa-integration:7081
      • Specify the AXA APP_ID. For example, my app
    4. Navigate to the
      bin
      directory of CA APM home.
    5. Execute the 
      configureGlobalAPM.sh
       file with the following arguments.
      ./configureGlobalAPM.sh -u tadmin -p admin@12 -a http://localhost:9080 -t tenant1 -m http://localhost:8080 -v 10.5.2
      Arguments:
      -u
      Admin username for 
      Application Performance Management
      -p
      Admin password for 
      Application Performance Management
      -a
      Application Performance Management
      URL
      -t
      Application Performance Management
      tenant name
      -m
      WebView URL. If the Context path is used, append the path to the WebView URL
      -v
      CA APM version number
       For more information about CA Digital Experience Collector, see CA Digital Experience Collector.
  • CA APM is installed without Digital Experience Collector 
    If you installed CA APM without Digital Experience Collector, navigate to where Digital Experience Collector for 
    Application Performance Management
     is installed and run the following script:
./axaInstaller.sh -apm
Enable the Integration for Versions Prior to 16.4.2
To enable CA App Experience Analytics to track the CA APM transactions originating from the devices, complete the following steps.
This integration is supported on CA APM 9.7, CA APM 10.0, CA APM 10.1, CA APM 10.2, CA APM 10.5, and 10.5.1.
APM URL
The URL to launch CA APM UI is constructed based on the following parameters:
  • CA APM host name and port (static). This information comes from the application specific configuration.
  • Business Service and Business Transaction (dynamic). This information is the TradeService and TradeOptions that is known to 
    Application Performance Management
     at runtime.
    http://'$APMHost:port'/ApmServer/#/map?ep=0&g=PE2&m=H&cht=0&chs=1&cha=0&u=&ts1={starttime}&ts2={endtime}&fa =[{"n":"bsf","o":"AND","v":["{bsname}"]},{"n":"trf","o":"AND","v":["{btname}+via+{platform}+{platform_major_version}"]}]
    For each Tenant/App, the 
    APMHostPort
     is fetched from the 
    MDO_TENANT_APP_CONFIG
     table. The transaction values replace the
     bsname
    btname
    starttime
    endtime
    duration
    platform
    , and 
    platform version
    .
APM Correlation URL
You can also navigate from a transaction in the 
Application Performance Management
 Administration UI to the transaction trace into CA APM WebView using CrossBrowserGUID.
http://'$APMHostPort'/#tools;tab-to=he;tr=0;lsq=CorCrossProcessData%253A{corrId}+or+CorBrowsGUID%253A{corrId}
Follow these steps:
  1. Go to the App Profile.
  2. In the Network Performance section, select 
    Send data to CA APM.
    This image displays the option to configure APM.
  3. Click APM SETUP.
  4. In the Set APM URL page, enter the APM host URL and select the CA APM configuration. For example, http://apm-atc.demo.ca.com:8082
    This image displays where to enter the APM host URL and the CA APM configuration.
  5. Click GENERATE URL to generate the complete URL.
  6. Click SAVE.
  7. (Optional) You can update the paths in the APM URL and APM Correlation URL and click SAVE to save the APM configuration for the tenant app.