Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions platform/private-locations/agent-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Variable|Description
`DEPENDENCY_CACHE`|(Default: `OFF`) Set to `CHECKLY_S3` to enable dependency caching for [Playwright Check Suites](/detect/synthetic-monitoring/playwright-checks/overview). Caches installed dependencies between runs to speed up check execution. Learn more about [dependency caching](/detect/synthetic-monitoring/playwright-checks/custom-dependencies#dependency-caching).
`AGENT_SERVER_PORT`|(Default: `8080`) Port for the HTTP [health probe endpoints](#health-probe-endpoints) and Prometheus metrics. Applies to agent v8.12.0 and later. Earlier agents use `AGENT_HEALTH_PORT` (default `8081`) for health probes.
`EXTERNAL_OBSERVABILITY`| Enabled by default. Set to `off` to disable [external observability](#external-observability) reporting of agent runtime errors to Checkly.
`CHECKLY_RUN_FILE_MAX_BYTES`|(Default and maximum: 2147483647 bytes, just under 2 GiB) Largest file, in bytes, that the agent reads from a Browser or Multistep check run and uploads, such as the Playwright report. A larger file is left out of the check result, not truncated. For the Playwright report, the check log says `Report omitted because it is larger than <limit> MiB`. A value that is not a positive integer is ignored with a warning in the agent log, and the limit is then 14 MiB. Applies to agent v8.12.0 and later.

For example, you can add these variables to the standard docker run command like this:

Expand Down Expand Up @@ -71,6 +72,8 @@ New versions of the Checkly Agent are released regularly to [Docker Hub](https:/

View our [changelog](/platform/private-locations/change-log) to learn more about each version.

Agents running a version older than v8.12.0 are shown with an **Outdated** badge under **Connected agents by version** on the private location page, and the API returns `isOutdated: true` for them in `runningAgents` (`GET /v1/private-locations/{id}`, or `GET /v1/private-locations?versions=true` for all private locations). Update them to v8.12.0 or later.

### Manual updates

To manually upgrade your Checkly Agent containers, first pull the image:
Expand Down
1 change: 1 addition & 0 deletions platform/private-locations/change-log.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Learn more about:
- Playwright Check Suites scrub secrets several times faster.
- The agent now exposes a single port, 8080, for health probes and Prometheus metrics. If your Kubernetes probes or scrape configuration use port 8081 or 8082, point them to 8080.
- A single `/metrics` endpoint now covers every check type the agent runs. Use the `component` label to separate uptime metrics from synthetics metrics. Metric names and labels are consistent across both, so one dashboard covers the whole agent.
- Added the `CHECKLY_RUN_FILE_MAX_BYTES` environment variable to cap the size of files the agent reads from a Browser or Multistep check run, such as the Playwright report. A file above the cap is left out of the check result. The default is just under 2 GiB. See [agent configuration](/platform/private-locations/agent-configuration).
</Update>

<Update label="v8.11.0" tags={["October 2026"]}>
Expand Down
Loading