Prerequisite¶

The Heartbeat feature uses different IP addresses than the other Acquia Optimize modules and features. Allowlist the IP for your region to ensure that it functions properly. For the list of Heartbeat IP addresses, visit Data hosting and security.

Introduction¶

• Heartbeat uses random IP addresses. Heartbeat does not use JavaScript on the page so there is no analytics data that could alter your statistics values.

Setup¶

The Heartbeat feature is included in all packages, there is nothing that needs to be set up.

Configuration¶

This section provides instructions on how to configure or disable the Heartbeat feature.

1. Click Heartbeat (the heart icon), on the main dashboard toolbar.

   

2. Click the Configuration button (a gear icon) on the upper right side of the page.

   

   The Heartbeat Configuration page opens.

   
3. Fill in the fields:
   • Status: Toggle the switch ON to enable this feature. By default, this feature is ON.
     • URL: Enter the full URL, be sure to include all address elements 
       (http : // www. your domain name.com).
     • Ping Intervals: The default setting is 5 minutes.
     • Click Save to save the changes.

Notifications¶

This section provides information on the notices that Heartbeat provides.

• Response time notification: Toggle the switch ON to receive an email if the site has a slow response time.

  Note

  If there are no incidents registered for the page in the selected date range, the export file will be empty.

  

  Fill in the following fields:

  • Response time: Click the drop-down arrow and select a response time notification threshold.
  • Response time notification: Click the drop-down arrow and select the number of minutes of slow response time that should pass before the system sends an email.
  • Email receiver: Enter the email address for the alert to be sent to. Add as many as needed, and separate them with a space.
  • Click Save to save the changes.

• Downtime notification: Toggle the switch ON to receive an email if the site is down.

  Note

  If there are no incidents registered for the page in the selected date range, the export file will be empty.

  
  • Fill in the following fields:
    • Time to Warning: Click the drop-down arrow and select the amount of time the site should be down before a notification is sent.
    • Email receiver: Enter the email address for the alert to be sent to. Add as many as needed, and separate them with a space.
    • Notification when the downtime ends: Turn the switch ON to receive an email when the system is back up. The service message is sent to the same email.
    • Click Save to save the changes.

Heartbeat dashboard¶

This section provides instructions on how to use and understand the information shown on the Heartbeat dashboard.

1. Navigate to the domain dashboard.

2. Click Heartbeat (the heart icon), on the toolbar.

   
3. The Heartbeat landing page opens.
4. Toolbar buttons: On the top right side of the page, select:
   • Exports: Click the export icon. The current page is downloaded locally in CSV format.
   • +Add new check: The Heartbeat Checkpoint Information pane slides open. Provide the following information to create a new check:
     • Status: Toggle the switch OFF or ON to disable or enable this feature.
     • URL: Enter the full URL, be sure to include all elements of the address (http: // www. domain name.com).
     • Ping Intervals: Click the drop-down arrow and select the ping intervals for the website status.
       • 1 minute
       • 5 minutes

     • Response time notification: Toggle the switch ON to receive an email if the site has a slow response time.

       Note

       The export file is empty if there are no incidents registered for the page in the selected date range.

     • Downtime notification: Toggle the switch ON to receive an email if the site is down.

       Note

       If there are no incidents registered for the page in the selected date range, the export file will be empty.

     • Save: Click Save to save the configuration and close the configuration pane.
   • Exemption: See the Exemption section of this document for instructions.
   • Configuration: See the Configuration section of this document for instructions.
5. Average response time across all checkpoints
   • A graph identifies any performance incidents experienced by the domain over a selected timeframe. The graph also shows domain response time and average response time as measured in milliseconds.
   • Under the graph is a breakdown of domain outages during the selected time frame. The breakdown displays the start time, end time, and duration of outages.

Exemptions¶

This section provides instructions on how to add exemptions for instances of planned downtime, for example, server maintenance.

Add an exemption¶

1. Navigate to the domain dashboard.
2. Click Heartbeat (the heart icon) on the toolbar to open the Heartbeat landing page.
3. Click Exemption on the top right side of the page.

4. Click Add new exemption on the top right side of the Checkpoint Exemptions page.

   

5. The Add Exemption page opens.

   
6. Fill in the fields:
   • Repeat: Click the drop-down arrow and select a repeat frequency.
     • None
     • Daily
     • Weekly
     • Monthly.
   • Start date: Use the date-picker to select a start date and time.
   • End date: Use the date-picker to select an end date and time.
   • Exemption options: Tick to select an exemption option:
     • Exemption time is not part of the downtime calculation.
     • Exemption time is part of the downtime calculation (if you have 1 hour exemption time and no other downtimes in one day, your uptime will be shown as 95.83% uptime).
   • Description: Enter a free-text description of this exemption.
7. Click Save to save the changes. The pane closes and the new exemption is on the list.

Edit an exemption¶

1. On the same row as an exemption, click the gear icon. The Details pane opens for the exemption.
2. Edit as needed.
3. Click Save to save the changes.

Remove an exemption¶

This section provides instructions on how to remove an exemption.

1. On the same row as an exemption, click Delete (the trashcan icon).
2. A dialog opens asking, Are you sure you want to delete this exemption? Click Cancel to cancel the action or OK to delete the exemption.
3. The dialog closes and the exemption is gone from the list.