Skip to content

Commit f560289

Browse files
authored
add explicit Node.js version info to runtimes (#1085)
* add node version * fix
1 parent 235c06e commit f560289

File tree

3 files changed

+23
-40
lines changed

3 files changed

+23
-40
lines changed

site/content/docs/runtimes/_index.md

Lines changed: 15 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,73 +10,60 @@ aliases:
1010
cli: true
1111
---
1212

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.
1514

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**.
1816

1917
## Using runtimes
2018

2119
It's pretty easy. You don't have to do anything most of the time.
2220

2321
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.
2422
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.
2624
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.
2725

2826
![runtimes](/docs/images/monitoring/[email protected])
2927

30-
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.
3229

3330
## Overriding runtimes for specific checks
3431

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.
3733

3834
You can:
3935

4036
- Select a specific runtime in the **Browser check** editor.
4137
- Select a specific runtime in the "Setup & teardown" tab for each **API check**.
4238
- Select a specific runtime on the "Runtimes" tab for each **check group**.
4339

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+
4742
## How we update and release new runtimes
4843

4944
We ship new runtimes with a regular cadence. This is what you can expect from us:
5045

5146
**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.
5549

5650
**2. Patch releases and security patches**
5751

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.
6053

6154
## Why are runtimes important?
6255

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.
6557

6658
## Why can't I import any NPM package or other 3rd party dependencies?
6759

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.
7161

7262
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%
7464
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
7565
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.
7867
4. Our provided Runtime packages are tested with our sandboxing for extra runtime security.
7968

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.

site/content/docs/runtimes/specs.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,9 @@ cli: true
1212
By default, all our runners have their timezone set to UTC, regardless of their location.
1313

1414
## 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.
1816

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`.
2118
2219
## Built-in Node.js modules
2320

@@ -37,19 +34,16 @@ the check will automatically fail with a relevant error message, for example: `Y
3734
- util
3835
- zlib
3936

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):
4138

4239
- [18.x](https://nodejs.org/dist/latest-v18.x/docs/api/)
4340
- [16.x](https://nodejs.org/dist/latest-v16.x/docs/api/)
44-
- [14.x](https://nodejs.org/dist/latest-v14.x/docs/api/)
4541

4642
## NPM packages
4743

4844
These are the currently available runtimes and the included external NPM dependencies.
4945

50-
> The packages below are included for **setup and teardown scripts** as well, with the exclusion of Playwright and Mocha.
51-
52-
> We are planning to deprecate `mocha` in the future. Please use `@playwright/test` as a test framework instead.
53-
46+
> The packages below are included for **setup and teardown scripts** as well, with the exclusion of Playwright and `mocha`.
47+
> `mocha` is deprecated. Please use `@playwright/test` as a test framework instead.
5448
5549
{{% runtimes %}}

site/layouts/shortcodes/runtimes.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@
1111
This runtime will be available until {{ .runtimeEndOfLife }}. Please update your checks' runtimes and account settings
1212
to avoid failures due to automatic change to the next supported runtime.
1313
{{ end }}
14-
{{ .description }}
1514

15+
Node.js Version: `{{ .nodeJsVersion }}`
16+
17+
{{ .description }}
1618

1719
{{ range $key, $value := .dependencies }}
1820
- [{{ $key }}](https://npmjs.com/package/{{ $key }}/v/{{ $value }}) {{ $value }}

0 commit comments

Comments
 (0)