To configure Heartbeat, you edit the configuration file. For rpm and deb,
you’ll find the configuration file at
Docker, it’s located at
/usr/share/heartbeat/heartbeat.yml. For mac and win,
look in the archive that you just extracted.
There’s also a full example configuration file called
that shows all non-deprecated options.
See the Config File Format section of the Beats Platform Reference for more about the structure of the config file.
Heartbeat provides monitors to check the status of hosts at set intervals.
You configure each monitor individually. Heartbeat currently provides monitors
for ICMP, TCP, and HTTP (see Overview for more about these
monitors). Here is an example that configures Heartbeat to use an
heartbeat.monitors: - type: icmp schedule: '*/5 * * * * * *' hosts: ["myhost"] output.elasticsearch: hosts: ["myEShost:9200"]
To configure Heartbeat:
Specify the list of monitors that you want to enable. Each item in the list begins with a dash (-). The following example configures Heartbeat to use two monitors, an
icmpmonitor and a
icmpmonitor is scheduled to run exactly every 5 seconds (10:00:00, 10:00:05, and so on). The
scheduleoption uses a cron-like syntax based on this
tcpmonitor is set to run every 5 seconds from the time when Heartbeat was started. Heartbeat adds the
@everykeyword to the syntax provided by the
modespecifies whether to ping one IP (
any) or all resolvable IPs (
See Configuring Heartbeat for a full description of each configuration option.
If you are sending output directly to Elasticsearch (and not using Logstash), set the IP address and port where Heartbeat can find the Elasticsearch installation:
output.elasticsearch: hosts: ["192.168.1.42:9200"]
If you are sending output to Logstash, make sure you Configure the Logstash output instead.
If you plan to use the sample Kibana dashboards provided with Heartbeat, configure the Kibana endpoint:
setup.kibana: host: "localhost:5601"
hostis the hostname and port of the machine where Kibana is running, for example,
If you specify a path after the port number, you need to include the scheme and port:
If you’ve secured Elasticsearch and Kibana, you need to specify credentials in the config file before you run the commands that set up and start Heartbeat. For example:
This examples shows a hard-coded password, but you should store sensitive values in the secrets keystore.
passwordsettings for Kibana are optional. If you don’t specify credentials for Kibana, Heartbeat uses the
passwordspecified for the Elasticsearch output.
For more information, see Securing Heartbeat.
Before starting heartbeat, you should look at the configuration options in the configuration file. For more information about these options, see Configuring Heartbeat.