iac
/
docker-elk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

metricbeat: Improve README, add notes about config

This commit is contained in:
Antoine Cotten 2021-01-16 21:29:11 +01:00
parent f592f221c4
commit 1273e41260
No known key found for this signature in database
GPG Key ID: 94637E68D4A79DD0
1 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
extensions/metricbeat/README.md
View File

@ -6,15 +6,31 @@ and ships them to the output that you specify, such as Elasticsearch or Logstash
## Usage ## Usage
If you want to include the Metricbeat extension, run Docker Compose from the root of the repository with an additional To include Metricbeat in the stack, run Docker Compose from the root of the repository with an additional command line
command line argument referencing the `metricbeat-compose.yml` file: argument referencing the `metricbeat-compose.yml` file:
```bash ```console
$ docker-compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml up $ docker-compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml up
``` ```
## Documentation ## Configuring Metricbeat
[Official Docs](https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-overview.html) The Metricbeat configuration is stored in [`config/metricbeat.yml`](./config/metricbeat.yml). You can modify this file
[Running on Docker](https://www.elastic.co/guide/en/beats/metricbeat/current/running-on-docker.html) with the help of the [Configuration reference][metricbeat-config].
[Configuration reference](https://www.elastic.co/guide/en/beats/metricbeat/master/metricbeat-reference-yml.html)
Any change to the Metricbeat configuration requires a restart of the Metricbeat container:
```console
$ 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][metricbeat-docker].
## See also
[Metricbeat documentation][metricbeat-doc]
[metricbeat-config]: https://www.elastic.co/guide/en/beats/metricbeat/master/metricbeat-reference-yml.html
[metricbeat-docker]: https://www.elastic.co/guide/en/beats/metricbeat/current/running-on-docker.html
[metricbeat-doc]: https://www.elastic.co/guide/en/beats/metricbeat/current/index.html