WARNING: Version 5.4 of Metricbeat has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Couchbase Node Metricset Docker Container Metricset »

› ›

Docker Module

edit

Docker Module

edit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

This module fetches metrics from Docker containers.

The docker module is currently not tested on Windows.

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", "healthcheck", "info", "memory", "network"]
  #hosts: ["unix:///var/run/docker.sock"]
  #enabled: true
  #period: 10s

  # 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"

Metricsets

edit

The following metricsets are available:

« Couchbase Node Metricset Docker Container Metricset »