Skip to content

Commit 9b83f86

Browse files
committed
Add Playwright check type comparison
1 parent 61e86c9 commit 9b83f86

File tree

3 files changed

+58
-2
lines changed

3 files changed

+58
-2
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: 'Playwright Monitoring Comparison'
3+
description: 'Compare the features of the different Playwright-based checks'
4+
sidebarTitle: 'Playwright Feature Comparison'
5+
6+
---
7+
8+
import { checkDurations } from '/snippets/check-comparison.mdx'
9+
10+
[MultiStep Checks](/detect/synthetic-monitoring/multistep-checks/overview), [Browser Checks](/detect/synthetic-monitoring/browser-checks/overview), and [Playwright Check Suites](/detect/synthetic-monitoring/playwright-checks/overview) use Playwright for synthetic monitoring. The different check types differ in terms of capabilities, flexibility, and use cases.
11+
12+
Checkly's strengths is that you can login into the Checkly web application, write Playwright code in the built-in editor and start monitoring your APIs and sites. **MultiStep and Browser checks are the perfect tools to get you off the ground quickly.** Don't worry about where to store the monitoring code, how to configure advanced configuration, or when to update dependencies. Checkly takes care of all of this.
13+
14+
However, when your monitoring setup needs to match scaling and growing project requirements, you'll quickly find yourself looking for ways to version-control your checks with [the Monitoring as Code approach \(MaC\)](/concepts/monitoring-as-code).
15+
16+
All Playwright-based checks can be created, updated and configured as code. But, when should you use which?
17+
18+
## When to use MultiStep Checks
19+
20+
[MultiStep Checks](/detect/synthetic-monitoring/multistep-checks/overview) enable you to monitor complex API workflows with sequential requests using the familiar Playwright API. The check run is based on a single `spec.ts` file, limited to making HTTP requests (there's no browser available) and **the max check run duration is capped at { checkDurations.multiStep }**.
21+
22+
## When to use Browser Checks
23+
24+
[Browser Checks](/detect/synthetic-monitoring/browser-checks/overview) let you monitor end-to-end user flows and realistic interactions with automated browser testing using Playwright. The check run is based on a single `spec.ts` file, supports the headless Chromium/Chrome browser and **the max check run duration is capped at { checkDurations.browser }**.
25+
26+
## When to use Playwright Check Suites
27+
28+
MultiStep and Browser Checks are single units based on a single `spec.ts` file.
29+
30+
[Playwright Check Suites](/detect/synthetic-monitoring/playwright-checks/overview), on the other hand, let you take your entire existing Playwright test suite, and turn it into globally distributed monitoring. Check Suites support multiple spec files, advanced global configuration, multiple Playwright projects, tags for selective monitoring, storage state, custom dependencies, and more.
31+
32+
<Tip>
33+
Playwright Check Suites are the native way to run your Playwright project in production.
34+
</Tip>
35+
36+
## Feature comparison
37+
38+
| Feature | Playwright Check Suite | Browser Check | MultiStep Check |
39+
|-----------------------------------------------|-------------------------------|---------------------------------|---------------------------------|
40+
| Supports *Monitoring as Code* | Yes | Yes | Yes |
41+
| Supported test formats | API and Browser | API and Browser | API only |
42+
| Multiple spec files | Yes | No | No |
43+
| Flexible test selection via tags and projects | Yes | No | No |
44+
| Browser compatibility | Chromium, Webkit, Firefox | Chromium, Chrome | Chromium, Chrome |
45+
| Storage state support | Yes | No | No |
46+
| Multiple Playwright Project support | Yes | No | No |
47+
| Custom dependencies (public and private) | Yes | No, fixed runtime dependencies. | No, fixed runtime dependencies. |
48+
| Max Check Duration | { checkDurations.checkSuite } | { checkDurations.browser } | { checkDurations.multiStep } |
49+
| Complete Playwright feature parity | Yes | No | No |
50+
| Fake media devices | Yes | No | No |

docs.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,7 @@
197197
"detect/synthetic-monitoring/api-checks/troubleshooting"
198198
]
199199
},
200+
"detect/synthetic-monitoring/playwright-monitoring-comparison",
200201
{
201202
"group": "Multistep Checks",
202203
"pages": [
@@ -565,7 +566,7 @@
565566
{
566567
"group": "opentelemetry",
567568
"pages": [
568-
569+
569570
]
570571
},
571572
{
@@ -604,7 +605,7 @@
604605
"api-reference/analytics/playwright-checks",
605606
"api-reference/analytics/tcp-checks",
606607
"api-reference/analytics/url-monitors"
607-
608+
608609
]
609610
},
610611
{

snippets/check-comparison.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
export const checkDurations = {
2+
multiStep: '2 minutes',
3+
browser: '2 minutes',
4+
checkSuite: '15 minutes',
5+
};

0 commit comments

Comments
 (0)