- Heartbeat Reference: other versions:
- Heartbeat overview
- Quick start: installation and configuration
- Set up and run
- Configure
- Monitors
- Task scheduler
- General settings
- Project paths
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- 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
- append
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_duration
- 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
- move_fields
- rate_limit
- registered_domain
- rename
- replace
- script
- syslog
- translate_ldap_attribute
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- Feature flags
- heartbeat.reference.yml
- How to guides
- Exported fields
- Beat fields
- Synthetics browser metrics 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
- APM Service fields
- SOCKS5 proxy fields
- Monitor state fields
- Monitor summary fields
- Synthetics types fields
- TCP layer fields
- TLS encryption layer fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- Understand logged metrics
- Common problems
- Heartbeat 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
- High RSS memory usage due to MADV settings
- Contribute to Beats
Configure project paths
editConfigure project paths
editThe path
section of the heartbeat.yml
config file contains configuration
options that define where Heartbeat looks for its files. For example, Heartbeat
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 heartbeat.yml
config file:
home
editThe home path for the Heartbeat 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 Heartbeat binary.
Example:
path.home: /usr/share/beats
config
editThe configuration path for the Heartbeat 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 Heartbeat installation. This is the default base path for all
the files in which Heartbeat 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 Heartbeat instances on the same host, make sure they
each have a distinct path.data
value.
logs
editThe logs path for a Heartbeat installation. This is the default location for Heartbeat’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