WARNING: Version 5.5 of Winlogbeat 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.

« Command Line Options Upgrading Winlogbeat »

› ›

Directory Layout

edit

Directory Layout

edit

The directory layout of an installation is as follows:

Type	Description	Default Location	Config Option
home	Home of the Winlogbeat installation.		`path.home`
bin	The location for the binary files.	`{path.home}/bin`
config	The location for configuration files.	`{path.home}`	`path.config`
data	The location for persistent data files.	`{path.home}/data`	`path.data`
logs	The location for the logs created by Winlogbeat.	`{path.home}/logs`	`path.logs`

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

Default paths

edit

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

deb and rpm

edit

Type	Description	Location
home	Home of the Winlogbeat installation.	`/usr/share/winlogbeat`
bin	The location for the binary files.	`/usr/share/winlogbeat/bin`
config	The location for configuration files.	`/etc/winlogbeat`
data	The location for persistent data files.	`/var/lib/winlogbeat`
logs	The location for the logs created by Winlogbeat.	`/var/log/winlogbeat`

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 Winlogbeat service by using the preferred operating system method (init scripts or systemctl). Otherwise the paths might be set incorrectly.

docker

edit

Type	Description	Location
home	Home of the Winlogbeat installation.	`/usr/share/winlogbeat`
bin	The location for the binary files.	`/usr/share/winlogbeat`
config	The location for configuration files.	`/usr/share/winlogbeat`
data	The location for persistent data files.	`/usr/share/winlogbeat/data`
logs	The location for the logs created by Winlogbeat.	`/usr/share//winlogbeat/logs`

zip, tar.gz, and tgz

edit

Type	Description	Location
home	Home of the Winlogbeat installation.	`{extract.path}`
bin	The location for the binary files.	`{extract.path}`
config	The location for configuration files.	`{extract.path}`
data	The location for persistent data files.	`{extract.path}/data`
logs	The location for the logs created by Winlogbeat.	`{extract.path}/logs`

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 Winlogbeat with the following simple command, all paths are set correctly:

./winlogbeat

« Command Line Options Upgrading Winlogbeat »