Skip to content

Commit cbbf769

Browse files
authored
Update Heartbeat pages based on recent name and pricing changes (#1329)
* feat: update 'Heartbeat check' wording to 'Heartbeat monitor' * fix: remove callout saying Heartbeat monitors are limited to Team and Enterprise
1 parent 22ef15a commit cbbf769

File tree

2 files changed

+21
-23
lines changed

2 files changed

+21
-23
lines changed

site/content/docs/heartbeat-monitors/_index.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,16 @@ aliases:
1717

1818
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.
1919

20-
> Heartbeat checks are available on our [Team and Enterprise plans](https://www.checklyhq.com/pricing).
20+
## What is a Heartbeat monitor?
2121

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.
2523
When a ping is not received on time, the check will trigger any configured alerts.
2624

27-
![Heartbeat check overview page](/docs/images/heartbeat-checks/heartbeat-check-overview.png)
25+
![Heartbeat monitor overview page](/docs/images/heartbeat-checks/heartbeat-check-overview.png)
2826

29-
Use Heartbeat checks to monitor backup jobs, data imports, and other recurring jobs or scripts.
27+
Use Heartbeat monitors to monitor backup jobs, data imports, and other recurring jobs or scripts.
3028

31-
For example, this is how you ping a Heartbeat check from a Heroku job:
29+
For example, this is how you ping a Heartbeat monitor from a Heroku job:
3230

3331
{{< tabs "Heroku example" >}}
3432
{{< tab "BASH" >}}
@@ -40,9 +38,9 @@ curl -m 5 --retry 3 https://api.checklyhq.com/heartbeats/ping/bcd964a7-6f15-49a5
4038

4139
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.
4240

43-
## Creating a Heartbeat check
41+
## Creating a Heartbeat monitor
4442

45-
![Heartbeat check create page](/docs/images/heartbeat-checks/create-heartbeat-check.png)
43+
![Heartbeat monitor create page](/docs/images/heartbeat-checks/create-heartbeat-check.png)
4644

4745
### Name and tag
4846
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
6159
Use grace to compensate for variance in your jobs.
6260

6361
### 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.
6563

66-
## Pinging your Heartbeat check
64+
## Pinging your Heartbeat monitor
6765

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

@@ -81,7 +79,7 @@ You can manually send pings via the Checkly UI. Use this to start the check time
8179

8280
![Manually send a ping via the Checkly UI on the check overview page](/docs/images/heartbeat-checks/heartbeat-ping-overview-page.png)
8381

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

8684
![Manually send a ping via the Checkly UI in the quick menu](/docs/images/heartbeat-checks/heartbeat-ping-quick-menu.png)
8785

@@ -100,14 +98,14 @@ If you have a check that expects a ping every 60 minutes starting at 09:30, and
10098

10199
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.
102100

103-
You can define a Heartbeat check via the CLI. For example:
101+
You can define a Heartbeat monitor via the CLI. For example:
104102

105103
{{< tabs "CLI example" >}}
106104
{{< tab "TypeScript" >}}
107105
```ts {title="heartbeat.check.ts"}
108-
import { HeartbeatCheck } from 'checkly/constructs'
106+
import { HeartbeatMonitor } from 'checkly/constructs'
109107

110-
new HeartbeatCheck('heartbeat-check-1', {
108+
new HeartbeatMonitor('heartbeat-monitor-1', {
111109
name: 'Send weekly newsletter job',
112110
period: 7,
113111
periodUnit: 'days',
@@ -119,9 +117,9 @@ new HeartbeatCheck('heartbeat-check-1', {
119117
{{< /tab >}}
120118
{{< tab "JavaScript" >}}
121119
```js {title="heartbeat.check.js"}
122-
const { HeartbeatCheck } = require('checkly/constructs')
120+
const { HeartbeatMonitor } = require('checkly/constructs')
123121

124-
new HeartbeatCheck('heartbeat-check-1', {
122+
new HeartbeatMonitor('heartbeat-monitor-1', {
125123
name: 'Send weekly newsletter job',
126124
period: 7,
127125
periodUnit: 'days',
@@ -142,4 +140,4 @@ For more options, see the [Check construct reference](/docs/cli/constructs-refer
142140
## Next steps
143141

144142
- Learn about the benefits of [Monitoring as Code](/guides/monitoring-as-code/).
145-
- Interpret your [Heartbeat check results](/docs/monitoring/check-results/#heartbeat-check-results).
143+
- Interpret your [Heartbeat monitor results](/docs/monitoring/check-results/#heartbeat-check-results).

site/content/docs/heartbeat-monitors/ping-examples.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ navTitle: Ping examples
55
weight: 15
66
menu:
77
resources:
8-
parent: "Heartbeat checks"
8+
parent: "Heartbeat monitors"
99

1010
---
1111

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

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

1616
## Shell
1717
Adding a ping to a shell script only requires a single line.
@@ -71,7 +71,7 @@ spec:
7171
7272
## Node.js
7373
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.
7575

7676
This is an example with the built-in [https.get](https://nodejs.org/api/https.html#httpsgeturl-options-callback) package:
7777

@@ -146,7 +146,7 @@ axios.get('https://ping.checklyhq.com/87c05896-3b7d-49ae-83ff-5e81323a54c4')
146146

147147
## Vercel cron jobs
148148

149-
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()`:
150150

151151
{{< tabs "Vercel example" >}}
152152
{{< tab "Next.js (App Router)" >}}

0 commit comments

Comments
 (0)