You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/content/docs/runtimes/_index.md
+15-28Lines changed: 15 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,73 +10,60 @@ aliases:
10
10
cli: true
11
11
---
12
12
13
-
Checkly allows you to use JavaScript code in your [Browser checks](/docs/browser-checks/) and in the optional
14
-
[setup & teardown scripts](/docs/api-checks/setup-teardown-scripts/) you can add to your API checks.
13
+
Checkly allows you to use JavaScript code in your [Browser checks](/docs/browser-checks/) and in the optional [setup & teardown scripts](/docs/api-checks/setup-teardown-scripts/) you can add to your API checks.
15
14
16
-
This JavaScript code executes in a runtime environment that is managed by Checkly. This environment has access to specific
17
-
Node.js versions and NPM packages, like the "latest Playwright version on Node 14". We call these environments **runtimes**.
15
+
This JavaScript code executes in a runtime environment that is managed by Checkly. This environment has access to specific Node.js versions and NPM packages, like the "latest Playwright version on Node 14". We call these environments **runtimes**.
18
16
19
17
## Using runtimes
20
18
21
19
It's pretty easy. You don't have to do anything most of the time.
22
20
23
21
1. View all the available runtimes on the [runtimes tab in the account section](https://app.checklyhq.com/settings/account/runtimes/). See the screenshot below.
24
22
2. There is always one runtime marked as **active**. This is the runtime all checks use, unless you decide to override this at the check or group level.
25
-
4. Runtimes have a simple `YYYY.MM` name, e.g. `2021.06` Newer dates hold newer dependencies.
23
+
4. Runtimes have a simple `YYYY.MM` name, e.g. `2021.06` Newer dates hold newer dependencies.
26
24
3. Pick the runtime you want and click "Save settings". This runtime now applies to all of your checks and any new checks you create.
Note that one runtime version, e.g. `2021.6` holds all dependencies for all check types. There is no separate runtime for
31
-
different types of checks.
28
+
Note that one runtime version, e.g. `2021.06` holds all dependencies for all check types. There is no separate runtime for different types of checks.
32
29
33
30
## Overriding runtimes for specific checks
34
31
35
-
Before updating your Checkly account to a new runtime, you can enable a newer runtime just for one check or check group.
36
-
This is a very powerful way to make sure your checks are compatible with a new runtime.
32
+
Before updating your Checkly account to a new runtime, you can enable a newer runtime just for one check or check group. This is a very powerful way to make sure your checks are compatible with a new runtime.
37
33
38
34
You can:
39
35
40
36
- Select a specific runtime in the **Browser check** editor.
41
37
- Select a specific runtime in the "Setup & teardown" tab for each **API check**.
42
38
- Select a specific runtime on the "Runtimes" tab for each **check group**.
43
39
44
-
> Overriding the global, account level runtime for a handful of checks is **the recommended way to check for any compatibility issues**
45
-
before committing to a new, global runtime. Note the hierarchy: **check** runtime trumps **group** runtime trumps **global account** runtime.
46
-
40
+
> Overriding the global, account level runtime for a handful of checks is **the recommended way to check for any compatibility issues** before committing to a new, global runtime. Note the hierarchy: **check** runtime trumps **group** runtime trumps **global account** runtime.
41
+
47
42
## How we update and release new runtimes
48
43
49
44
We ship new runtimes with a regular cadence. This is what you can expect from us:
50
45
51
46
**1. Major & minor version upgrades of core packages and Node.js versions**
52
-
53
-
We aim to release a new runtime that holds the major and minor upgrades of Playwright and Node.js **every quarter**.
54
-
This will result in a new, named runtime e.g. `2023.03` available in the Checkly webapp and in our API.
47
+
48
+
We aim to release a new runtime that holds the major and minor upgrades of Playwright and Node.js **every quarter**. This will result in a new, named runtime e.g. `2023.03` available in the Checkly webapp and in our API.
55
49
56
50
**2. Patch releases and security patches**
57
51
58
-
We reserve the right to **update an existing runtime** with critical security patches if deemed necessary. We will only do
59
-
this if there are no known backwards compatibility issues.
52
+
We reserve the right to **update an existing runtime** with critical security patches if deemed necessary. We will only do this if there are no known backwards compatibility issues.
60
53
61
54
## Why are runtimes important?
62
55
63
-
We introduced the concept of runtimes so customers can upgrade their JavaScript enhanced checks to more recent Node package versions
64
-
in a controlled fashion; and roll back if anything breaks! Before, this was a more risky "big bang" migration.
56
+
We introduced the concept of runtimes so customers can upgrade their JavaScript enhanced checks to more recent Node package versions in a controlled fashion; and roll back if anything breaks! Before, this was a more risky "big bang" migration.
65
57
66
58
## Why can't I import any NPM package or other 3rd party dependencies?
67
59
68
-
Currently, Checkly is not a full-blown CI system, where a user has full control over the Node.js version and the packages
69
-
installed in the `node_modules` directory. To help you navigate this tradeoff, we want to show you exactly what happens under
70
-
the hood.
60
+
Currently, Checkly is not a full-blown CI system, where a user has full control over the Node.js version and the packages installed in the `node_modules` directory. To help you navigate this tradeoff, we want to show you exactly what happens under the hood.
71
61
72
62
1. We bundle all your user code when using the [Checkly CLI](/docs/cli) or GitHub Sync before storing your Check in our database.
73
-
2. Your Check is scheduled to our 20+ global locations via a message bus that has a 256kb file size limit. This is in 99%
63
+
2. Your Check is scheduled to our 20+ global locations via a message bus that has a 256kb file size limit. This is in 99%
74
64
of the cases more than enough for any user code and included file dependencies you may include. However, it is not enough for potentially unlimited
75
65
NPM dependencies living in `node_modules`.
76
-
3. The Checkly Runtime prepackages common 3rd party NPM modules and defines the Node.js version to avoid building, transferring and caching
77
-
potentially each Check across multiple Node.js versions, greatly reducing complexity.
66
+
3. The Checkly Runtime prepackages common 3rd party NPM modules and defines the Node.js version to avoid building, transferring and caching potentially each Check across multiple Node.js versions, greatly reducing complexity.
78
67
4. Our provided Runtime packages are tested with our sandboxing for extra runtime security.
79
68
80
-
If you want to see a package included in the Checkly Runtime, [please add a post on our feedback board](https://feedback.checklyhq.com/)
81
-
with a package name, and your use case.
82
-
69
+
If you want to see a package included in the Checkly Runtime, [please add a post on our feedback board](https://feedback.checklyhq.com/) with a package name, and your use case.
Copy file name to clipboardExpand all lines: site/content/docs/runtimes/specs.md
+5-11Lines changed: 5 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,12 +12,9 @@ cli: true
12
12
By default, all our runners have their timezone set to UTC, regardless of their location.
13
13
14
14
## Resource limitations
15
-
Each Browser and Multistep check can use up to `2.9 GiB` of memory and `2 CPU` cores.
16
-
This limit applies to all processes spawned by the check, including the browser, the test framework, and the test code itself.
17
-
The limit is enforced by the runner and is not configurable.
15
+
Each Browser and Multistep check can use up to `2.9 GiB` of memory and `2 vCPU` cores. This limit applies to all processes spawned by the check, including the browser, the test framework, and the test code itself. The limit is enforced by the runner and is not configurable.
18
16
19
-
> When the memory limit is exceeded,
20
-
the check will automatically fail with a relevant error message, for example: `Your check has reached the maximum memory usage of 2.9 GiB`.
17
+
> When the memory limit is exceeded, the check will automatically fail with a relevant error message, for example: `Your check has reached the maximum memory usage of 2.9 GiB`.
21
18
22
19
## Built-in Node.js modules
23
20
@@ -37,19 +34,16 @@ the check will automatically fail with a relevant error message, for example: `Y
37
34
- util
38
35
- zlib
39
36
40
-
See the built-in module documentation on the official Node.js site:
37
+
See the built-in module documentation on the official Node.js site (please see below which runtime includes what NodeJS version):
0 commit comments