- 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_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
Heartbeat and systemd
editHeartbeat and systemd
editThe DEB and RPM packages include a service unit for Linux systems with systemd. On these systems, you can manage Heartbeat by using the usual systemd commands.
The service unit is configured with UMask=0027
which means the most permissive mask allowed for files created by Heartbeat is 0640
. All configured file permissions higher than 0640
will be ignored. Please edit the unit file manually in case you need to change that.
Start and stop Heartbeat
editUse systemctl
to start or stop Heartbeat:
sudo systemctl start heartbeat-elastic
sudo systemctl stop heartbeat-elastic
By default, the Heartbeat service starts automatically when the system boots. To enable or disable auto start use:
sudo systemctl enable heartbeat-elastic
sudo systemctl disable heartbeat-elastic
Heartbeat status and logs
editTo get the service status, use systemctl
:
systemctl status heartbeat-elastic
Logs are stored by default in journald. To view the Logs, use journalctl
:
journalctl -u heartbeat-elastic.service
Customize systemd unit for Heartbeat
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 |
|
You can use BEAT_LOG_OPTS
to set debug selectors for logging. However,
to configure logging behavior, set the logging options described in
Configure logging.
To override these variables, create a drop-in unit file in the
/etc/systemd/system/heartbeat-elastic.service.d
directory.
For example a file with the following content placed in
/etc/systemd/system/heartbeat-elastic.service.d/debug.conf
would override BEAT_LOG_OPTS
to enable debug for Elasticsearch output.
[Service] Environment="BEAT_LOG_OPTS=-d elasticsearch"
To apply your changes, reload the systemd configuration and restart the service:
systemctl daemon-reload systemctl restart heartbeat-elastic
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 heartbeat-elastic.service
.