Install the Infrastructure Agent

Before installation, you download the . This download contains the Infrastructure Agent and the extensions that you can deploy to provide data about your infrastructure components.
apmdevops106
Before installation, you download the Infrastructure Agent. This download contains the Infrastructure Agent and the extensions that you can deploy to provide data about your infrastructure components.
The Infrastructure installation includes and uses a local installation of the Java Runtime Environment (JRE).
Follow these high-level steps:
2
2
Download the Infrastructure Agent Software
The Infrastructure Agent software is available on CA Support.
Follow these steps:
  1. Locate and download the Infrastructure Agent download file that is appropriate for your operating system:
    • Infrastructure-Agent-<version>-unix.tar.gz
      for UNIX
    • Infrastructure-Agent-<version>-windows.zip
      for Windows
    • Infrastructure-Agent-<version>-mac.tar.gz
      for Mac
The Infrastructure Agent  is supported only for the specific Windows and Linux products that are listed in the Compatibility Guide.
Agents and extensions are available for UNIX, Windows, and Mac operating systems.
Extension Name
Directory Name
UNIX
Windows
Mac
Docker Monitoring
DockerMonitor
yes
no
no
Environment Performance Agent Plug-ins
Not applicable
yes
yes
yes
F5 LTM Monitoring
f5ltmExtension
yes
yes
no
Host Monitoring
HostMonitor
yes
yes
no
Node.js Agent
NodeExtension
yes
yes
yes
PHP Agent
PhpExtension
yes
no
no
Web Server Monitoring
Webserver-monitor
yes
yes
no
Install and Start the Infrastructure Agent
  1. Extract the contents of the Infrastructure-Agent-<version>-<OS> package file to the desired installation location. Use your operating system command to extract the file.
    • UNIX
      : tar xf Infrastructure-Agent-<version>-unix.tar.gz
    • Windows
      : Unzip Infrastructure-Agent-<version>-windows.zip
    • Mac
      : tar xf Infrastructure-Agent-<version>-mac.tar.gz
  2. Install and start the Infrastructure Agent.
    • UNIX
      :  ./apmia-ca-installer.sh install
    • Windows
      : apmia-ca-installer.bat install
    • Mac
      : ./apmia-ca-installer.sh install
    The Enterprise Manager reports details about the Infrastructure Agent connection in its log.
    On UNIX systems, the Infrastructure Agent can be installed as root, super user or as a normal user. The installation script generates an entry in the crontab of the user that runs the script. Before you execute the script, ensure that the user has appropriate crontab permissions. See your operating system's documentation to find out how to set crontab permissions.
  3. (Optional) Use other Infrastructure Agent-related commands.
    • Check the Infrastructure Agent Status
      • UNIX
        :  ./apmia-ca-installer.sh status
      • Windows
        : apmia-ca-installer.bat status
      • Mac
        : ./apmia-ca-installer.sh status
    • Stop the Infrastructure Agent
      • UNIX
        :  ./apmia-ca-installer.sh stop
      • Windows
        : apmia-ca-installer.bat stop
      • Mac
        : ./apmia-ca-installer.sh stop
    • Start the Infrastructure Agent
      • UNIX
        :  ./apmia-ca-installer.sh start
      • Windows
        : apmia-ca-installer.bat start
      • Mac
        : ./apmia-ca-installer.sh start
    • Restart the Infrastructure Agent
      • UNIX
        :  ./apmia-ca-installer.sh restart
      • Windows
        : apmia-ca-installer.bat restart
      • Mac
        : ./apmia-ca-installer.sh restart
    • Uninstall the Infrastructure Agent and SystemEdge
      • UNIX
        :  ./apmia-ca-installer.sh uninstall
      • Windows
        : apmia-ca-installer.bat uninstall
      • Mac
        : ./apmia-ca-installer.sh uninstall
    • Perform a Clean Uninstallation of the Infrastructure Agent
      This command uninstalls the Infrastructure Agent and SystemEDGE, and removes Infrastructure Agent directories when a directory name is
      apmia
      .
      • UNIX
        :  ./apmia-ca-installer.sh clean_uninstall
      • Windows
        : apmia-ca-installer.bat clean_uninstall
      • Mac
        : ./apmia-ca-installer.sh clean_uninstall
    • Force-Start the Infrastructure Agent
      The
      force_start
      command runs the Infrastructure Agent in a non-service based manner, without installing the agent.On Windows, the Infrastructure Agent does not start Host Monitoring when using the
      force_start
      command. On UNIX,
      force_start
      starts Host Monitoring.
      • UNIX
        :  ./apmia-ca-installer.sh force_start
      • Windows
        : apmia-ca-installer.bat force_start
      • Mac
        : ./apmia-ca-installer.sh force_start
    • Force-Stop the Infrastructure Agent
      On Windows, the
      force_stop
      command stops an Infrastructure Agent instance that was initiated by
      force_start
      .
      On UNIX and Mac , use the
      stop
      command to stop an Infrastructure Agent instance that was initiated by
      force_start
      .
      • UNIX
        :  ./apmia-ca-installer.sh stop
      • Windows
        : apmia-ca-installer.bat force_stop
      • Mac
        : ./apmia-ca-installer.sh stop
    • Get Installer Script Usage Information
      This command shows the usage for the Infrastructure Agent installer script.
      • UNIX
        :  ./apmia-ca-installer.sh -help
      • Windows
        :  ./apmia-ca-installer.bat help
      • Mac
        :  ./apmia-ca-installer.sh -help
  4. (CA Application Performance Management on premise) To deploy an agent or extension that the Infrastructure Agent provides, configure the Extensions.profile file.
    By default, these agents and extensions are disabled. Enable them by configuring the
    introscope.agent.extensions.bundles.load
    property in the Extensions.profile file before starting the Infrastructure Agent.
    1. Navigate to the the
      extensions
      directory
    2. Open the Extensions.profile file using a text editor.
    3. Add the extension name to the
      introscope.agent.extensions.bundles.load
      property. Use the name of the extension directory in the
      apmia/extensions
      directory. For example,
      introscope.agent.extensions.bundles.load=HostMonitor
      Use commas to separate multiple extension entries. For example,
      introscope.agent.extensions.bundles.load=HostMonitor, Webserver-monitor, ContainerFlow, DockerMonitor, f5ltmExtension, NodeExtension, PhpExtension
    4. Save the file.
    5. Restart the Infrastructure Agent
Troubleshoot the Infrastructure Agent Installation
Symptom:
An Infrastructure Agent installation fails due to an existing corrupted Infrastructure Agent installation.
(UNIX only)
Solution:
  1. Find the service for APMIA, and kill the service using this command:
    ps -elf | grep UnifiedMonitoringAgent.jar
  2. Run this command:
    crontab -e
  3. Delete the entry for APM IA.
  4. Reinstall the Infrastructure Agent.
Review the Installation Log
Follow these steps:
  1. Navigate to
    apmia/APMIA_install.log
    .
  2. Review the log for error messages.
Infrastructure Agent Directory Structure
The Infrastructure Agent uses specific directories for installation, uninstallation, upgrade, and rollback. When you install the Infrastructure Agent, CA APM creates the extensions, backup, and deploy sub-directories.
When you extract the Infrastructure Agent, CA APM creates these directories.
<
apmia
>
  • bin
  • CASystemEdge
    - contains CASystemEdge, a component of CA APM Hosting Monitoring
  • core/config
    - contains the Infrastructure.Agent.profile file
  • extensions
    – contains subdirectories and a file to manage agent extensions.
    • backup
      - contains the previous versions of .tar.gz files for uninstalled, upgraded, and rolled back agent extensions.
    • deploy
      - contains deployment and tar.gz files for all extensions that are placed into the
      deploy
      directory
    • Extensions.profile
      - contains the list of deployed extensions
When you install an extension, CA APM creates the extension directory and subdirectories.
  • <
    apmia
    >
    • bin
    • CASystemEdge
    • core/config
    • extensions
      • backup
      • deploy
      • <
        extension_directory
        >
        - contains the  bundle.properties, and
        README.md
        files.
        • config
          - Can contain an extension-specific properties file. For example,
          F5Monitor.properties
        • lib -
          contains the
          <extension_name>.jar
          file
        • metadata
          - contains the
          bundle.json
          ,
          description.md
          , and
          installinstructions.md
          files that the APM Command Center uses after importing agent extensions. You can review the
          description.md
          and
          installinstructions.md
          files in a text editor for extension information
        • bundle.properties
          - contains the extension-specific agent properties file.
      • Extensions.profile
Configure the Infrastructure Agent
You configure the Infrastructure Agent using the Infrastructure agent IntroscopeAgent.profile. The Infrastructure agent profile also contains EPAgent plug-in properties.
Follow these steps:
  1. Navigate to the
    <apmia>/Infrastructure_Agent-<version>/core/config
    directory.
  2. Open the
    IntroscopeAgent.profile
    in a text editor.
  3. Configure agentManager.url.1=<URL>
  4. Save and close the file.
Configure the Infrastructure Agent Heap Size
You can configure the
xms
and
xmx
parameters of the JVM in which the Infrastructure Agent runs using either command line parameters or environment variables.
Configure Heap Size Using Command Line Parameters
Run the APMIA install script including min_heap and max_heap parameters:
  • UNIX
    :  ./apmia-ca-installer.sh install min_heap=<value> max_heap=<value>
  • Windows
    : apmia-ca-installer.bat install min_heap <value> max_heap <value>
  • Mac
    : ./apmia-ca-installer.sh install min_heap=<value> max_heap=<value>
By default, min_heap is 256 and max_heap is 512. You can use the installer script to update java heap values on start and restart.
Configure Heap Size Using Environment Variables
Alternatively, you can use the following environment variables to set the heap size values. Once configured, the values are picked up by the installation script when you run it.
  • MIN_HEAP_VAL_IN_MB
  • MAX_HEAP_VAL_IN_MB
For example on Linux:
$ export MIN_HEAP_VAL_IN_MB=256
$ export MAX_HEAP_VAL_IN_MB=512
Heap size values provided on the command line override the environment variables.
(Linux) Configure Storage Filters
On UNIX/Linux systems, you can enable storage filters to configure the mount points that will be taken into account and displayed for the
StorageName
metric. You set storage filters using either environment variables or Host Monitor bundle properties.
Set Storage Filters Using Environment Variables
The following environment variables are available to set storage filters:
  • storage_mount_filter
    A variable to specify mount points that you want to remove from consideration for the
    StorageName
    metric. You can specify either one mount point per line, or multiple mount points, separated by commas, on one line. For example:
    $ export storage_mount_filter=/dev $ export storage_mount_filter=/run
    or
    $ export storage_mount_filter=/dev,/run
  • storage_outofbox_filter_enabled
    An out-of-the-box filter that, when enabled, filters out the following mount points:
    • devicemapper/mnt
    • docker/containers
    • docker/devicemapper
    • docker/
    • kubelet/pods
    • openshift.local.volumes
    This filter is enabled by default. To disable it, set its value to "no":
    $ export storage_outofbox_filter_enabled=no
Set Storage Filters Using Host Monitoring Bundle Properties
Alternatively, you can use Host Monitoring bundle properties to configure the storage filters. Follow these steps:
  1. Open the
    apmia/extensions/HostMonitor/bundle.properties
    file in a text editor.
  2. Add the following properties:
    • storage.mount.filter
    • storage.outofbox.filter.enabled
    These properties work just like the environment variables described in the previous section.
  3. Set the properties values to configure the mount points that you want to remove from the StorageName metric. These points do not appear in
    Metric View
    . For example:
    storage.mount.filter=/dev storage.outofbox.filter.enabled=no
    When both environment variables and bundle properties are set, environment variables override bundle properties.
    : When Host Monitoring is deployed in a Docker, OpenShift, or Kubernetes environment, you pass the environment variables in the corresponding .yml installation file. For more information, see:
  4. You must restart the Infrastructure Agent after you update the
    boundle.properties
    of the HostMonitor.
Configure and Troubleshoot Extensions
You configure properties for individual extensions using their respective bundle.properties file that is located in the
<apmia>/extensions/<extension_name>
directory.
See the individual agents and extensions for specific configuration and troubleshooting instructions.
More information: