Project: Netdata (Observability and Analysis / Observability)
File: docker.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/docker/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/docker/metadata.yaml" sidebar_label: "Docker" learn_status: "Published" learnrelpath: "Collecting Metrics/Containers and VMs" most_popular: True message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/docker.svg" width="150"/> Plugin: go.d.plugin Module: docker <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors Docker containers state, health status and more. It connects to the Docker instance via a TCP or UNIX socket and executes the following commands: . . . This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. Requires netdata user to be in the docker group. It discovers instances running on localhost by attempting to connect to a known Docker UNIX socket: `/var/run/docker.sock`. The default configuration for this integration does not impose any limits on data collection. Enabling `collectcontainersize` may result in high CPU usage depending on the version of Docker Engine. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | docker.containers_state | running, paused, stopped | containers | | docker.containershealthstatus | healthy, unhealthy, notrunningunhealthy, starting, no_healthcheck | containers | | docker.images | active, dangling | images | | docker.images_size | size | bytes | Metrics related to containers. Each container provides its own set of the following metrics. Labels: | Label | Description | |:--|:-| | container_name | The container's name | | image | The image name the container uses | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | docker.container_state | running, paused, exited, created, restarting, removing, dead | state | | docker.containerhealthstatus | healthy, unhealthy, notrunningunhealthy, starting, no_healthcheck | status | | docker.containerwriteablelayersize | writeablelayer | size | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | docker.containerhealthstatus | ${label:container_name} docker container health status is unhealthy | No action required. The configuration file name for this integration is `go.d/docker.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/docker.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 1 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | address | Docker daemon's listening address. When using a TCP socket, the format is: tcp://[ip]:[port] | unix:///var/run/docker.sock | yes | | timeout | Request timeout in seconds. | 2 | no | | collectcontainersize | Whether to collect container writable layer size. | no | no | </details> An example configuration. ```yaml jobs: name: local address: 'unix:///var/run/docker.sock' ``` Note: When you define multiple jobs, their names must be unique. Collecting metrics from local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local address: 'unix:///var/run/docker.sock' name: remote address: 'tcp://203.0.113.10:2375' ``` </details> 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. 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]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m docker ```