Back to Beats

Directory layout [directory-layout]

docs/reference/winlogbeat/directory-layout.md

9.4.01.6 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 Winlogbeat 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 Winlogbeat.{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]

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

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

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

sh
Start-Service winlogbeat