docker_engine

README

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

• Docker with enabled metric-address

Metrics

All metrics have "docker_engine." prefix.

Metric	Scope	Dimensions	Units
engine_daemon_container_actions	global	changes, commit, create, delete, start	actions/s
engine_daemon_container_states_containers	global	running, paused, stopped	containers
builder_builds_failed_total	global	build_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_error	fails/s
engine_daemon_health_checks_failed_total	global	fails	events/s
swarm_manager_leader	global	is_leader	bool
swarm_manager_object_store	global	nodes, services, tasks, networks, secrets, configs	objects
swarm_manager_nodes_per_state	global	ready, down, unknown, disconnected	nodes
swarm_manager_tasks_per_state	global	running, failed, ready, rejected, starting, shutdown, new, orphaned, preparing, pending, complete, remove, accepted, assigned	tasks

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
  

Documentation

Index

• type Charts
• type Config
• type Dims
• type DockerEngine
  • func New() *DockerEngine
  • func (de DockerEngine) Charts() *Charts
  • func (de *DockerEngine) Check() bool
  • func (DockerEngine) Cleanup()
  • func (de *DockerEngine) Collect() map[string]int64
  • func (de *DockerEngine) Init() bool

Types

type Charts

type Charts = module.Charts

type Config

type Config struct {
	web.HTTP `yaml:",inline"`
}

type Dims

type Dims = module.Dims

type DockerEngine

type DockerEngine struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *DockerEngine

func (DockerEngine) Charts

func (de DockerEngine) Charts() *Charts

func (*DockerEngine) Check

func (de *DockerEngine) Check() bool

func (DockerEngine) Cleanup

func (DockerEngine) Cleanup()

func (*DockerEngine) Collect

func (de *DockerEngine) Collect() map[string]int64

func (*DockerEngine) Init

func (de *DockerEngine) Init() bool