Skip to content

Commit e1ee0e5

Browse files
pmallolsujaya-syssorccu
authored
feat: URL monitors (#1315)
* feat: add HTTP checks resource and update weights for menu items * feat: add HTTP check card to the documentation index * feat: update analytics API documentation to include HTTP check endpoints * feat: add HTTP Check documentation with examples and assertion details * feat: add metric name for HTTP check timing in Prometheus V2 documentation * feat: add example for creating an HTTP check in Pulumi documentation * feat: add HTTP check results section with details and new image * docs: enhance Playwright Check Suites section with HTTP checks * feat: update incident automation documentation to include HTTP checks * feat: add HTTP checks documentation with examples and configuration details * style: improve formatting and readability in API and TCP checks documentation * docs: add HTTP checks section with links to documentation * rework config and index * undo index.md changes * Update CLI reference * Updated dev docs with latest uRL monitor requirements * Improve wording * Adjusted results page * Updated analytics and prometheus wording * Updated screenshot * Tcp monitor renaming (#1319) * docs: update references from TCP checks to TCP monitors * docs: rename tc-monitors url * docs: update reference from Check construct to Monitor construct * docs: improve formatting in constructs reference * docs: update terminology from check to monitor in TCP monitors documentation * Added one missing case for rewording * added alias --------- Co-authored-by: Susa Tünker <[email protected]> Co-authored-by: Susa Tünker <[email protected]> * docs: update HTTP check title and description to reflect URL monitoring * Changed HTTP check to URL monitor (regression) * Update CLI construct reference * Updated pricing references * hide pricing page * Update landing page * Included Albertos changes * Added updated icons * Update site/content/docs/cli/constructs-reference.md Co-authored-by: Simo Kinnunen <[email protected]> * fix: folder naming Co-authored-by: Simo Kinnunen <[email protected]> * fix: check.ts extension Co-authored-by: Simo Kinnunen <[email protected]> * Update site/content/docs/cli/constructs-reference.md Co-authored-by: Simo Kinnunen <[email protected]> * Update site/content/docs/cli/constructs-reference.md Co-authored-by: Simo Kinnunen <[email protected]> * Update site/content/docs/cli/constructs-reference.md Co-authored-by: Simo Kinnunen <[email protected]> * Update site/content/docs/cli/constructs-reference.md Co-authored-by: Simo Kinnunen <[email protected]> * Update site/content/docs/cli/constructs-reference.md Co-authored-by: Simo Kinnunen <[email protected]> * Update site/content/docs/cli/constructs-reference.md Co-authored-by: Simo Kinnunen <[email protected]> * Update site/content/docs/cli/constructs-reference.md Co-authored-by: Simo Kinnunen <[email protected]> * Incorporate Simo's feedback * Updated CLI references with shared properties * Removed monitor class section * Updated path to rener icons * Clean up landing page * Add checkly_api_check_timing_seconds * Update SVG icons for TCP and URL with new designs and improved structure --------- Co-authored-by: Susa Tünker <[email protected]> Co-authored-by: Susa Tünker <[email protected]> Co-authored-by: Simo Kinnunen <[email protected]>
1 parent d9e3a68 commit e1ee0e5

File tree

30 files changed

+430
-265
lines changed

30 files changed

+430
-265
lines changed
623 KB
Loading

site/config.toml

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -108,60 +108,65 @@ disqusShortname = "checkly"
108108
url = "/docs/browser-checks/"
109109
weight = 30
110110

111-
[[menu.resources]]
112-
name = "Heartbeat monitors"
113-
url = "/docs/heartbeat-monitors/"
114-
weight = 35
115-
116111
[[menu.resources]]
117112
name = "Multistep checks"
118113
url = "/docs/multistep-checks/"
119114
weight = 40
120115

121-
[[menu.resources]]
122-
name = "TCP checks"
123-
url = "/docs/tcp-checks/"
124-
weight = 45
125-
126116
[[menu.resources]]
127117
name = "Playwright Check Suites (Beta)"
128118
url = "/docs/playwright-checks/"
129119
weight = 50
130120

121+
[[menu.resources]]
122+
name = "URL monitors"
123+
url = "/docs/url-monitors/"
124+
weight = 60
125+
126+
[[menu.resources]]
127+
name = "TCP monitors"
128+
url = "/docs/tcp-monitors/"
129+
weight = 70
130+
131+
[[menu.resources]]
132+
name = "Heartbeat monitors"
133+
url = "/docs/heartbeat-monitors/"
134+
weight = 80
135+
131136
[[menu.resources]]
132137
name = "Groups"
133138
url = "/docs/groups/"
134-
weight = 55
139+
weight = 90
135140

136141
[[menu.resources]]
137142
name = "Alerting & retries"
138143
url = "/docs/alerting/"
139-
weight = 60
144+
weight = 100
140145

141146
[[menu.resources]]
142147
name = "Maintenance windows"
143148
url = "/docs/maintenance-windows/"
144-
weight = 70
149+
weight = 110
145150

146151
[[menu.resources]]
147152
name = "Dashboards"
148153
url = "/docs/dashboards/"
149-
weight = 80
154+
weight = 120
150155

151156
[[menu.resources]]
152157
name = "Status Pages"
153158
url = "/docs/status-pages/"
154-
weight = 85
159+
weight = 130
155160

156161
[[menu.resources]]
157162
name = "Accounts & Users"
158163
url = "/docs/accounts-users/"
159-
weight = 90
164+
weight = 140
160165

161166
[[menu.resources]]
162167
name = "Private Locations"
163168
url = "/docs/private-locations/"
164-
weight = 95
169+
weight = 150
165170

166171
[[menu.resources]]
167172
name = "Reporting"

site/content/_shared/variables-and-secrets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ There are two ways to store configuration information in Checkly: Variables and
77
- **Variables** are used to store non-sensitive information. Variables are shown in plaintext when being edited, on the check result page and in logs. Variables can be accessed via the CLI and API.
88
- **Secrets** allow you to store sensitive data for use in checks. Once saved secrets are never shown in the UI or in logs. The secret value cannot be accessed via the CLI or API.
99

10-
> Secrets are available for [Private Locations](/docs/private-locations/) on agent version `3.3.4` and later. Secrets are available on [CLI](/docs/cli/) version `4.9.0` and later.
10+
> Secrets are fully supported starting with runtime version 2024.09 and later. For [Private Locations](/docs/private-locations/), secrets are available in agent version `3.3.4` and later, and for the [CLI](/docs/cli/), in version `4.9.0` and later.
1111
1212
> [!WARNING]
1313
> To ensure the integrity of Playwright artifacts (traces, videos and screenshots), the following are not scrubbed, even when saved as secrets: The characters `/` and `*` and the full or partial match of `/artifact/`, `https://`, `http://`, `*********`, and `123`.

site/content/docs/CICD/vercel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Checkly offers two integrations for Vercel users:
2727
To install Checkly's managed Vercel integration, navigate to the [integration's marketplace listing](https://vercel.com/integrations/checkly) and click `Install`.
2828

2929
1. Select `Create new account` in the installation guide and click `Next` to accept the terms and conditions.
30-
2. Select your plan type. You can read about our pricing plans [here](https://www.checklyhq.com/pricing/), and more about how we bill checks [here](/docs/monitoring/check-pricing/).
30+
2. Select your plan type. You can read about our pricing plans [here](https://www.checklyhq.com/pricing/) here.
3131
3. Name your account and review your plan selection. You can change your account name later.
3232
4. Press `Create` to continue to the integration settings page. Select `Getting started` to go to the setup guide in Vercel. You can also click `Open in Checkly` to go through the Checkly + Vercel onboarding and get you started with an example project showcasing how to use Monitoring as Code together with Vercel. You can find the [example NextJS project on GitHub](https://github.com/checkly/nextjs-checkly-starter-template) which includes a guide on how to use Monitoring as Code with a NextJS project.
3333

site/content/docs/_index.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ Checks, Browser Checks and all other constructs.
4646
Not quite ready to start your monitoring as code journey? No problem. Get started using just the web UI and you'll be
4747
monitoring in minutes.
4848

49+
### Synthetic Checks
50+
Checkly synthetic checks are automated end to end tests that simulate user interactions or API requests to monitor the performance and availability of web applications and services.
51+
4952
<div class="cards-list">
5053
{{< doc-card
5154
class="two-column-card"
@@ -60,7 +63,7 @@ monitoring in minutes.
6063
headerTag="h3"
6164
title="Create an API check"
6265
img="/docs/images/icons/api.svg"
63-
description="Monitor the latency and assert the correctness of your API endpoints. Use inline scripts and code to customize everything."
66+
description="Monitor the latency and assert the correctness of your API endpoints. Use setup and teardown scripts to customize your requests."
6467
link="/docs/api-checks"
6568
>}}
6669
</div>
@@ -77,10 +80,32 @@ monitoring in minutes.
7780
{{< doc-card
7881
class="two-column-card"
7982
headerTag="h3"
80-
title="Create a TCP check"
83+
title="Create a Playwright check suite (Beta)"
84+
img="/docs/images/icons/playwright-check.svg"
85+
description="Use your existing Playwright tests as live, scheduled checks to verify functionality, performance, and reliability from different locations"
86+
link="/docs/playwright-checks/"
87+
>}}
88+
</div>
89+
90+
### Uptime Monitors
91+
Use Uptime monitors to regularly check if a website, port, or service is available and responding as expected.
92+
93+
<div class="cards-list">
94+
{{< doc-card
95+
class="two-column-card"
96+
headerTag="h3"
97+
title="Create a URL monitor"
98+
img="/docs/images/icons/url.svg"
99+
description="Monitor HTTP resources to verify that your website or service is online and returning the expected response."
100+
link="/docs/url-monitors/"
101+
>}}
102+
{{< doc-card
103+
class="two-column-card"
104+
headerTag="h3"
105+
title="Create a TCP monitor"
81106
img="/docs/images/icons/tcp.svg"
82107
description="Monitor the availability and performance of your TCP services by establishing TCP connections and verifying the response."
83-
link="/docs/tcp-checks/"
108+
link="/docs/tcp-monitors/"
84109
>}}
85110
</div>
86111
@@ -93,14 +118,6 @@ monitoring in minutes.
93118
description="Monitor your backup jobs, data imports, and other recurring jobs or scripts by pinging Checkly at a regular interval."
94119
link="/docs/heartbeat-monitors/"
95120
>}}
96-
{{< doc-card
97-
class="two-column-card"
98-
headerTag="h3"
99-
title="Set up alert channels"
100-
img="/docs/images/icons/alerting.svg"
101-
description="Get notified about outages or slow downs in your webapps and APIs. Connect to one of our many integrations like Slack and Pagerduty."
102-
link="/docs/alerting"
103-
>}}
104121
</div>
105122
106123
## Additional resources

site/content/docs/analytics/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ or keep reading for more examples!
2727

2828
There are three main endpoints.
2929

30-
1. `/v1/analytics/metrics/`: returns all the available metrics for a specific check-type (`API`, `TCP` or `BROWSER`)
31-
2. `/v1/analytics/browser-checks/{checkId}`: returns metrics for Browser checks.
30+
1. `/v1/analytics/metrics/`: returns all the available metrics for a specific check-type (`API`, `URL`, `TCP` or `BROWSER`)
31+
2. `/v1/analytics/browser-checks/{checkId}`: returns metrics for Browser checks.
3232
3. `/v1/analytics/api-checks/{checkId}`: returns metrics for API checks.
33-
4. `/v1/analytics/tcp-checks/{checkId}`: returns metrics for TCP checks.
33+
4. `/v1/analytics/url-monitors/{checkId}`: returns metrics for URL monitors.
34+
5. `/v1/analytics/tcp-checks/{checkId}`: returns metrics for TCP monitors.
3435

3536
The specific endpoints per check type return a JSON response that includes a check's attributes, period requested,
3637
grouped `series` and a `metadata` section where you'll have additional information about the metrics to create rich reports.

site/content/docs/api-checks/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Ensure your API is working properly with API checks. API checks work by sending
1818
![Screenshot of the API check overview page](/docs/images/api-checks/overview-check-overview.png)
1919

2020
For example, you can use these checks to verify that:
21+
2122
* Your endpoint returns a 200 status code.
2223
* Your endpoint responds with valid JSON that matches the expected schema.
2324
* Your endpoint is properly authenticating requests.
@@ -41,7 +42,7 @@ This is where you configure the API endpoint. The most important part of your AP
4142

4243
Endpoints can be accessed and manipulated through [HTTP methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods). Not all methods are valid for all endpoints.
4344

44-
You can import a cURL command, Swagger.json or OpenAPI specification here too.
45+
You can import a cURL command, Swagger.json or OpenAPI specification here too.
4546

4647
### Setup and teardown scripts
4748

@@ -57,6 +58,7 @@ Sometimes APIs can be slow, but not broken. We call this degraded. You can set [
5758

5859
This is where you determine whether the response of the HTTP request is correct or not.
5960
You can assert on different sources. These could be:
61+
6062
- The HTTP status code returned from the API
6163
- Something missing or required within the response body
6264
- A specific response header

site/content/docs/browser-checks/variables.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ You should therefore **replace any confidential data in your check scripts with
2020

2121
You can create variables at three hierarchical levels:
2222

23-
- **Check** level - Browser and multistep check supported.
24-
- **Group** level - API & network as well as browser and multistep checks supported.
25-
- **Global** level - API & network as well as browser and multistep checks supported.
23+
- **Check** level (Only supported by API, Browser, Multistep & Playwright checks)
24+
- **Group** level
25+
- **Global** level
2626

2727
Add variables specific to a Check variables on the **Variables** tab for each browser and multistep check.
2828

0 commit comments

Comments
 (0)