Skip to main content

Docker Engine collector

Docker Engine is the industry’s de facto container runtime that runs on various Linux (CentOS, Debian, Fedora, Oracle Linux, RHEL, SUSE, and Ubuntu) and Windows Server operating systems.

This module will monitor one or more Docker Engines applications, depending on your configuration.

Requirements

Metrics

All metrics have "docker_engine." prefix.

MetricScopeDimensionsUnits
engine_daemon_container_actionsglobalchanges, commit, create, delete, startactions/s
engine_daemon_container_states_containersglobalrunning, paused, stoppedcontainers
builder_builds_failed_totalglobalbuild_canceled, build_target_not_reachable_error, command_not_supported_error, dockerfile_empty_error, dockerfile_syntax_error, error_processing_commands_error, missing_onbuild_arguments_error, unknown_instruction_errorfails/s
engine_daemon_health_checks_failed_totalglobalfailsevents/s
swarm_manager_leaderglobalis_leaderbool
swarm_manager_object_storeglobalnodes, services, tasks, networks, secrets, configsobjects
swarm_manager_nodes_per_stateglobalready, down, unknown, disconnectednodes
swarm_manager_tasks_per_stateglobalrunning, failed, ready, rejected, starting, shutdown, new, orphaned, preparing, pending, complete, remove, accepted, assignedtasks

Configuration

Edit the go.d/docker_engine.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_engine.conf

Needs only url to docker metric-address. Here is an example for 2 docker instances:

jobs:
- name: local
url: http://127.0.0.1:9323/metrics

- name: remote
url: http://203.0.113.10:9323/metrics

For all available options, please see the module's configuration file.

Troubleshooting

To troubleshoot issues with the docker_engine 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.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m docker_engine

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