Documentation
¶
Overview ¶
traceway-runner executes browser synthetic checks for a Traceway instance running with SYNTHETICS_BROWSER_MODE=remote. It long-polls the backend over HTTPS (outbound only, NAT-friendly), runs claimed @playwright/test specs via a local Node + Playwright harness, and posts results back.
Runners are operator infrastructure: they authenticate with the same SYNTHETICS_RUNNER_SECRET the server was deployed with and self-register under their name on first poll. Nothing is created in the dashboard.
Configuration (environment):
TRACEWAY_URL base URL of the Traceway instance (required)
TRACEWAY_RUNNER_SECRET the server's SYNTHETICS_RUNNER_SECRET (required)
TRACEWAY_RUNNER_NAME name this runner registers under (default: hostname)
TRACEWAY_RUNNER_MONITORING optional Traceway SDK connection string
(<project_token>@<url>/api/report). When set the
runner reports its own telemetry: server metrics
(CPU, memory, goroutines), one task trace per
executed run (tagged check_id/run_id/status), and
exceptions for infrastructure failures.
RUNNER_WORKERS concurrent browser runs (default 2)
SYNTHETICS_PLAYWRIGHT_DIR harness dir with @playwright/test (default .)
Harness setup (once): npm init -y && npm i @playwright/test && npx playwright install chromium
Click to show internal directories.
Click to hide internal directories.