Install and Configure Docker Monitor

Install Docker Monitor in your Docker environment. You need one Docker Monitor per standalone setup, or one Docker Monitor for each Docker Universal Control Plane (UCP) setup. You can install the monitor on a separate computer as long as the computer has access to the UCP setup master node. You can also use alias agent properties for certain settings.
apmdevops106
Install Docker Monitor in your Docker environment. You need one Docker Monitor per standalone setup, or one Docker Monitor for each Docker Universal Control Plane (UCP) setup. You can install the monitor on a separate computer as long as the computer has access to the UCP setup master node. You can also use alias agent properties for certain settings.
Install and Configure
Install and configure Docker Monitor for your environment.
Follow these steps:
  1. Download the image:
    docker pull caapm/dockermonitor:latest
  2. Download the YML file that corresponds to your platform to the location of your choice.
    • If you are using CA Application Performance Management (APM) on premise, use the following 
      install.yml
       file:
      250
    • If you are using CA Digital Experience Insights Application Performance Management, use the 
      install.yml
       file that is included with the installation instructions on your CA Digital Experience Insights instance.
  3. (CA APM on premise) Replace the following variable with your setup details, and save the YML file.
    • [AGENT_MANAGER_URL]
      Agent/EM Connection details - similar to the connection details provided in 
      IntroscopeAgent.profile
      .
  4. (Optional) In addition to the environment variables provided in the YML file, you can use the properties in the Infrastructure Agent profile to configure your environment. For more information about the Infrastructure Agent properties, see the Infrastructure Agent Properties Reference.
    To pass an Infrastructure Agent property as an environment variable through the
    install.yml
    file, append the variable to the end of the
    environment
    section. The YML format does not allow you to use the "." separator in property names. You must replace the periods in the property names with underscores. For example, to configure the agent name and a proxy server, you use the 
    introscope.agent.agentName
    and 
    introscope.agent.enterprisemanager.transport.http.proxy.host
    properties as  follows:
    environment:       - agentManager_url_1=[AGENT_MANAGER_URL]       - containerflow=enabled       - interval=90       - type=Docker       - introscope_agent_agentName=example_agent_name       - introscope_agent_enterprisemanager_transport_http_proxy_host=example_proxy_server.com 
  5. (Optional) When you install Host Monitor, host-related information in the Component View includes the
    StorageName
    metric. On UNIX/Linux systems, you can set storage filters to configure the mount points that appear associated to this metric. Use the following environment variables 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, which are separated by commas, on one line.
    • 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
      .
    Example
    You can hide the
    /host/home
    mount point but include all the mount points listed for the
    storage_outofbox_filter_enabled
    filter. To do so, add the environment variables to the environment variables section in the YML file:
    environment:
          - agentManager_url_1=[AGENT_MANAGER_URL]
          - containerflow=enabled
          - interval=90
          - type=Docker
          - storage_mount_filter=/host/home
          - storage_outofbox_filter_enabled=no
     
  6. (Optional) You can configure the
    xms
    and
    xmx
    parameters of the JVM in which the Infrastructure Agent runs using the following environment variables:
      • MIN_HEAP_VAL_IN_MB
        Default:
        256
      • MAX_HEAP_VAL_IN_MB
        Default:
        512
    You can use the YML file to update the Java heap values. For example:
    environment:
          - agentManager_url_1=[AGENT_MANAGER_URL]
          - containerflow=enabled
          - interval=90
          - type=Docker
          - MIN_HEAP_VAL_IN_MB=335
          - MAX_HEAP_VAL_IN_MB=670
  7. Run the file using one of the following commands:
    • To install Docker Monitor on each node of a Swarm/UCP setup, run this command on the Swarm manager only. The Swarm manager pushes the Docker Monitor to each node in the Docker cluster.
      docker stack deploy -c install.yml dockermonitor --with-registry-auth
    • To install Docker Monitor in a standalone setup, run this command:
      docker-compose -f install.yml up -d
Uninstall Docker Monitor
UiInstall Docker Monitor in your Docker environment. Use one of the two following commands depending on your Docker Monitor setup: Standalone or UCP.
Uninstall in Swarm or UCP Setup
Use the following command for a Swarm/UCP setup:
docker stack deploy -c uninstall.yml uninstall-apm
Uninstall in Standalone Setup
Use the following command for a standalone setup:
docker-compose -f uninstall.yml up -d
The content of the
uninstall.yml
 file appears as follows:
version: "3"
services:
dockermonitor:
image : caapm/dockermonitor:latest
command: ["sh","uninstall.sh"]
deploy:
mode: global
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /dev:/host/dev:ro
- /sys:/host/sys:ro
- /boot:/host/boot:ro
- /home:/host/home:ro
- /run:/host/run:ro
- /var:/host/var:ro
- /proc:/host/proc:ro
Use Agent Properties
Certain agent properties have aliases that you can use to configure the agent. The functions of the properties that are listed in the same row of the following table are the same. Any properties in the same row can be used interchangeably.
Alias Properties
Property Description
Default Value
docker.interval.seconds
interval
com.ca.apm.docker.monitor.polling.interval
Sets the Data Collection Report interval.
120 seconds
type
monitoring.type
com.ca.apm.docker.monitor.type
Indicates the monitoring type.
DockerMonitor
containerflow
com.ca.apm.docker.monitor.containerflow
Indicates whether the Containerflow module is enabled or disabled.
enabled
docker.skip.stopped.container
com.ca.apm.docker.monitor.skip.stopped.container
Skips the monitoring for the Stopped container.
false
com.ca.apm.docker.swarm.task.max.default.instance
Sets the maximum number of Swarm Tasks or Docker Project Service instances that show in the Metrics Tree. Any Instances over the set maximum appear under the TaskDefault node in the Metrics Tree.
default: 5