- Filebeat Reference: other versions:
- Overview
- Getting Started With Filebeat
- Step 1: Installing Filebeat
- Step 2: Configuring Filebeat
- Step 3: Configuring Filebeat to Use Logstash
- Step 4: Loading the Index Template in Elasticsearch
- Step 5: Starting Filebeat
- Step 6: Loading the Kibana Index Pattern
- Quick Start for Common Log Formats
- Command Line Options
- Directory Layout
- Repositories for APT and YUM
- Running Filebeat on Docker
- Upgrading Filebeat
- How Filebeat Works
- Configuring Filebeat
- Modules
- Exported Fields
- Securing Filebeat
- Troubleshooting
- Migrating from Logstash Forwarder to Filebeat
WARNING: Version 5.6 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.
Directory Layout
editDirectory Layout
editThe directory layout of an installation is as follows:
Type | Description | Default Location | Config Option |
---|---|---|---|
home |
Home of the Filebeat installation. |
|
|
bin |
The location for the binary files. |
|
|
config |
The location for configuration files. |
|
|
data |
The location for persistent data files. |
|
|
logs |
The location for the logs created by Filebeat. |
|
|
You can change these settings by using CLI flags or setting path options in the configuration file.
Default paths
editFilebeat uses the following default paths unless you explicitly change them.
deb and rpm
editType | Description | Location |
---|---|---|
home |
Home of the Filebeat installation. |
|
bin |
The location for the binary files. |
|
config |
The location for configuration files. |
|
data |
The location for persistent data files. |
|
logs |
The location for the logs created by Filebeat. |
|
For the deb and rpm distributions, these paths are set in the init script or in
the systemd unit file. Make sure that you start the Filebeat service by using
the preferred operating system method (init scripts or systemctl
).
Otherwise the paths might be set incorrectly.
docker
editType | Description | Location |
---|---|---|
home |
Home of the Filebeat installation. |
|
bin |
The location for the binary files. |
|
config |
The location for configuration files. |
|
data |
The location for persistent data files. |
|
logs |
The location for the logs created by Filebeat. |
|
zip, tar.gz, and tgz
editType | Description | Location |
---|---|---|
home |
Home of the Filebeat installation. |
|
bin |
The location for the binary files. |
|
config |
The location for configuration files. |
|
data |
The location for persistent data files. |
|
logs |
The location for the logs created by Filebeat. |
|
For the zip, tar.gz and tgz distributions, these paths are based on the location of the extracted binary file. This means that if you start Filebeat with the following simple command, all paths are set correctly:
./filebeat