WARNING: Version 5.5 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.
Docker images for Metricbeat are available from the Elastic Docker
registry. You can retrieve an image with a
docker pull command.
docker pull docker.elastic.co/beats/metricbeat:5.5.3
Configuring Metricbeat on Dockeredit
The Docker image provides several methods for configuring Metricbeat. The conventional approach is to provide a configuration file via a bind-mounted volume, but it’s also possible to create a custom image with your configuration included.
One way to configure Metricbeat on Docker is to provide
metricbeat.yml via bind-mounting.
docker run, the bind-mount can be specified like this:
docker run \ -v ~/metricbeat.yml:/usr/share/metricbeat/metricbeat.yml \ docker.elastic.co/beats/metricbeat:5.5.3
Custom Image Configurationedit
It’s possible to embed your Metricbeat configuration in a custom image. Here is an example Dockerfile to achieve this:
FROM docker.elastic.co/beats/metricbeat:5.5.3 COPY metricbeat.yml /usr/share/metricbeat/metricbeat.yml USER root RUN chown metricbeat /usr/share/metricbeat/metricbeat.yml USER metricbeat
Monitoring the Host Machineedit
When executing Metricbeat in a container, there are some important things to be aware of if you want to monitor the host machine or other containers. Let’s walk-through some examples using Docker as our container orchestration tool.
This example highlights the changes required to make the system module work properly inside of a container. This enables Metricbeat to monitor the host machine from within the container.
Metricbeat’s system module collects much of its data through the Linux proc
filesystem, which is normally located at
By default, cgroup reporting is enabled for the
system process metricset, so you need
to mount the host’s cgroup mountpoints within the container. They need to be
mounted inside the directory specified by the
If you want to be able to monitor filesystems from the host by using the system filesystem metricset, then those filesystems need to be mounted inside of the container. They can be mounted at any location.
The system network metricset uses data from
The special filesystems
/sys are only available if the
host system is running Linux. Attempts to bind-mount these filesystems will
fail on Windows and MacOS.
Monitoring a Service in Another Containeredit
Next, let’s look at an example of monitoring a containerized service from a Metricbeat container.
Placing the Metricbeat and MySQL containers on the same Docker network
allows Metricbeat access to the exposed ports of the MySQL container, and
makes the hostname
If you do not want to hardcode certain values into your Metricbeat
configuration, then you can pass them into the container either as environment
variables or as command line flags to Metricbeat (see the
The mysql module configuration would look like this: