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 | ✅️ |
To install the plugin
- From the top right of the screen, perform one of the following actions:
- Click
> Data Collection, select the TrueSight meter, and select the Sources tab. - Click > Configure Sources.
- Click
- 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.
- Click the name of the source to view source details.
- Select the Plugins tab.
- Use the search box or scroll through the page to find the plugin you want to install.
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
- Edit /etc/default/docker.
Add DOCKER_OPTS="-H 127.0.0.1:2375" - Restart the service.
$ sudo service docker restart
To update Docker to run in deamon mode on CentOS 6.x & RHEL 6.x
- Edit /etc/sysconfig/docker .
Add OPTIONS="-H 127.0.0.1:2375" - Restart the service.
$ sudo service docker restart
To update Docker to run in deamon mode on CentOS 7.x & RHEL 7.x
- Log on to your host as a user with sudo or root privileges.
- Create the /etc/systemd/system/docker.service.d directory.
$ sudo mkdir /etc/systemd/system/docker.service.d - Create a /etc/systemd/system/docker.service.d/docker.conf file.
- Open the file with an editor.
$ sudo vi /etc/systemd/system/docker.service.d/docker.conf - 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 - Save the changes.
- Flush changes.
$ sudo systemctl daemon-reload - Restart the Docker daemon.
$ sudo systemctl restart docker
To install the plugin
- From the top right of the screen, perform one of the following actions:
- Click > Data Collection, select the TrueSight meter, and select the Sources tab.
- Click > Configure Sources.
- Click
- 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.
- Click the name of the source to view source details.
- Select the Plugins tab.
- Use the search box or scroll through the page to find the plugin you want to install.
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 Name | Description |
|---|---|
Host | The Docker Daemon hostname |
Port | The Docker Daemon port |
Containers | Filter containers by name. If empty, it will show all containers |
Poll Interval | How often (in milliseconds) to poll for metrics |
Source | The source to display in the legend for the data. |
Plugin metrics
Metric Name | Description |
|---|---|
DOCKER_TOTAL_CPU_USAGE | Total cpu usage, total and per running containers |
DOCKER_MEMORY_USAGE_BYTES | Total memory usage, total and per running containers |
DOCKET_MEMORY_USAGE_PERCENT | Memory usage percentage. |
DOCKER_NETWORK_TX_BYTES | Total network transmit bytes |
DOCKER_NETWORK_RX_BYTES | Total network received bytes |
DOCKER_NETWORK_TX_PACKETS | Total network transmit packets |
DOCKER_NETWORK_RX_PACKETS | Total network received packets |
DOCKER_NETWORK_TX_ERRORS | Total network transmit errors |
DOCKER_NETWORK_RX_ERRORS | Total network received errors |
DOCKER_BLOCK_IO_READ_BYTES | Total number of Block IO reads bytes |
DOCKER_BLOCK_IO_WRITE_BYTES | Total number of Block IO writes bytes |