Configuring Heartbeat

Before modifying configuration settings, make sure you’ve completed the configuration steps in the Getting Started. This section describes some common use cases for changing configuration options.

To configure Heartbeat, you edit the configuration file. For rpm and deb, you’ll find the default configuration file at /etc/heartbeat/heartbeat.yml. There’s also a full example configuration file at /etc/heartbeat/heartbeat.reference.yml that shows all non-deprecated options. For mac and win, look in the archive that you extracted.

The Heartbeat configuration file uses YAML for its syntax. See the Config File Format section of the Beats Platform Reference for more about the structure of the config file.

The following topics describe how to configure Heartbeat: