Add docs about system env variables. #106

hwartig · 2025-11-12T20:07:05Z

Affected Components

Docs

stefanjudis · 2025-11-13T09:01:13Z

platform/variables.mdx

+
+## System Variables
+
+Checkly provides a set of built-in system variables that you can use in your checks. These variables provide information about the check execution environment, and can be especially useful in playwright checks to distinguish between Checkly executions and local runs.


Suggested change

Checkly provides a set of built-in system variables that you can use in your checks. These variables provide information about the check execution environment, and can be especially useful in playwright checks to distinguish between Checkly executions and local runs.

Checkly provides a set of built-in system variables that you can use in your checks. These variables provide information about the check execution environment and can be especially useful in Playwright Check Suites to distinguish between Checkly executions and local runs.

Let's maybe also link to Playwright Check Suites here.

stefanjudis · 2025-11-13T09:03:28Z

platform/variables.mdx

+## System Variables
+
+Checkly provides a set of built-in system variables that you can use in your checks. These variables provide information about the check execution environment, and can be especially useful in playwright checks to distinguish between Checkly executions and local runs.
+


Just to confirm: are all these variables 👇 set in all environments (browser checks, API checks, multistep checks)? Of course, I've got no clue, but as far as I understand, this change was about the Playwright Check Suites environment?

stefanjudis · 2025-11-13T09:06:43Z

platform/variables.mdx

+
+Checkly provides a set of built-in system variables that you can use in your checks. These variables provide information about the check execution environment, and can be especially useful in playwright checks to distinguish between Checkly executions and local runs.
+
+* **CHECKLY**: We set this to "1" for all check runs executed by Checkly.


Suggested change

* **CHECKLY**: We set this to "1" for all check runs executed by Checkly.

* **CHECKLY**: Set to `1` for all check runs executed by Checkly.

stefanjudis · 2025-11-13T09:10:12Z

platform/variables.mdx

+Checkly provides a set of built-in system variables that you can use in your checks. These variables provide information about the check execution environment, and can be especially useful in playwright checks to distinguish between Checkly executions and local runs.
+
+* **CHECKLY**: We set this to "1" for all check runs executed by Checkly.
+* **CHECKLY_RUN_SOURCE**: This variable indicates the source or reason why the check was run. You can use this to skip parts of your test suite in certain scenarios. Possible values include:


Suggested change

* **CHECKLY_RUN_SOURCE**: This variable indicates the source or reason why the check was run. You can use this to skip parts of your test suite in certain scenarios. Possible values include:

* **CHECKLY_RUN_SOURCE**: Indicates the manual or scheduled check run trigger. Use this variable to skip parts of your test suite in certain scenarios or adjust the check run configuration. Possible values include:

stefanjudis · 2025-11-13T09:11:42Z

platform/variables.mdx

+
+* **CHECKLY**: We set this to "1" for all check runs executed by Checkly.
+* **CHECKLY_RUN_SOURCE**: This variable indicates the source or reason why the check was run. You can use this to skip parts of your test suite in certain scenarios. Possible values include:
+  * `CLI_DEPLOY`: When checks are deployed using `npx checkly deploy` their first run is scheduled with this type.


Nit: for all the following, I'd value consistency for all entries. E.g.

-> The check was triggered by/as ... (or any different wording).

stefanjudis · 2025-11-13T09:12:55Z

platform/variables.mdx

+  * `TRIGGER_API`: The check was triggered via the API.
+  * `TRIGGER_NO_RECORD`: CLI Trigger `npx checkly trigger`.
+  * `TRIGGER_RECORD`: CLI Trigger `npx checkly trigger --record`.
+* **CI**: We set this to "1" for the following check runs:


Suggested change

* **CI**: We set this to "1" for the following check runs:

* **CI**: Set to `1` for the following check runs:

We and "personal" words can often be omitted in tech writing. :)

stefanjudis · 2025-11-13T09:13:22Z

platform/variables.mdx

+  * `TRIGGER_RECORD`: CLI Trigger `npx checkly trigger --record`.
+* **CI**: We set this to "1" for the following check runs:
+  * CLI runs via `npx checkly test` or `npx checkly trigger`.
+  * Check runs that are triggered by [deployments](/integrations/ci-cd/github/deployments).


Looking at the infra PR, seems like the OTEL variables are missing?

https://github.com/checkly/checkly-runners/pull/2883

stefanjudis

@hwartig Thank you for considering the docs. I've left some niggles. :)

Co-authored-by: Stefan Judis <[email protected]>

detect/synthetic-monitoring/playwright-checks/environment-variables.mdx

stefanjudis · 2025-11-20T10:18:00Z

docs.json

            "group": "Incidents",
            "pages": [
-              "incidents/create-an-incident",
+              "api-reference/incidents/create-an-incident",


stefanjudis

I've left one last tiny comment that might be misleading and I'm unsure what should be written there because I'm unfamiliar with the details.

Huge kudos for fixing broken things on the way! 💯

Feel free to move forward once the tiny thing is resolved. :)

Add docs about system env variables.

0270c1f

mintlify bot deployed to staging November 12, 2025 20:08 View deployment

stefanjudis reviewed Nov 13, 2025

View reviewed changes

stefanjudis requested changes Nov 13, 2025

View reviewed changes

mintlify bot deployed to staging November 13, 2025 16:32 View deployment

hwartig requested a review from stefanjudis November 14, 2025 09:42

Move system env var docs to playwright section.

d8c8ec4

Co-authored-by: Stefan Judis <[email protected]>

hwartig force-pushed the harry/TRA-1521/add-checkly-env-runner-ng branch from 8f4a09a to d8c8ec4 Compare November 14, 2025 09:44

mintlify bot deployed to staging November 14, 2025 09:45 View deployment

stefanjudis reviewed Nov 20, 2025

View reviewed changes

detect/synthetic-monitoring/playwright-checks/environment-variables.mdx Outdated Show resolved Hide resolved

stefanjudis reviewed Nov 20, 2025

View reviewed changes

stefanjudis requested changes Nov 20, 2025

View reviewed changes

Remove mention of not yet supported run source.

17939b6

mintlify bot deployed to staging November 20, 2025 10:27 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add docs about system env variables. #106

Add docs about system env variables. #106

hwartig commented Nov 12, 2025

Uh oh!

stefanjudis Nov 13, 2025

Uh oh!

stefanjudis Nov 13, 2025

Uh oh!

stefanjudis Nov 13, 2025 •

edited

Loading

Uh oh!

stefanjudis Nov 13, 2025

Uh oh!

stefanjudis Nov 13, 2025

Uh oh!

stefanjudis Nov 13, 2025

Uh oh!

stefanjudis Nov 13, 2025

Uh oh!

stefanjudis Nov 13, 2025 •

edited

Loading

Uh oh!

stefanjudis left a comment

Uh oh!

Uh oh!

stefanjudis Nov 20, 2025

Uh oh!

stefanjudis left a comment •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		## System Variables

		Checkly provides a set of built-in system variables that you can use in your checks. These variables provide information about the check execution environment, and can be especially useful in playwright checks to distinguish between Checkly executions and local runs.


		Checkly provides a set of built-in system variables that you can use in your checks. These variables provide information about the check execution environment, and can be especially useful in playwright checks to distinguish between Checkly executions and local runs.

		* CHECKLY: We set this to "1" for all check runs executed by Checkly.

	* CHECKLY: We set this to "1" for all check runs executed by Checkly.
	* CHECKLY: Set to `1` for all check runs executed by Checkly.

	* CHECKLY_RUN_SOURCE: This variable indicates the source or reason why the check was run. You can use this to skip parts of your test suite in certain scenarios. Possible values include:
	* CHECKLY_RUN_SOURCE: Indicates the manual or scheduled check run trigger. Use this variable to skip parts of your test suite in certain scenarios or adjust the check run configuration. Possible values include:

	* CI: We set this to "1" for the following check runs:
	* CI: Set to `1` for the following check runs:

Add docs about system env variables. #106

Are you sure you want to change the base?

Add docs about system env variables. #106

Conversation

hwartig commented Nov 12, 2025

Affected Components

Uh oh!

stefanjudis Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

stefanjudis Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

stefanjudis Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stefanjudis Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

stefanjudis Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

stefanjudis Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

stefanjudis Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

stefanjudis Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stefanjudis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stefanjudis Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

stefanjudis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stefanjudis Nov 13, 2025 •

edited

Loading

stefanjudis Nov 13, 2025 •

edited

Loading

stefanjudis left a comment •

edited

Loading