IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« CouchDB server metricset Docker container metricset »
Elastic Docs ›Metricbeat Reference [8.2] ›Modules

Docker module

edit

Docker module

edit

Prefer to use Elastic Agent for this use case?

Refer to the Elastic Integrations documentation.

Learn more

Elastic Agent is a single, unified agent that you can deploy to hosts or containers to collect data and send it to the Elastic Stack. Elastic Agent uses integrations to connect your data to the Elastic Stack. Behind the scenes, Elastic Agent runs the Beats shippers required for your configuration. Refer to the documentation for a detailed comparison of Beats and Elastic Agent.

This module fetches metrics from Docker containers. The default metricsets are: container, cpu, diskio, healthcheck, info, memory and network. The image metricset is not enabled by default.

Compatibility

edit

The Docker module is currently tested on Linux and Mac with the community edition engine, versions 1.11 and 17.09.0-ce. It is not tested on Windows, but it should also work there.

Module-specific configuration notes

edit

It is strongly recommended that you run Docker metricsets with a period that is 3 seconds or longer. The request to the Docker API already takes up to 2 seconds. Specifying less than 3 seconds will result in requests that timeout, and no data will be reported for those requests.

Example configuration

edit

The Docker module supports the standard configuration options that are described in Modules. Here is an example configuration:

metricbeat.modules:
- module: docker
  metricsets:
    - "container"
    - "cpu"
    - "diskio"
    - "event"
    - "healthcheck"
    - "info"
    #- "image"
    - "memory"
    - "network"
    #- "network_summary"
  hosts: ["unix:///var/run/docker.sock"]
  period: 10s
  enabled: true

  # If set to true, replace dots in labels with `_`.
  #labels.dedot: false

  # Skip metrics for certain device major numbers in docker/diskio.
  # Necessary on systems with software RAID, device mappers,
  # or other configurations where virtual disks will sum metrics from other disks.
  # By default, it will skip devices with major numbers 9 or 253.
  #skip_major: []

  # If set to true, collects metrics per core.
  #cpu.cores: true

  # To connect to Docker over TLS you must specify a client and CA certificate.
  #ssl:
    #certificate_authority: "/etc/pki/root/ca.pem"
    #certificate:           "/etc/pki/client/cert.pem"
    #key:                   "/etc/pki/client/cert.key"

This module supports TLS connections when using ssl config field, as described in SSL.

Metricsets

edit

The following metricsets are available:

« CouchDB server metricset Docker container metricset »