isabella232 / meter-plugin-docker

TrueSight Pulse Docker Meter Plugin

Collects metrics from the Docker daemon using the remote api.

Prerequisites

OS	Linux	Windows	SmartOS	OS X
Supported	v	-	-	-

This plugin is compatible with Docker 1.7.1 or later.

TrueSight Pulse Meter versions v4.2 or later

• To install new meter go to Settings->Installation or see instructions.
• To upgrade the meter to the latest version - see instructions.

Plugin Setup

Docker must run in deamon mode binded to a host and port. Follow the instructions below:

For Ubuntu:

Edit /etc/default/docker and add DOCKER_OPTS="-H 127.0.0.1:2375" & restart the service

$ sudo service docker restart

For CentOS 6.x & RHEL 6.x:

Edit /etc/sysconfig/docker and add OPTIONS="-H 127.0.0.1:2375" & restart the service

$ sudo service docker restart

For CentOS 7.x & RHEL 7.x:

1. Log into 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 your favorite 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 you have to specify an empty configuration followed by a new one as follows:

[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

Plugin Configuration Fields

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.

Metrics Collected

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

Dashboards

• Docker Summary

References

https://docs.docker.com/reference/api/docker_remote_api/

https://docs.docker.com/engine/admin/configuring/