Sign inSign up

checkly/agent

By checkly

Updated 1 day ago

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

Image
Developer tools
Monitoring & observability
1

100K+

checkly/agent repository overview

Summary

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.

Use Case

This agent is optimised to run all checks (synthetics & uptime). For uptime-only workloads it is recommended to use checkly/agent-uptime.

AgentImageBROWSERMULTISTEPAPITCPURLDNSICMP
checkly/agent-uptime
checkly/agent-dev
checkly/agent

For more installation and usage details, see the [getting started guide] (https://www.checklyhq.com/docs/private-locations/).

Configuration

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:[email protected]: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:[email protected]: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.

Tag summary

Content type

Image

Digest

sha256:70222d439

Size

1.3 GB

Last updated

1 day ago

docker pull checkly/agent