metricbeat: Improve README, add notes about config

parent f592f221
...@@ -6,15 +6,31 @@ and ships them to the output that you specify, such as Elasticsearch or Logstash ...@@ -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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment