Step 1: Install Heartbeatedit

Unlike most Beats, which you install on edge nodes, you typically install Heartbeat as part of a 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.

Before you begin: If you haven’t installed the Elastic Stack, do that now. See Get started with the Elastic Stack.

To download and install Heartbeat, use the commands that work with your system.

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-7.6.2-amd64.deb
sudo dpkg -i heartbeat-7.6.2-amd64.deb

rpm:

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

mac:

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

brew:

brew tap elastic/tap
brew install elastic/tap/heartbeat-full

This installs the most recently released default distribution of Heartbeat. To install the OSS distribution, specify elastic/tap/heartbeat-oss.

linux:

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

docker:

See Running on Docker for deploying Docker containers.

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).
  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

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 Configure.