- Filebeat Reference: other versions:
- Overview
- Getting Started With Filebeat
- Upgrading Filebeat
- How Filebeat Works
- Configuring Filebeat
- Configuration Options (Reference)
- Filebeat Prospectors Configuration
- Filebeat Global Configuration
- General Configuration
- Elasticsearch Output Configuration
- Logstash Output Configuration
- Kafka Output Configuration
- Redis Output Configuration
- File Output Configuration
- Console Output Configuration
- SSL Configuration
- Paths Configuration
- Logging Configuration
- Processors
- Filtering and Enhancing the Exported Data
- Managing Multiline Messages
- Configuring Filebeat to Use Ingest Node
- Using Environment Variables in the Configuration
- Specifying Multiple Prospectors
- Load Balancing
- YAML Tips and Gotchas
- Regular Expression Support
- Configuration Options (Reference)
- Exported Fields
- Securing Filebeat
- Troubleshooting
- Migrating from Logstash Forwarder to Filebeat
WARNING: Version 5.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.
Paths Configuration
editPaths Configuration
editThe path
section of the filebeat.yml
config file contains configuration
options that define where the Beat looks for its files. For example, all Beats
look for the Elasticsearch template file in the configuration path, Filebeat and
Winlogbeat look for their registry files in the data path, and all Beats write
their log files in the logs path.
Please see the Directory Layout section for more details.
Here is an example configuration:
path.home: /usr/share/beat path.conf: /etc/beat path.data: /var/lib/beat path.logs: /var/log/
Note that it is possible to override these options by using command line flags.
Path Options
editYou can specify the following options in the path
section of the filebeat.yml
config file:
home
editThe home path for the Filebeat installation. This is the default base path for all other path settings and for miscellaneous files that come with the distribution (for example, the sample dashboards). If not set by a CLI flag or in the configuration file, the default for the home path is the location of the Filebeat binary.
Example:
path.home: /usr/share/beats
conf
editThe configuration path for the Filebeat installation. This is the default base path for configuration files, including the main YAML configuration file and the Elasticsearch template file. If not set by a CLI flag or in the configuration file, the default for the configuration path is the home path.
Example:
path.conf: /usr/share/beats/config
data
editThe data path for the Filebeat installation. This is the default base path for all
the files in which Filebeat needs to store its data. If not set by a CLI
flag or in the configuration file, the default for the data path is a data
subdirectory inside the home path.
Example:
path.data: /var/lib/beats
logs
editThe logs path for a Filebeat installation. This is the default location for the Beat’s
log files. If not set by a CLI flag or in the configuration file, the default
for the logs path is a logs
subdirectory inside the home path.
Example:
path.logs: /var/log/beats
On this page