You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/content/docs/heartbeat-monitors/_index.md
+16-18Lines changed: 16 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,18 +17,16 @@ aliases:
17
17
18
18
Track your scheduled jobs with Heartbeat monitors. Heartbeat monitors listen for regular pings from your automated tasks, to ensure that they are running as expected.
19
19
20
-
> Heartbeat checks are available on our [Team and Enterprise plans](https://www.checklyhq.com/pricing).
20
+
## What is a Heartbeat monitor?
21
21
22
-
## What is a Heartbeat check?
23
-
24
-
A Heartbeat check is a passive check type that expects pings from an external source, such as a scheduled job on a server, at a defined interval. A ping is an HTTP request to a given endpoint URL using either the `GET` or `POST` method.
22
+
A Heartbeat monitor is a passive check type that expects pings from an external source, such as a scheduled job on a server, at a defined interval. A ping is an HTTP request to a given endpoint URL using either the `GET` or `POST` method.
25
23
When a ping is not received on time, the check will trigger any configured alerts.
Note the retry and timeout options. We recommend enabling retries when possible, to avoid false alarms due to temporary network issues or similar. You should also specify a timeout so that the ping doesn't block your ongoing job.
A meaningful name will not only help you and others identify your checks within Checkly, but it will help provide a better alerting experience if your checks fall into an alert state.
@@ -61,9 +59,9 @@ Grace is the amount of time Checkly will wait before triggering any alerts when
61
59
Use grace to compensate for variance in your jobs.
62
60
63
61
### Alerting
64
-
You can configure any of the provided [alert channels](/docs/alerting-and-retries/alert-channels/) for a Heartbeat check. If we don’t provide your preferred alert method, use [webhooks](/docs/alerting-and-retries/webhooks/) to configure your alert flow.
62
+
You can configure any of the provided [alert channels](/docs/alerting-and-retries/alert-channels/) for a Heartbeat monitor. If we don’t provide your preferred alert method, use [webhooks](/docs/alerting-and-retries/webhooks/) to configure your alert flow.
65
63
66
-
## Pinging your Heartbeat check
64
+
## Pinging your Heartbeat monitor
67
65
68
66
Once you've created your check, configure your scheduled job to send an HTTP request to your check's ping URL. For examples of how to do this, see [ping examples](/docs/heartbeat-checks/ping-examples).
69
67
@@ -81,7 +79,7 @@ You can manually send pings via the Checkly UI. Use this to start the check time
81
79
82
80

83
81
84
-
"Ping now" is also available in the quick menu in your list of Heartbeat checks.
82
+
"Ping now" is also available in the quick menu in your list of Heartbeat monitors.
85
83
86
84

87
85
@@ -100,14 +98,14 @@ If you have a check that expects a ping every 60 minutes starting at 09:30, and
100
98
101
99
The [Checkly CLI](/docs/cli/) gives you a JavaScript/TypeScript-native workflow for coding, testing and deploying synthetic monitoring at scale, from your code base.
102
100
103
-
You can define a Heartbeat check via the CLI. For example:
101
+
You can define a Heartbeat monitor via the CLI. For example:
Copy file name to clipboardExpand all lines: site/content/docs/heartbeat-monitors/ping-examples.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,13 @@ navTitle: Ping examples
5
5
weight: 15
6
6
menu:
7
7
resources:
8
-
parent: "Heartbeat checks"
8
+
parent: "Heartbeat monitors"
9
9
10
10
---
11
11
12
-
Here you can find examples on how to ping a Heartbeat check.
12
+
Here you can find examples on how to ping a Heartbeat monitor.
13
13
14
-
Most examples use `GET` as the request method, but Heartbeat checks also accept `POST` requests. Your check won't record `PUT` or `DELETE` requests as pings, and the endpoint will return an error.
14
+
Most examples use `GET` as the request method, but Heartbeat monitors also accept `POST` requests. Your check won't record `PUT` or `DELETE` requests as pings, and the endpoint will return an error.
15
15
16
16
## Shell
17
17
Adding a ping to a shell script only requires a single line.
@@ -71,7 +71,7 @@ spec:
71
71
72
72
## Node.js
73
73
74
-
You can use any HTTP request library (`https`, `axios`, etc.) to ping your Heartbeat check.
74
+
You can use any HTTP request library (`https`, `axios`, etc.) to ping your Heartbeat monitor.
75
75
76
76
This is an example with the built-in [https.get](https://nodejs.org/api/https.html#httpsgeturl-options-callback) package:
You can monitor your [Vercel cron jobs](https://vercel.com/docs/cron-jobs) with Heartbeat checks. At the end of your cron job, make an HTTP `GET` or `POST` request to your ping URL. For example, using `fetch()`:
149
+
You can monitor your [Vercel cron jobs](https://vercel.com/docs/cron-jobs) with Heartbeat monitors. At the end of your cron job, make an HTTP `GET` or `POST` request to your ping URL. For example, using `fetch()`:
0 commit comments