How to use Heartbeats?

The Heartbeats feature can be used to ensure that your monitoring/observability tool is able to connect to Compass continuously and that:

• There is no network problems between your system and Compass

• Your Heartbeat sender system is working as expected

Heartbeats can also be used to monitor your periodic tasks are running as expected by using a suitable Heartbeat expire interval regarding your periodic task run time.

For example, when a Heartbeat is added to Compass with an interval of 10 minutes, your system is expected to send http based Heartbeat requests periodically, at least every 10 minutes. If a Heartbeat request is not received for more than 10 minutes, Compass will conclude that there is a problem between your system and Compass and create an alert according to your settings.

You can add any number of Heartbeats to monitor your systems and tasks. You can configure the check intervals for each Heartbeat separately up to once per minute.

Use Heartbeats with APIs

1. Create an API token from Atlassian Account to authenticate your sender system

2. Add the relevant information as explained in the API documentation and make a GET request to the following URL:

   https://api.atlassian.com/compass/ops/api/8db8e782-cc7e-4ab0-9548-817b43b877e9/v1/teams/46d4ea89-df3b-4748-955b-0ffd042833ba/heartbeats/ping?name=testheartbeat

3. Use this token and the heartbeat details to complete the information in the GET request.

4. Send pings before the ping interval exceeds the limit to prevent the heartbeat from becoming unresponsive.

Use Heartbeats with built-in email

Send a built-in email to Compass to ping a Heartbeat. While creating Heartbeats on Compass, you will see the built-in email address configured according to your account and the Heartbeat name. Note that the Heartbeat name should be correctly formatted according to RFC 822 standards to use this feature.