Docker Metrics
Collect and ship Docker container service metrics to Logstash and Elasticsearch
Metricbeat is a lightweight shipper that helps you monitor Docker by collecting metrics from the containers running on the host system. Configure Metricbeat using the pre-defined examples below to collect and ship Docker container service metrics and statistics to Logstash or Elasticsearch.
Install Integration
Install Metricbeat
To get started first follow the steps below:
- Install metricbeat (opens in a new tab)
- Root access
- Verify the required port is open
Older versions can be found here: metricbeat 7 (opens in a new tab), metricbeat 6 (opens in a new tab), metricbeat 5 (opens in a new tab)
Copy Configuration File
The configuration file below is pre-configured to send data to your Logit.io Stack via Logstash.
Copy the configuration file below and overwrite the contents of metricbeat.yml.
###################### Logit.io Metricbeat Configuration #######################
# =========================== Modules configuration ============================
metricbeat.config.modules:
# Glob pattern for configuration loading
path: ${path.config}/modules.d/*.yml
# Set to true to enable config reloading
reload.enabled: false
# Period on which files under path should be checked for changes
#reload.period: 10s
# ======================= Elasticsearch template setting =======================
setup.template.settings:
index.number_of_shards: 1
index.codec: best_compression
#_source.enabled: false
# ================================== Outputs ===================================
# ------------------------------ Logstash Output -------------------------------
No input available! Your stack is missing the required input for this data source
Talk to support to add the inputEnable module
There are several built-in metricbeat modules you can use. To enable the docker module, run the following:
metricbeat modules list
metricbeat modules enable @module
Configure Module
Each module has its own configuration file where different metricsets can be enabled / disabled. Locate the configuration file for the docker module.
/etc/metricbeat/modules.d/docker.yml
By default the following metrics are enabled. To enable or disable a metric simply comment or uncomment the line out.
metricbeat.modules:
- module: docker
metricsets:
- "container"
- "cpu"
- "diskio"
- "event"
- "healthcheck"
- "info"
#- "image"
- "memory"
- "network"
hosts: ["unix:///var/run/docker.sock"]
period: 10s
enabled: true
Start Metricbeat
Start or restart metricbeat (opens in a new tab) to apply the configuration changes.
Check Logit.io for your metrics
Data should now have been sent to your Stack.
View My DataIf you don't see take a look at How to diagnose no data in Stack below for how to diagnose common issues.
How to diagnose no data in Stack
If you don't see data appearing in your Stack after following the steps, visit the Help Centre guide for steps to diagnose no data appearing in your Stack or Chat to support now.
Compatibility & configuration notes
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.
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.