Back to Beats

Directory layout [directory-layout]

docs/reference/filebeat/directory-layout.md

9.4.02.8 KB
Original Source

Directory layout [directory-layout]

The directory layout of an installation is as follows:

::::{tip} Archive installation has a different layout. See zip, tar.gz, or tgz. ::::

TypeDescriptionDefault LocationConfig Option
homeHome of the Filebeat installation.path.home
binThe location for the binary files.{path.home}/bin
configThe location for configuration files.{path.home}path.config
dataThe location for persistent data files.{path.home}/datapath.data
logsThe location for the logs created by Filebeat.{path.home}/logspath.logs

You can change these settings by using CLI flags or setting path options in the configuration file.

Default paths [_default_paths]

Filebeat uses the following default paths unless you explicitly change them.

deb and rpm [_deb_and_rpm]

TypeDescriptionLocation
homeHome of the Filebeat installation./usr/share/filebeat
binThe location for the binary files./usr/share/filebeat/bin
configThe location for configuration files./etc/filebeat
dataThe location for persistent data files./var/lib/filebeat
logsThe location for the logs created by Filebeat./var/log/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 [_docker]

TypeDescriptionLocation
homeHome of the Filebeat installation./usr/share/filebeat
binThe location for the binary files./usr/share/filebeat
configThe location for configuration files./usr/share/filebeat
dataThe location for persistent data files./usr/share/filebeat/data
logsThe location for the logs created by Filebeat./usr/share/filebeat/logs

zip, tar.gz, or tgz [directory-layout-archive]

TypeDescriptionLocation
homeHome of the Filebeat installation.{extract.path}
binThe location for the binary files.{extract.path}
configThe location for configuration files.{extract.path}
dataThe location for persistent data files.{extract.path}/data
logsThe location for the logs created by Filebeat.{extract.path}/logs

For the zip, tar.gz, or 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:

sh
./filebeat