- Heartbeat Reference: other versions:
- Overview
- Getting Started With Heartbeat
- Setting up and running Heartbeat
- Configuring Heartbeat
- Set up monitors
- Specify general settings
- Specify Observer and Geo Options
- 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
- 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
- Parse data by using ingest node
- Enrich events with geoIP information
- Configure project paths
- Configure the Kibana endpoint
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- heartbeat.reference.yml
- Exported fields
- Beat fields
- Cloud provider metadata fields
- Common heartbeat monitor fields
- Docker fields
- ECS fields
- Host fields
- HTTP monitor fields
- ICMP fields
- Jolokia Discovery autodiscover provider fields
- Kubernetes fields
- Process fields
- Host lookup fields
- SOCKS5 proxy fields
- Monitor summary fields
- TCP layer fields
- TLS encryption layer fields
- Monitoring Heartbeat
- Securing Heartbeat
- Troubleshooting
- Contributing to Beats
Configuring Heartbeat
editConfiguring Heartbeat
editBefore modifying configuration settings, make sure you’ve completed the configuration steps in the Getting Started. This section describes some common use cases for changing configuration options.
To configure Heartbeat, you edit the configuration file. For rpm and deb,
you’ll find the default configuration file at
/etc/heartbeat/heartbeat.yml. There’s also a full example
configuration file at /etc/heartbeat/heartbeat.reference.yml that shows
all non-deprecated options. For mac and win, look in the archive that you
extracted.
The Heartbeat configuration file uses YAML for its syntax. See the Config File Format section of the Beats Platform Reference for more about the structure of the config file.
The following topics describe how to configure Heartbeat:
- Set up monitors
- Specify general settings
- Configure the internal queue
- Configure the output
- Configure index lifecycle management
- Specify SSL settings
- Filter and Enhance the exported data
- Parse data by using ingest node
- Enrich events with geoIP information
- Configure project paths
- Configure the Kibana endpoint
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- heartbeat.reference.yml