Skip to main content

Docker collector

Docker Engine is an open source containerization technology for building and containerizing your applications.

This module monitors one or more Docker Engine instances, depending on your configuration.

Metrics

  • All metrics have "docker." prefix.
  • container_writeable_layer_size needs collect_container_size: yes. Enabling this may result in high CPU usage depending on the version of Docker Engine.

Labels per scope:

  • global: no labels.
  • container: container_name, image.
MetricScopeDimensionsUnits
containers_stateglobalrunning, paused, stoppedcontainers
containers_health_statusglobalhealthy, unhealthy, not_running_unhealthy, starting, no_healthcheckcontainers
imagesglobalactive, danglingimages
images_sizeglobalsizebytes
container_statecontainerrunning, paused, exited, created, restarting, removing, deadstate
container_health_statuscontainerhealthy, unhealthy, not_running_unhealthy, starting, no_healthcheckstatus
container_writeable_layer_sizecontainerwriteable_layersize

Configuration

Edit the go.d/docker.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/docker.conf
jobs:
- name: local
address: 'unix:///var/run/docker.sock'
collect_container_size: no

- name: remote
address: 'tcp://203.0.113.10:2375'
collect_container_size: no

For all available options see module configuration file.

Troubleshooting

To troubleshoot issues with the docker collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

First, navigate to your plugins' directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now run the go.d.plugin to debug the collector:

./go.d.plugin -d -m docker

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.