- Heartbeat Reference: other versions:
- Overview
- Getting Started With Heartbeat
- Setting up and running Heartbeat
- Configuring Heartbeat
- Set up monitors
- Specify general settings
- Configure the internal queue
- Configure the output
- Specify SSL settings
- Filter and Enhance the exported data
- Parse data by using ingest node
- Set up project paths
- Set up the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- heartbeat.reference.yml
- Exported fields
- Monitoring Heartbeat
- Securing Heartbeat
- Troubleshooting
- Contributing to Beats
Monitoring Heartbeat
editMonitoring Heartbeat
editX-Pack monitoring for Heartbeat requires Elasticsearch 6.2 or later.
X-Pack monitoring enables you to easily monitor Heartbeat from Kibana. For more information, see Monitoring the Elastic Stack and Beats Monitoring Metrics.
To configure Heartbeat to collect and send monitoring metrics:
-
Create a user that has appropriate authority to send system-level monitoring
data to Elasticsearch. For example, you can use the built-in
beats_system
user or assign the built-inbeats_system
role to another user. For more information, see Setting Up User Authentication and Built-in Roles. -
Add the
xpack.monitoring
settings in the Heartbeat configuration file. If you configured Elasticsearch output, specify the following minimal configuration:xpack.monitoring.enabled: true
If you configured a different output, such as Logstash, you must specify additional configuration options. For example:
xpack.monitoring: enabled: true elasticsearch: hosts: ["https://example.com:9200", "https://example2.com:9200"] username: beats_system password: beatspassword
Currently you must send monitoring data to the same cluster as all other events. If you configured Elasticsearch output, do not specify additional hosts in the monitoring configuration.
- Configure monitoring in Kibana.
-
To verify your monitoring configuration, point your web browser at your Kibana
host, and select Monitoring from the side navigation. Metrics reported from
Heartbeat should be visible in the Beats section. When X-Pack security is enabled,
to view the monitoring dashboards you must log in to Kibana as a user who has the
kibana_user
andmonitoring_user
roles.