Back to Beats

Directory layout [directory-layout]

docs/reference/packetbeat/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 Packetbeat 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 Packetbeat.{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]

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

deb and rpm [_deb_and_rpm]

TypeDescriptionLocation
homeHome of the Packetbeat installation./usr/share/packetbeat
binThe location for the binary files./usr/share/packetbeat/bin
configThe location for configuration files./etc/packetbeat
dataThe location for persistent data files./var/lib/packetbeat
logsThe location for the logs created by Packetbeat./var/log/packetbeat

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 Packetbeat 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 Packetbeat installation./usr/share/packetbeat
binThe location for the binary files./usr/share/packetbeat
configThe location for configuration files./usr/share/packetbeat
dataThe location for persistent data files./usr/share/packetbeat/data
logsThe location for the logs created by Packetbeat./usr/share/packetbeat/logs

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

TypeDescriptionLocation
homeHome of the Packetbeat 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 Packetbeat.{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 Packetbeat with the following simple command, all paths are set correctly:

sh
./packetbeat