- Auditbeat Reference: other versions:
- Overview
- Getting started with Auditbeat
- Setting up and running Auditbeat
- Upgrading Auditbeat
- Configuring Auditbeat
- Specify which modules to run
- Specify general settings
- Reload the configuration dynamically
- Configure the internal queue
- Configure the output
- Configure index lifecycle management
- Specify SSL settings
- Filter and enhance the exported data
- Define processors
- Add cloud metadata
- Add fields
- Add labels
- Add the local time zone
- Add tags
- Decode JSON fields
- Drop events
- Drop fields from events
- Keep fields from events
- Rename fields from events
- Add Kubernetes metadata
- Add Docker metadata
- Add Host metadata
- Dissect strings
- DNS Reverse Lookup
- Add process metadata
- Parse data by using ingest node
- Enrich events with geoIP information
- Configure project paths
- Configure the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- auditbeat.reference.yml
- Modules
- Exported fields
- Monitoring Auditbeat
- Securing Auditbeat
- Troubleshooting
- Contributing to Beats
Auditbeat and systemd
editAuditbeat and systemd
editThe DEB and RPM packages include a service unit for Linux systems with systemd. On these systems, you can manage Auditbeat by using the usual systemd commands.
Start and stop Auditbeat
editUse systemctl to start or stop Auditbeat:
systemctl start auditbeat
systemctl stop auditbeat
By default, the Auditbeat service starts automatically when the system boots. To enable or disable auto start use:
systemctl enable auditbeat
systemctl disable auditbeat
Auditbeat status and logs
editTo get the service status, use systemctl:
systemctl status auditbeat
Logs are stored by default in journald. To view the Logs, use journalctl:
journalctl -u auditbeat.service
The unit file included in the packages sets the -e flag by default.
This flag makes Auditbeat log to stderr and disables other log outputs.
Systemd stores all output sent to stderr in journald.
Customize systemd unit for Auditbeat
editThe systemd service unit file includes environment variables that you can override to change the default options.
| Variable | Description | Default value |
|---|---|---|
BEAT_LOG_OPTS |
Log options |
|
BEAT_CONFIG_OPTS |
Flags for configuration file path |
|
BEAT_PATH_OPTS |
Other paths |
|
To override these variables, create a drop-in unit file in the
/etc/systemd/system/auditbeat.service.d directory.
For example a file with the following content placed in
/etc/systemd/system/auditbeat.service.d/debug.conf
would override BEAT_LOG_OPTS to enable debug for Elasticsearch output.
[Service] Environment="BEAT_LOG_OPTS=-e -d elasticsearch"
To change the logging output from the Auditbeat configuration file, empty the environment variable. For example:
[Service] Environment="BEAT_LOG_OPTS="
To apply your changes, reload the systemd configuration and restart the service:
systemctl daemon-reload systemctl restart auditbeat
It is recommended that you use a configuration management tool to
include drop-in unit files. If you need to add a drop-in manually, use
systemctl edit auditbeat.service.