WARNING: Version 5.3 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.

« Output Codec Dashboards »
Elastic Docs ›Winlogbeat Reference [5.3] ›Configuring Winlogbeat ›Configuration Options (Reference)

Paths

edit

Paths

edit

The path section of the winlogbeat.yml config file contains configuration options that define where the Beat looks for its files. For example, all Beats look for the Elasticsearch template file in the configuration path, Filebeat and Winlogbeat look for their registry files in the data path, and all Beats write their log files in the logs path.

Please see the Directory Layout section for more details.

Here is an example configuration:

path.home: /usr/share/beat
path.config: /etc/beat
path.data: /var/lib/beat
path.logs: /var/log/

Note that it is possible to override these options by using command line flags.

Path Options

edit

You can specify the following options in the path section of the winlogbeat.yml config file:

home

edit

The home path for the Winlogbeat installation. This is the default base path for all other path settings and for miscellaneous files that come with the distribution (for example, the sample dashboards). If not set by a CLI flag or in the configuration file, the default for the home path is the location of the Winlogbeat binary.

Example:

path.home: /usr/share/beats

config

edit

The configuration path for the Winlogbeat installation. This is the default base path for configuration files, including the main YAML configuration file and the Elasticsearch template file. If not set by a CLI flag or in the configuration file, the default for the configuration path is the home path.

Example:

path.config: /usr/share/beats/config

data

edit

The data path for the Winlogbeat installation. This is the default base path for all the files in which Winlogbeat needs to store its data. If not set by a CLI flag or in the configuration file, the default for the data path is a data subdirectory inside the home path.

Example:

path.data: /var/lib/beats

logs

edit

The logs path for a Winlogbeat installation. This is the default location for the Beat’s log files. If not set by a CLI flag or in the configuration file, the default for the logs path is a logs subdirectory inside the home path.

Example:

path.logs: /var/log/beats
« Output Codec Dashboards »