WARNING: Version 6.1 of Filebeat 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.
Configuring Filebeat
editConfiguring Filebeat
editBefore modifying configuration settings, make sure you’ve completed the configuration steps in the Getting Started. This section describes some common use cases for changing configuration options.
To configure Filebeat, you edit the configuration file. For rpm and deb,
you’ll find the configuration file at /etc/filebeat/filebeat.yml.
There’s also a full example configuration file at
/etc/filebeat/filebeat.reference.yml that shows all non-deprecated
options. For mac and win, look in the archive that you extracted.
The Filebeat configuration file uses YAML for its syntax. See the Config File Format section of the Beats Platform Reference for more about the structure of the config file.
The following topics describe how to configure Filebeat:
- Specify which modules to run
- Set up prospectors
- Manage multiline messages
- Specify general settings
- Load external configuration files
- Configure the internal queue
- Configure the output
- Load balance the output hosts
- Specify SSL settings
- Filter and enhance the exported data
- Parse logs by using ingest node
- Set up project paths
- Set up the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Set up logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- filebeat.reference.yml