generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 4
Add Playwright check type comparison #80
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
9b83f86
Add Playwright check type comparison
stefanjudis 77d9581
Update MultiStep browser information
stefanjudis 351d88c
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis 43eb27d
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis e32e51a
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis b66b0c8
Spel WebKit correctly
stefanjudis 2280cb2
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis bf87f45
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis 6fcca0c
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis a0803dd
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis 923b36c
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis e5e7b35
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis ad38bdc
Update PWN comparison table
stefanjudis 9fdfaf4
Add playwright comparison item for flaky tests
stefanjudis 2490fa7
Update Playwright comparison wording
stefanjudis 298bc48
Update detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
stefanjudis 2cbb585
Add playwright config details to PWN check comparison table
stefanjudis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
51 changes: 51 additions & 0 deletions
51
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| title: 'Playwright Monitoring Options' | ||
| description: 'Compare the features of the different Playwright-based checks' | ||
| sidebarTitle: 'Playwright Monitoring Options' | ||
|
|
||
| --- | ||
|
|
||
| import { checkDurations } from '/snippets/check-comparison.mdx' | ||
|
|
||
| [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 vary in capabilities, flexibility, and use cases. | ||
|
|
||
| After logging into the Checkly web application, you can use the built-in editor to write Playwright code to monitor your APIs and sites. **Use MultiStep and Browser checks to get started quickly via the user interface**. Checkly handles code storage, configuration of advanced settings, and dependency updates with [runtimes](/platform/runtimes/overview/). | ||
|
|
||
| However, when your monitoring setup needs to scale with your growing project requirements, you'll quickly look for ways to version-control your checks using [the Monitoring as Code approach \(MaC\)](/concepts/monitoring-as-code). | ||
|
|
||
| All Playwright-based checks can be created, updated and configured as code. But, when should you use which? | ||
|
|
||
| ## When to use MultiStep Checks | ||
|
|
||
| Choose [MultiStep Checks](/detect/synthetic-monitoring/multistep-checks/overview) when you need to monitor complex API workflows with sequential requests using the familiar Playwright API. MultiStep Check runs are 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 }**. | ||
|
|
||
| ## When to use Browser Checks | ||
|
|
||
| Choose [Browser Checks](/detect/synthetic-monitoring/browser-checks/overview) when you need to monitor end-to-end user flows and realistic interactions with automated browser testing using Playwright. Browser Check runs are based on a single `spec.ts` file, support the headless Chromium/Chrome browser and **the max check run duration is capped at { checkDurations.browser }**. | ||
|
|
||
| ## When to use Playwright Check Suites | ||
|
|
||
stefanjudis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Choose [Playwright Check Suites](/detect/synthetic-monitoring/playwright-checks/overview) when you need cross-browser support, custom dependencies, or when you already have an existing Playwright test suite that includes critical flows that should become monitoring checks. | ||
|
|
||
| Playwright Check Suites support multiple spec files, advanced global configuration, multiple Playwright projects, tags for selective monitoring, storage state, custom dependencies, and more. | ||
|
|
||
| <Tip> | ||
| Playwright Check Suites are the native way to run your Playwright project in production. | ||
| </Tip> | ||
|
|
||
| ## Feature comparison | ||
|
|
||
| | Feature | Playwright Check Suites | Browser Check | MultiStep Check | | ||
| |-------------------------------------------------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| | ||
| | Supports *Monitoring as Code* | Yes | Yes | Yes | | ||
| | [Test fixtures](https://playwright.dev/docs/test-fixtures) | `page`, `context`, `browser`, `browserName`, `request` | `page`, `context`, `browser`, `browserName`, `request` | `request` | | ||
| | Multiple spec files | Yes | No | No | | ||
| | Flexible test selection via tags and projects | Yes | No | No | | ||
| | Browser compatibility | Chromium, WebKit, Firefox | Chromium, Chrome | — | | ||
| | Storage state | Yes | No | No | | ||
| | Multiple Playwright Projects | Yes | No | No | | ||
| | Custom dependencies (public and private) | Yes | No, fixed runtime dependencies. | No, fixed runtime dependencies. | | ||
| | Max Check Duration | { checkDurations.checkSuite } | { checkDurations.browser } | { checkDurations.multiStep } | | ||
| | Playwright feature parity | Complete ([via `playwrightConfigPath`](/constructs/project#param-checks-playwright-config-path)) | Partial ([via `playwrightConfig`](/constructs/project#param-checks-playwright-config)) | Partial ([via `playwrightConfig`](/constructs/project#param-checks-playwright-config)) | | ||
| | Flaky test detection | Yes | No | No | | ||
| | Fake media devices | Yes | No | No | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| export const checkDurations = { | ||
| multiStep: '2 minutes', | ||
| browser: '2 minutes', | ||
| checkSuite: '15 minutes', | ||
| }; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.