On Premise Installation

Follow these steps to use the on-premise CA APM version for API monitoring.
caapipm34
Follow these steps to use the on-premise CA APM version for API monitoring.
Step 1: Download the Solution Kit
CA API Gateway components are installed by a single solution kit that contains all the assertions, policies, tasks, and cluster‐wide properties. If you have or more cluster of gateways, you need to install this Solution Kit has on each cluster.
Download and extract CA Precision API Monitoring 3.4 (GEN500000000002237.zip) package from the Broadcom Support site. Verify that CA API Management and CA Application Performance Management integration kit (
CA-Precision-API-Monitoring-3.4-Module-for-API-Gateway.sskar
) is available for use.
Step 2: Install the CA API Gateway Components
To enable the integration with CA API gateway, installation of the following components is required on each CA API Gateway appliance, even if clustered:
Component
Purpose
OS Metric Perl scripts
Collect OS and database‐level metrics for gateway
appliances and sends them to CA APM through the EPAgent.
EPAgent
Installed on the CA API Gateway server. The EPAgent is used to
push collected service, trace, JVM, MySQL, and OS metrics from the CA API Gateway
to the CA APM Enterprise Manager (EM).
Follow these steps:
  1. Open
    CA Gateway Policy Manager
    and log in to your Gateway node.
  2. Click
    Tasks
    ,
    Extensions and Add-Ons
    ,
    Manage Solution Kits
    .
    The Manage Solution Kits dialog opens.
  3. Click
    Install
    and the solution kit installation wizard opens.
  4. To select the
    CA-Precision-API-Monitoring-3.4-Module-for-API-Gateway.sskar
    file, click
    File
    and navigate to the location where the file is located.
  5. Click
    Next
    and the solution kit install selection displays.
  6. Click
    Next
    and the gateway tests the solution kit for any integration conflicts and displays the summary.
    You can view the potential conflicts, if any.
  7. Click
    Finish
    to complete the installation.
  8. Restart the CA Gateway.
  9. Open CA Gateway Policy Manager and log in to your CA API Gateway computer.
  10. Verify that the
    relayGatewayMetrics.enable
    cluster property is set to true. This property enables the Gateway to collect the metrics.
  11. (Optional) Click
    Tasks
    ,
    Global Settings
    ,
    Manage Cluster-Wide Properties
    and edit the following cluster properties:
    • apm.epagent.hostname (default value:
      localhost
      )
    • apm.epagent.tcpport (default value:
      9090
      )
    • apm.epagent.httpport (default value:
      9080
      )
    The Gateway components are installed.
Step 3: Install EPAgent on CA API Gateway
The metrics data from the gateways are passed to the EPAgent, which pushes the data to the CA APM Server.
While it is technically possible to configure communication from a gateway to an EPAgent running on a different server, this configuration is not considered secure and is not supported. And do not install the EPAgent under the root user. Therefore, you must have basic knowledge of how to create a user and change owners on a Linux server.
Follow these steps:
  1. Copy the APIM-PM-GW.tar.gz to the Gateway server and extract the contents as follows:
    tar -xf APIM-PM-GW.tar.gz
    Extract the EPAgent installation files.png
  2. Navigate to the directory where you extracted the content and run install_epagent.sh:
    cd APIM-PM-GW ./install_epagent.sh
  3. Provide the following information when prompted by the installation:image2018-3-28 17:3:33.png
    If you change the default HTTP port from 9080 to another port, you need to make the same change in Policy Manager. This ensures that the gateway passes information to the EPAgent using the correct port. To change the default port number in gateway, click Tasks, Global Settings, Manage Cluster-Wide Properties. Select apm.epagent.httppport and click
    Edit.
  4. Once installed, the EPAgent service starts automatically. You can use the following commands to stop and start the EPAgent service:
    service epagent stop service epagent start
Step 4: Install CA APM Components
To monitor CA API Gateway metrics in CA APM, you need to install the following components on the CA APM server:
Component
Purpose
APM Typeviews (.xml)
Collects and displays metrics in specific views in CA APM WebView and Introscope Workstation. Typeviews determine how CA APM monitors metrics.
API Management Dashboard (.jar)
Combines and presents application metrics in views to monitor the overall application environment.
APM Server‐side JavaScript Calculator (.js)
Ceates virtual metrics in CA APM on the server side, enabling Experience Views and other advanced features of CA APM 10.5
and later.
Follow these steps:
  1. From the extracted CA Precision API Monitoring 3.4 package, copy the APIM-PM-APM.tar.gz to a location on the CA APM server.
  2. Run the following command to extract the APIM-PM-APM.tar.gz file:
    tar -xf APIM-PM-APM.tar.gz
  3. Change directory to the
    APIM-PM-APM
    directory.
    cd APIM-PM-APM
  4. Run the apm_pm_install.sh script as follows:
    ./apm_pm_install.sh
    The script prompts to provide the following configuration information:
    • Absolute path of the APIM-PM-APM folder where you extracted the apim.js, APM-APIM-DashboardAlerts.jar, gateway-typeviewers.xml files on the APM server. For example, /root/CA/APIM-PM-APM
    • Absolute path of the Introscope installation folder. For example, /opt/apm105/Introscope10.5 or /opt/apm107/Introscope10.7
    The installation proceeds to install the APM type views and CA API management dashboard.