- Auditbeat Reference: other versions:
- Auditbeat overview
- Quick start: installation and configuration
- Set up and run
- Upgrade Auditbeat
- Configure
- Modules
- General settings
- Project paths
- Config file reloading
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- Kibana endpoint
- Kibana dashboards
- Processors
- Define processors
- add_cloud_metadata
- add_cloudfoundry_metadata
- add_docker_metadata
- add_fields
- add_host_metadata
- add_id
- add_kubernetes_metadata
- add_labels
- add_locale
- add_network_direction
- add_nomad_metadata
- add_observer_metadata
- add_process_metadata
- add_tags
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_json_fields
- decode_xml
- decode_xml_wineventlog
- decompress_gzip_field
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- rate_limit
- registered_domain
- rename
- syslog
- translate_sid
- truncate_fields
- urldecode
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- auditbeat.reference.yml
- How to guides
- Modules
- Exported fields
- Monitor
- Secure
- Troubleshoot
- Get Help
- Debug
- Common problems
- Auditbeat fails to watch folders because too many files are open
- Auditbeat uses too much bandwidth
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- Publishing to Logstash fails with "connection reset by peer" message
- @metadata is missing in Logstash
- Not sure whether to use Logstash or Beats
- SSL client fails to connect to Logstash
- Monitoring UI shows fewer Beats than expected
- Dashboard could not locate the index-pattern
- High RSS memory usage due to MADV settings
- Contribute to Beats
Configure project paths
editConfigure project paths
editThe path
section of the auditbeat.yml
config file contains configuration
options that define where Auditbeat looks for its files. For example, Auditbeat
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
editYou can specify the following options in the path
section of the auditbeat.yml
config file:
home
editThe home path for the Auditbeat 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 Auditbeat binary.
Example:
path.home: /usr/share/beats
config
editThe configuration path for the Auditbeat 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
editThe data path for the Auditbeat installation. This is the default base path for all
the files in which Auditbeat 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
When running multiple Auditbeat instances on the same host, make sure they
each have a distinct path.data
value.
logs
editThe logs path for a Auditbeat installation. This is the default location for Auditbeat’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
On this page