IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« TLS encryption layer fields Monitoring configuration options »

›

Monitoring Heartbeat

edit

Monitoring Heartbeat

edit

X-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-in beats_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
  elasticsearch:
    username: beats_system
    password: somepassword
```
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: somepassword
```
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 and monitoring_user roles.

« TLS encryption layer fields Monitoring configuration options »