Docker plugin

This plugin collects metrics from Docker.

Prerequisites

Meter 4.2 or later must be installed.

The Docker plugin 1.7.1 or later supports the following Operating System.

Linux(tick)

To install the plugin

  1. From the top right of the screen, perform one of the following actions:
    • Click Settings > Data Collection, select the TrueSight meter, and select the Sources tab.

    • Click Settings > Configure Sources.
  2. Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
  3. Click the name of the source to view source details.
  4. Select the Plugins tab.
  5. Use the search box or scroll through the page to find the plugin you want to install.
  6. Click + Install to start the installation.

    Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.

 Plugin Setup

Run Docker in deamon mode binded to a host and port.

To update Docker to run in deamon mode on Ubuntu

  1. Edit /etc/default/docker.
    Add DOCKER_OPTS="-H 127.0.0.1:2375"
  2. Restart the service.
    $ sudo service docker restart

To update Docker to run in deamon mode on CentOS 6.x & RHEL 6.x

  1. Edit /etc/sysconfig/docker .
    Add OPTIONS="-H 127.0.0.1:2375"
  2. Restart the service.
    $ sudo service docker restart

To update Docker to run in deamon mode on CentOS 7.x & RHEL 7.x

  1. Log on to your host as a user with sudo or root privileges.
  2. Create the /etc/systemd/system/docker.service.d directory.
    $ sudo mkdir /etc/systemd/system/docker.service.d
  3. Create a /etc/systemd/system/docker.service.d/docker.conf file.
  4. Open the file with an editor.
    $ sudo vi /etc/systemd/system/docker.service.d/docker.conf
  5. Override the ExecStart configuration from your docker.service file to customize the docker daemon. To modify the ExecStart configuration, specify an empty configuration followed by a new one.
    [Service]

    ExecStart=

    ExecStart=/usr/bin/docker daemon -H tcp://127.0.0.1:2375 -H unix:///var/run/docker.sock
  6. Save the changes.
  7. Flush changes.
    $ sudo systemctl daemon-reload
  8. Restart the Docker daemon.
    $ sudo systemctl restart docker

To install the plugin

  1. From the top right of the screen, perform one of the following actions:
    • Click Settings > Data Collection, select the TrueSight meter, and select the Sources tab.

    • Click Settings > Configure Sources.
  2. Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
  3. Click the name of the source to view source details.
  4. Select the Plugins tab.
  5. Use the search box or scroll through the page to find the plugin you want to install.
  6. Click + Install to start the installation.

    Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.

Configuration details

Field NameDescription
HostThe Docker Daemon hostname
PortThe Docker Daemon port
ContainersFilter containers by name. If empty, it will show all containers
Poll IntervalHow often (in milliseconds) to poll for metrics
SourceThe source to display in the legend for the data.

Advanced configuration

To customize this plugin, see Docker plugin on GitHub.

Plugin metrics

Metric NameDescription
DOCKER_TOTAL_CPU_USAGETotal cpu usage, total and per running containers
DOCKER_MEMORY_USAGE_BYTESTotal memory usage, total and per running containers
DOCKET_MEMORY_USAGE_PERCENTMemory usage percentage.
DOCKER_NETWORK_TX_BYTESTotal network transmit bytes
DOCKER_NETWORK_RX_BYTESTotal network received bytes
DOCKER_NETWORK_TX_PACKETSTotal network transmit packets
DOCKER_NETWORK_RX_PACKETSTotal network received packets
DOCKER_NETWORK_TX_ERRORSTotal network transmit errors
DOCKER_NETWORK_RX_ERRORSTotal network received errors
DOCKER_BLOCK_IO_READ_BYTESTotal number of Block IO reads bytes
DOCKER_BLOCK_IO_WRITE_BYTESTotal number of Block IO writes bytes


Was this page helpful? Yes No Submitting... Thank you

Comments