Skip to content

Latest commit

 

History

History
108 lines (81 loc) · 3.94 KB

shared-path-config.asciidoc

File metadata and controls

108 lines (81 loc) · 3.94 KB

Configure project paths

Project paths

The path section of the {beatname_lc}.yml config file contains configuration options that define where {beatname_uc} looks for its files. For example, {beatname_uc} looks for the Elasticsearch template file in the configuration path and writes 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.

Configuration options

You can specify the following options in the path section of the {beatname_lc}.yml config file:

home

The home path for the {beatname_uc} 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 {beatname_uc} binary.

Example:

path.home: /usr/share/beats

config

The configuration path for the {beatname_uc} 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

The data path for the {beatname_uc} installation. This is the default base path for all the files in which {beatname_uc} 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
Tip
When running multiple {beatname_uc} instances on the same host, make sure they each have a distinct path.data value.

logs

The logs path for a {beatname_uc} installation. This is the default location for {beatname_uc}'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