- Filebeat Reference: other versions:
- Overview
- Getting Started With Filebeat
- Step 1: Install Filebeat
- Step 2: Configure Filebeat
- Step 3: Configure Filebeat to use Logstash
- Step 4: Load the index template in Elasticsearch
- Step 5: Set up the Kibana dashboards
- Step 6: Start Filebeat
- Step 7: View the sample Kibana dashboards
- Quick start: modules for common log formats
- Repositories for APT and YUM
- Setting up and running Filebeat
- Upgrading Filebeat
- How Filebeat works
- Configuring Filebeat
- Specify which modules to run
- Configure inputs
- Manage multiline messages
- Specify general settings
- Load external configuration files
- Configure the internal queue
- Configure the output
- Configure index lifecycle management
- Load balance the output hosts
- 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
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- filebeat.reference.yml
- Beats central management
- Modules
- Modules overview
- Apache module
- Auditd module
- Elasticsearch module
- haproxy module
- Icinga module
- IIS module
- Iptables module
- Kafka module
- Kibana module
- Logstash module
- MongoDB module
- MySQL module
- Nginx module
- Osquery module
- PostgreSQL module
- Redis module
- Santa module
- Suricata module
- System module
- Traefik module
- Zeek (Bro) Module
- Exported fields
- Apache fields
- Auditd fields
- Beat fields
- Cloud provider metadata fields
- Docker fields
- ECS fields
- elasticsearch fields
- haproxy fields
- Host fields
- Icinga fields
- IIS fields
- iptables fields
- Kafka fields
- kibana fields
- Kubernetes fields
- Log file content fields
- logstash fields
- mongodb fields
- MySQL fields
- NetFlow fields
- Nginx fields
- Osquery fields
- PostgreSQL fields
- Process fields
- Redis fields
- Google Santa fields
- Suricata fields
- System fields
- Traefik fields
- Zeek fields
- Monitoring Filebeat
- Securing Filebeat
- Troubleshooting
- Contributing to Beats
Filebeat and systemd
editFilebeat and systemd
editThe DEB and RPM packages include a service unit for Linux systems with systemd. On these systems, you can manage Filebeat by using the usual systemd commands.
Start and stop Filebeat
editUse systemctl to start or stop Filebeat:
systemctl start filebeat
systemctl stop filebeat
By default, the Filebeat service starts automatically when the system boots. To enable or disable auto start use:
systemctl enable filebeat
systemctl disable filebeat
Filebeat status and logs
editTo get the service status, use systemctl:
systemctl status filebeat
Logs are stored by default in journald. To view the Logs, use journalctl:
journalctl -u filebeat.service
The unit file included in the packages sets the -e flag by default.
This flag makes Filebeat log to stderr and disables other log outputs.
Systemd stores all output sent to stderr in journald.
Customize systemd unit for Filebeat
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/filebeat.service.d directory.
For example a file with the following content placed in
/etc/systemd/system/filebeat.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 Filebeat 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 filebeat
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 filebeat.service.