Files
docker-elk/extensions/metricbeat/README.md
Antoine Cotten 24306fd49d feat!: Remove support for Compose v1
There has been no release of the deprecated 'docker-compose' Python
package since v1.29.2, which was published in May 2021[1]. This release
is currently broken due to a breaking change in the 'docker' Python
package at version 7.0.0[1], and there is seemlingly no plan to release
a patch version of Compose v1 to address the problem.

The official path forward is to use Compose v2, which is now bundled
with the Docker client and available on all platforms where Docker is
supported.

This commit additionally removes the 'version' attribute from Compose
files, since it was obsoleted in the Compose Spec[3].

Closes #1017

[1]: https://pypi.org/project/docker-compose/#history
[2]: docker/docker-py#3194
[3]: https://compose-spec.io
2024-09-17 09:20:56 +02:00

2.2 KiB

Metricbeat

Metricbeat is a lightweight shipper that you can install on your servers to periodically collect metrics from the operating system and from services running on the server. Metricbeat takes the metrics and statistics that it collects and ships them to the output that you specify, such as Elasticsearch or Logstash.

Usage

This extension requires the metricbeat_internal, monitoring_internal and beats_system users to be created and initialized with a password. In case you haven't done that during the initial startup of the stack, please refer to How to re-execute the setup to run the setup container again and initialize these users.

To include Metricbeat in the stack, run Docker Compose from the root of the repository with an additional command line argument referencing the metricbeat-compose.yml file:

$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml up

Configuring Metricbeat

The Metricbeat configuration is stored in config/metricbeat.yml. You can modify this file with the help of the Configuration reference.

Any change to the Metricbeat configuration requires a restart of the Metricbeat container:

$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml restart metricbeat

Please refer to the following documentation page for more details about how to configure Metricbeat inside a Docker container: Run Metricbeat on Docker.

See also

Metricbeat documentation

Screenshots

stack-monitoring host-dashboard