Skip to content

Update Heartbeat check overview page #1265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 6, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
260 changes: 161 additions & 99 deletions site/content/docs/heartbeat-checks/_index.md

Large diffs are not rendered by default.

20 changes: 19 additions & 1 deletion site/content/docs/monitoring/check-results.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ menu:
parent: "Monitoring"
---

You can select any check on the main Checkly dashboard to get an overview of the results they have produced so far. To learn about heartbeat check results, visit the [Heartbeat checks](/docs/heartbeat-checks/) section
You can select any check on the main Checkly dashboard to get an overview of the results they have produced so far.

## Check results overview

Expand Down Expand Up @@ -132,6 +132,24 @@ These include:

e. Download

## Heartbeat check results

Heartbeat check results show information about the ping request, like when it was recieved and its source.

![Using the Heartbeat check results view](/docs/images/monitoring/check-results-heartbeat.png)

The state indicates when your scheduled job pinged the Heartbeat check, relative to the expected time:

| State | Description |
| -------- | ------- |
| `EARLY` | Ping recieved before the expected time. |
| `RECEIVED` | Ping recieved right at the expected time. |
| `GRACE` | Ping recieved after the expected time, during the grace period. |
| `LATE` | Ping recieved during the few seconds between the end of the grace period and before the check is marked as failing. This is very rare. |
| `FAILING` | No ping recieved by the end of the grace period. Indicates a failing Heartbeat check. |

The source shows where your ping originated, determined by the `origin` and `referer` request headers. [Learn more about configuring the ping source](/docs/heartbeat-checks/#pinging-your-heartbeat-check).

## Multistep check results

Multistep check results are navigated using the tree on the left side of the screen. If you are running checks in parallel, first select the location you are interested in.
Expand Down
Loading