Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
8 changes: 3 additions & 5 deletions ai/llms-txt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@ The [llms.txt standard](https://llmstxt.org/) provides a machine-readable index
- [Adding team members to your Checkly account](https://checklyhq.com/docs/admin/team-management/adding-team-members.md): Learn how to invite team members to join your Checkly account and manage team collaboration
- [Using Microsoft Entra ID for Single Sign-on in Checkly](https://checklyhq.com/docs/admin/team-management/microsoft-azure-ad.md): This page illustrates the standard procedure to follow in order to get started with Microsoft Entra ID SSO (formerly Azure AD) on Checkly.
- [Multi-Factor Authentication in Checkly](https://checklyhq.com/docs/admin/team-management/multi-factor-authentication.md): Learn how to set up and manage multi-factor authentication for enhanced account security
- [Using Okta for Single Sign-on in Checkly](https://checklyhq.com/docs/admin/team-management/okta.md): This page illustrates the standard procedure to follow in order to get started with Okta SSO on Checkly.
- [Role Based Access Control in Checkly](https://checklyhq.com/docs/admin/team-management/rbac.md): Checkly roles and permissions for team members
- [Removing team members from your Checkly account](https://checklyhq.com/docs/admin/team-management/removing-team-members.md): Learn how to remove team members from your Checkly account and understand how it affects your billing
- [Using SAML for Single Sign-On in Checkly](https://checklyhq.com/docs/admin/team-management/saml-sso.md): Learn how to set up SAML-based SSO for your Checkly account with supported identity providers
- [Using SCIM provisioning in Checkly](https://checklyhq.com/docs/admin/team-management/scim-provisioning.md): Learn how to set up SCIM provisioning for Checkly using your identity provider
- [Admin Overview](https://checklyhq.com/docs/admin/team-management/overview.md): Comprehensive guide to managing your Checkly account, team members, security, and integrations
- [SAML for Single Sign-on in Checkly](https://checklyhq.com/docs/admin/team-management/saml.md): Learn how to configure SAML SSO integration with Checkly for your organization
- [Single Sign-on in Checkly](https://checklyhq.com/docs/admin/team-management/single-sign-on.md): Overview of Single Sign-On (SSO) options available in Checkly for enterprise security
- [Team management in Checkly](https://checklyhq.com/docs/admin/team-management.md): Manage your team and collaborate effectively in Checkly
```

Expand Down
4 changes: 2 additions & 2 deletions detect/synthetic-monitoring/browser-checks/file-system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ import { test, expect } from '@playwright/test'
test('Upload a file using a POST request', async ({ request }) => {
const fileUrl = 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf'
const fileBuffer = await request.get(fileUrl)
const response = await request.post('https://filebin.net/pp9on3zvwv7zq6lm/dummy.pdf', {
const response = await request.post('https://httpbin.org/post', {
data: await fileBuffer.body(),
})
await expect(response).toBeOK()
Expand All @@ -151,7 +151,7 @@ const { test, expect } = require('@playwright/test')
test('Upload a file using a POST request', async ({ request }) => {
const fileUrl = 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf'
const fileBuffer = await request.get(fileUrl)
const response = await request.post('https://filebin.net/pp9on3zvwv7zq6lm/dummy.pdf', {
const response = await request.post('https://httpbin.org/post', {
data: await fileBuffer.body(),
})
await expect(response).toBeOK()
Expand Down
4 changes: 2 additions & 2 deletions detect/synthetic-monitoring/multistep-checks/file-system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ test('Upload a file using a POST request', async ({ request }) => {
})

await test.step('Upload file', async () => {
const response = await request.post('https://filebin.net/pp9on3zvwv7zq6lm/dummy.pdf', {
const response = await request.post('https://httpbin.org/post', {
data: await fileBuffer.body(),
})
await expect(response).toBeOK()
Expand All @@ -45,7 +45,7 @@ test('Upload a file using a POST request', async ({ request }) => {
})

await test.step('Upload file', async () => {
const response = await request.post('https://filebin.net/pp9on3zvwv7zq6lm/dummy.pdf', {
const response = await request.post('https://httpbin.org/post', {
data: await fileBuffer.body(),
})
await expect(response).toBeOK()
Expand Down
2 changes: 1 addition & 1 deletion detect/testing/playwright-reporter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Before using the Playwright reporter, ensure you have:

- Node.js >= 18.0.0
- Playwright >= 1.40.0
- A Checkly account ([sign up](https://www.checklyhq.com/signup))
- A Checkly account ([sign up](https://app.checklyhq.com/signup))
</Accordion>

## Install the Playwright Reporter
Expand Down
8 changes: 8 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -1415,6 +1415,14 @@
"source": "/api-reference/error-groups/update-an-error-group-mainly-used-for-archiving-error-groups/",
"destination": "/api-reference/error-groups/update-an-error-group"
},
{
"source": "/monitoring/check-results",
"destination": "/concepts/results"
},
{
"source": "/detect/synthetic-monitoring/browser-checks/results",
"destination": "/concepts/results"
},
{
"source": "/assertions",
"destination": "/detect/assertions"
Expand Down
14 changes: 7 additions & 7 deletions guides/create-multiple-monitors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ import { Frequency, UrlMonitor, UrlAssertionBuilder } from 'checkly/constructs'
const sitemapUrls = [
'https://www.checklyhq.com/docs/',
'https://www.checklyhq.com/learn/playwright/codegen/',
'https://www.checklyhq.com/guides/using-pw-test-command/',
'https://www.checklyhq.com/docs/guides/setup-scripts-for-apis/',
'https://www.checklyhq.com/docs/api-reference/incidents/create-an-incident/',
'https://www.checklyhq.com/customers/'
]
Expand Down Expand Up @@ -132,7 +132,7 @@ In our previous check, we defined the URLs to monitor in an array at the top of
const sitemapUrls = [
'https://www.checklyhq.com/docs/',
'https://www.checklyhq.com/learn/playwright/codegen/',
'https://www.checklyhq.com/guides/using-pw-test-command/',
'https://www.checklyhq.com/docs/guides/setup-scripts-for-apis/',
'https://www.checklyhq.com/docs/api-reference/incidents/create-an-incident/',
'https://www.checklyhq.com/customers/'
]
Expand All @@ -144,7 +144,7 @@ Rather than having to edit this check’s code every time we update our list of
{ "urls":[
"https://www.checklyhq.com/docs/",
"https://www.checklyhq.com/learn/playwright/codegen/",
"https://www.checklyhq.com/guides/using-pw-test-command/",
"https://www.checklyhq.com/docs/guides/setup-scripts-for-apis/",
"https://www.checklyhq.com/docs/api-reference/incidents/create-an-incident/",
"https://www.checklyhq.com/customers/"
]}
Expand All @@ -166,10 +166,10 @@ Let’s continue to increase the sophistication of our group of monitors. Right

| url | logicalID | name |
| --- | --- | --- |
| [https://www.checklyhq.com/docs/](https://www.checklyhq.com/docs/,) | docs-1 | url monitor docs-1 |
| [https://www.checklyhq.com/learn/playwright/codegen/](https://www.checklyhq.com/learn/playwright/codegen/,) | codegen-1 | url monitor codegen-1 |
| [https://www.checklyhq.com/guides/using-pw-test-command/](https://www.checklyhq.com/guides/using-pw-test-command/,) | pw-test-1 | url monitor pw-test-1 |
| [https://www.checklyhq.com/docs/api-reference/incidents/create-an-incident/](https://www.checklyhq.com/docs/api-reference/incidents/create-an-incident/,) | incidents-1 | url monitor incidents-1 |
| `https://www.checklyhq.com/docs/` | docs-1 | url monitor docs-1 |
| `https://www.checklyhq.com/learn/playwright/codegen/` | codegen-1 | url monitor codegen-1 |
| `https://www.checklyhq.com/guides/using-pw-test-command/` | pw-test-1 | url monitor pw-test-1 |
| `https://www.checklyhq.com/docs/api-reference/incidents/create-an-incident/` | incidents-1 | url monitor incidents-1 |

And this version of the URL monitor fetches the CSV and parses the three values for each check from the row before creating a monitor.

Expand Down
4 changes: 2 additions & 2 deletions guides/getting-started-with-monitoring-as-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ test('Checkly Docs', async ({ page }) => {

---

This test uses the page.goto method to navigate to the specified URL (‘[https://www.checklyhq.com/docs/browser-checks/’](https://www.checklyhq.com/docs/browser-checks/%E2%80%99)). The method returns a response object, which is stored in the response variable.
This test uses the page.goto method to navigate to the specified URL (`https://www.checklyhq.com/docs/browser-checks/`). The method returns a response object, which is stored in the response variable.

Then we use the expect function to assert that the HTTP status code of the response is less than 400. This is a way to ensure that the page is loaded successfully without any HTTP errors.

Expand Down Expand Up @@ -142,7 +142,7 @@ To set up alerts for your check, go to the specific project, in this case, "home

![setting up alerts with checkly](/images/guides/images/guides-getting-started-alerts.jpeg "Setting up Alerts with Checkly")

Here, configure monitoring parameters according to your needs, including check frequency, locations, retries and alerting. You can also set up your preferred alert channel using the Checkly CLI. Learn more about the alert channels from the [official documentation](https://www.checklyhq.com/cli/overviewconstructs-reference/#alertchannel).
Here, configure monitoring parameters according to your needs, including check frequency, locations, retries and alerting. You can also set up your preferred alert channel using the Checkly CLI. Learn more about the alert channels from the [official documentation](/constructs/alert-channel).

With the appropriate alert channels set up, there is no need for customers to regularly visit the dashboard. Instead, they will be promptly notified, allowing them to react immediately upon receiving alerts.

Expand Down
4 changes: 2 additions & 2 deletions guides/monitoring-an-openapi-spec.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Following the OAS brings the following advantages:
2. The possibility of automatically generating documentation, implementation logic and even mock servers for testing.
3. Early validation of the data flows happening within the API.

For those new to the OAS and wanting to get a basic understanding without diving straight into the specification itself, the official [OpenAPI Specification Explained](https://oai.github.io/Documentation/specification.html) guide is a great place to start.
For those new to the OAS and wanting to get a basic understanding without diving straight into the specification itself, the official [OpenAPI Specification Explained](https://learn.openapis.org/specification/) guide is a great place to start.

## Swagger vs OpenAPI

Expand Down Expand Up @@ -186,7 +186,7 @@ Depending on how much is described in a given API spec, it is possible to move e

## Generated monitoring checks with Checkly

[API monitoring](/learn/monitoring/api-monitoring) is key to ensure that our endpoints are returning the correct results in an acceptable timeframe. If we can generate APIs from a OAS description file, we can also generate monitoring checks for them. Checkly is [a member of the OpenAPI initiative](https://www.openapis.org/membership/members), and allows us to import an OpenAPI spec file and automatically creates one or more checks depending on the amount of information available. All it takes is a couple of clicks.
[API monitoring](/learn/monitoring/api-monitoring) is key to ensure that our endpoints are returning the correct results in an acceptable timeframe. If we can generate APIs from a OAS description file, we can also generate monitoring checks for them. Checkly is [a member of the OpenAPI initiative](https://www.openapis.org/about), and allows us to import an OpenAPI spec file and automatically creates one or more checks depending on the amount of information available. All it takes is a couple of clicks.

When creating an API check, select the `import from Swagger / OpenAPI` button.

Expand Down
2 changes: 1 addition & 1 deletion guides/monitoring-ecommerce-apps-using-playwright.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Watch our launch event to learn more about our CLI:
Users who have already used Checkly will be familiar with creating Checks, Check Groups, Alert Channels and other resources through the Checkly UI. Creating, debugging and managing E2E and synthetic monitoring at scale is best done “as code”. Currently, Checkly supports three tools you can use for your monitoring as code (MaC) workflow:

1. [The Checkly CLI.](https://www.checklyhq.com/cli/overview)
2. [Terraform (through our Terraform provider)](https://checklyhq-com-git-cli-guide-checkly.vercel.app/docs/terraform-provider/)
2. [Terraform (through our Terraform provider)](/integrations/iac/terraform/overview)
3. [Pulumi (through our Pulumi provider)](https://www.checklyhq.com/docs/integrations/pulumi/)

## Monitoring an e-commerce website - as code
Expand Down
4 changes: 2 additions & 2 deletions guides/moving-from-puppeteer-to-playwright.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Remember to add `await` as necessary.
| `page.waitForXPath(XPathSelector)` | `page.waitForSelector(XPathSelector)` |
| `page.$x(xpath_selector)` | `page.$(xpath_selector)` |
| `page.waitForNetworkIdle(...)` | `page.waitForLoadState({ state: 'networkidle' })` |
| `page.waitForFileChooser(...)` | Removed, [handled differently](https://playwright.dev/docs/input/#upload-files). |
| `page.waitForFileChooser(...)` | Removed, [handled differently](https://playwright.dev/docs/input#upload-files). |
| `page.waitFor(timeout)` | `page.waitForTimeout(timeout)` |
| `page.type(selector, text)` | `page.fill(selector, text)` |
| `page.cookies([...urls])` | `browserContext.cookies([urls])` |
Expand Down Expand Up @@ -235,7 +235,7 @@ await page.route('**/*', (route) => {

See our [full guide](/learn/playwright/intercept-requests) on request interception for more examples.

> For many of the points in the list above, variations of the same function exist at [Page](https://playwright.dev/docs/api/class-page/), [Frame](https://playwright.dev/docs/api/class-frame/) and [ElementHandle](https://playwright.dev/docs/api/class-elementhandle/) level. For simplicity, we reported only one.
> For many of the points in the list above, variations of the same function exist at [Page](https://playwright.dev/docs/api/class-page), [Frame](https://playwright.dev/docs/api/class-frame) and [ElementHandle](https://playwright.dev/docs/api/class-elementhandle) level. For simplicity, we reported only one.

## New possibilities to be aware of

Expand Down
4 changes: 2 additions & 2 deletions guides/sdlc-monitoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ This command overrides the `SCREENSHOT_URL` variable for that specific test run,

### Optional: Private locations for running Checkly within your cloud

For enterprise users, you may want to run Checkly monitors from within your cloud. This is especially helpful if your API isn’t available on the public internet, or you want to run checks from a geographic location not covered by the Checkly system. If your development and staging locations are running on private clouds, a [Checkly Private Location](https://www.checklyhq.com/docs/detect/private-locations/overview) makes testing easier.
For enterprise users, you may want to run Checkly monitors from within your cloud. This is especially helpful if your API isn’t available on the public internet, or you want to run checks from a geographic location not covered by the Checkly system. If your development and staging locations are running on private clouds, a [Checkly Private Location](/platform/private-locations/overview) makes testing easier.

![a diagram showing A container on your cloud running a Checkly Private Location](/images/guides/images/sdlc-monitoring-06.png)

Expand Down Expand Up @@ -247,7 +247,7 @@ Checkly Traces is easy to implement even if you aren’t currently using OpenTel
Once you’ve moved to production, it’s time to run your tests on a cadence, creating a monitor that tell you within minutes if any part of your service goes down. The process for setting this cadence looks like:

1. [Determine the right check frequency](https://www.checklyhq.com/blog/check-frequency/) based on SLA
2. Configure your tests either in the web UI or by editing your [test repository’s config](https://www.checklyhq.com/cli/overviewproject-structure/) file
2. Configure your tests either in the web UI or by editing your [test repository’s config](/constructs/project) file
3. [Group or tag tests](https://www.checklyhq.com/docs/groups/#organizing-checks-with-groups---checkly-docs) by criticality to have consistent cadence for high value services - this also makes it easier to see checks together in the web UI

With alerts running on a cadence, you can ensure that you’re hearing about failures before your users report them. The final step is setting up the alerting your team receives when a monitor detects problems.
Expand Down
4 changes: 2 additions & 2 deletions guides/uptime-monitoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,13 @@ new TcpMonitor('hello-tcp-1', {

*A basic URL monitor ready to deploy*

TCP monitors offer similar options to URL monitors, with the addition of assertions to evaluate the responses. Read more about [TCP check assertions on our docs site](https://www.checklyhq.com/cli/overviewconstructs-reference/#tcpassertionbuilder).
TCP monitors offer similar options to URL monitors, with the addition of assertions to evaluate the responses. Read more about [TCP check assertions on our docs site](/constructs/tcp-monitor).

![A TCP check dashboard](/images/guides/images/uptime-01.png)

*Results for TCP checks include the status of your SSL certification, and can send alerts if your certs are close to expiring.*

TCP checks are also helpful at identifying any DNS issues, as these request will also perform DNS lookup if you provide a hostname and, like the other checks in this guide, [the results for a TCP check](https://www.checklyhq.com/docs/monitoring/check-results/#tcp-monitor-results) will include DNS lookup time.
TCP checks are also helpful at identifying any DNS issues, as these request will also perform DNS lookup if you provide a hostname and, like the other checks in this guide, [the results for a TCP check](/concepts/results) will include DNS lookup time.

## The Heartbeat Monitor, for services that don’t accept incoming requests

Expand Down
2 changes: 1 addition & 1 deletion integrations/iac/terraform/command-line-triggers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebarTitle: 'Command line Triggers'
description: 'Set up command line triggers to run checks from CI/CD pipelines or programmatically'
---

[Command line triggers](https://www.checklyhq.com/docs/cicd/triggers/) enable you to call a check from a CI/CD pipeline, a bash shell or programmatically in your code.
[Command line triggers](/cli/checkly-trigger) enable you to call a check from a CI/CD pipeline, a bash shell or programmatically in your code.

You can specify command line triggers as standalone resources at check or group level:

Expand Down
2 changes: 1 addition & 1 deletion integrations/incident-management/firehydrant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Checkly integrates with [FireHydrant](https://firehydrant.io/) to create and res
* Alert you on Slack when a check fails, allowing you to create an incident on FireHydrant with one click.
* Close incidents automatically when a failing check recovers.

Assuming you already have [set up Slack on FireHydrant](https://support.firehydrant.io/hc/en-us/articles/360058203511), the integration can be configured as follows:
Assuming you already have [set up Slack on FireHydrant](https://docs.firehydrant.com/), the integration can be configured as follows:

1. Log in to FireHydrant and navigate to `Integrations > Connected & available`, then select Checkly.

Expand Down
Loading
Loading