checkly/agent

By checkly

Updated 29 days ago

Run Checkly on private locations. See https://www.checklyhq.com/docs/private-locations/

Image
0

10K+

The Checkly Agent is a container that you need to deploy to run a Private Location in Checkly. The agent needs to be deployed on your infrastructure and executes checks on behalf of the Checkly application.

The Checkly Agent has several environment variables that can be configured:

VariableDescription
API_KEYAPI key for the Private Location in which the agent will serve. The API key is shown in the web app once, when initially creating a Private Location.
HTTPS_PROXYHTTPS proxy configuration for the outbound connection to the Checkly API, used for agent management and monitoring. https://user:password@127.0.0.1:8080
HTTP_PROXYHTTP proxy configuration for the outbound connection to the Checkly API, used for agent management and monitoring. Used if the proxy server does not accept HTTPS connections. http://user:password@127.0.0.1:8080
JOB_CONCURRENCY(Default: 1, max: 10) Number of concurrent checks that are run by the agent.
LOG_LEVEL(Default: INFO) Set the log level of the agent. Can be one of DEBUG, LOG, INFO, WARN or ERROR.

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

docker run -e API_KEY="pl_...." -d checkly/agent:latest

For more installation and usage details, check the getting started guide.

Docker Pull Command

docker pull checkly/agent