- Filebeat Reference: other versions:
- Overview
- Getting Started With Filebeat
- 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 CEF
- Decode CSV fields
- Decode JSON fields
- Decode Base64 fields
- Decompress gzip fields
- Community ID Network Flow Hash
- Convert
- Drop events
- Drop fields from events
- Extract array
- Keep fields from events
- Registered Domain
- Rename fields from events
- Add Kubernetes metadata
- Add Docker metadata
- Add Host metadata
- Add Observer metadata
- Dissect strings
- DNS Reverse Lookup
- Add process metadata
- Script Processor
- Timestamp
- 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
- AWS module
- CEF module
- Cisco module
- Coredns Module
- Elasticsearch module
- Envoyproxy Module
- Google Cloud module
- haproxy module
- IBM MQ module
- Icinga module
- IIS module
- Iptables module
- Kafka module
- Kibana module
- Logstash module
- MongoDB module
- MSSQL module
- MySQL module
- nats module
- NetFlow module
- Nginx module
- Osquery module
- Palo Alto Networks module
- PostgreSQL module
- RabbitMQ module
- Redis module
- Santa module
- Suricata module
- System module
- Traefik module
- Zeek (Bro) Module
- Exported fields
- Apache fields
- Auditd fields
- AWS fields
- Beat fields
- Decode CEF processor fields fields
- CEF fields
- Cisco fields
- Cloud provider metadata fields
- Coredns fields
- Docker fields
- ECS fields
- elasticsearch fields
- Envoyproxy fields
- Google Cloud fields
- haproxy fields
- Host fields
- ibmmq fields
- Icinga fields
- IIS fields
- iptables fields
- Jolokia Discovery autodiscover provider fields
- Kafka fields
- kibana fields
- Kubernetes fields
- Log file content fields
- logstash fields
- mongodb fields
- mssql fields
- MySQL fields
- nats fields
- NetFlow fields
- NetFlow fields
- Nginx fields
- Osquery fields
- panw fields
- PostgreSQL fields
- Process fields
- RabbitMQ fields
- Redis fields
- s3 fields
- Google Santa fields
- Suricata fields
- System fields
- Traefik fields
- Zeek fields
- Monitoring Filebeat
- Securing Filebeat
- Troubleshooting
- Get help
- Debug
- Common problems
- Can’t read log files from network volumes
- Filebeat isn’t collecting lines from a file
- Too many open file handlers
- Registry file is too large
- Inode reuse causes Filebeat to skip lines
- Log rotation results in lost or duplicate events
- Open file handlers cause issues with Windows file rotation
- Filebeat is using too much CPU
- Dashboard in Kibana is breaking up data fields incorrectly
- Fields are not indexed or usable in Kibana visualizations
- Filebeat isn’t shipping the last line of a file
- Filebeat keeps open file handlers of deleted files for a long time
- Filebeat uses too much bandwidth
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- @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
- Contributing to Beats
How central management works
editHow central management works
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Beats central management uses a mechanism called configuration tags to group related configurations. You define configuration tags in the Central Management UI in Kibana after enrolling your first beat.
A configuration tag is a group of configuration blocks that you can apply to
one or more Beats. A tag can have configuration blocks for different types of
Beats. For example, you might have a tag called development that you use to
group all configurations that are valid for running Beats in your development
environment. The development tag might have:
- Two Metricbeat module configuration blocks: one that reads system metrics and another that reads metrics from Apache HTTP servers
- Two Filebeat module configuration blocks: one that reads Apache HTTP server logs and another that reads system logs
- One heartbeat monitor configuration block: checks that a public facing website is live.
- One Elasticsearch output configuration block that sends the output to your Elasticsearch development cluster
You apply the tag to any Beats that will use the configurations defined in the tag.
When the enrolled Beats run, each Beat uses the configuration blocks that are valid for its type.
You can add, modify, or remove configuration blocks from a tag. Any changes that you make to the configuration blocks in a tag are automatically applied to all Beats that have that tag.
You can add or remove tags to change the set of configuration blocks applied to
your Beats. For example, after you’ve tested configurations in your
development environment, you can remove the development tag and add a
production tag that has an Elasticsearch output configuration block for sending the
data to your production cluster.
You can apply multiple tags to a Beat. For example, instead of defining the
apache modules under the development tag as described earlier, you could
create a separate tag called apache that contains the Apache module
configurations, then apply the tag to all Beats running on Apache servers.
This would enable you to maintain your Apache module configurations under a
single tag, while also using a development tag to send output for some
instances to your development cluster.
You can apply as many tags as you need. Just keep in mind that the configurations for all assigned tags are merged, which means that you should not specify conflicting configurations. If there are errors in the configuration, you’ll see an Error status in the Central Management UI and need to look at the logs for the Beat to troubleshoot the problem.