Step 1: Installing Heartbeatedit

Unlike most Beats, which you install on edge nodes, you typically install Heartbeat as part of monitoring service that runs on a separate machine and possibly even outside of the network where the services that you want to monitor are running.

To download and install Heartbeat, use the commands that work with your system (deb for Debian/Ubuntu, rpm for Redhat/Centos/Fedora, mac for OS X, docker for any Docker platform, and win for Windows).

Note

If you use Apt or Yum, you can install Heartbeat from our repositories to update to the newest version more easily.

See our download page for other installation options, such as 32-bit images.

deb:

curl -L -O https://artifacts.elastic.co/downloads/beats/heartbeat/heartbeat-5.5.0-amd64.deb
sudo dpkg -i heartbeat-5.5.0-amd64.deb

rpm:

curl -L -O https://artifacts.elastic.co/downloads/beats/heartbeat/heartbeat-5.5.0-x86_64.rpm
sudo rpm -vi heartbeat-5.5.0-x86_64.rpm

mac:

curl -L -O https://artifacts.elastic.co/downloads/beats/heartbeat/heartbeat-5.5.0-darwin-x86_64.tar.gz
tar xzvf heartbeat-5.5.0-darwin-x86_64.tar.gz

docker:

docker pull docker.elastic.co/beats/heartbeat:5.5.0

win:

  1. Download the Heartbeat Windows zip file from the downloads page.
  2. Extract the contents of the zip file into C:\Program Files.
  3. Rename the heartbeat-<version>-windows directory to Heartbeat.
  4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.
  5. From the PowerShell prompt, run the following commands to install Heartbeat as a Windows service:

    PS > cd 'C:\Program Files\Heartbeat'
    PS C:\Program Files\Heartbeat> .\install-service-heartbeat.ps1
Note

If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-heartbeat.ps1.

Before starting Heartbeat, you should look at the configuration options in the configuration file, for example C:\Program Files\Heartbeat\heartbeat.yml or /etc/heartbeat/heartbeat.yml. For more information about these options, see Configuration Options (Reference).