Agent configuration reference

Every environment variable downctl-agent reads, with defaults.

downctl-agent is configured entirely through environment variables — there's no config file.

Variable Default Description
DOWNCTL_API_KEY Required. The server's API key, from the Servers tab of a site in your dashboard. Always starts with srv_.
DOWNCTL_INTERVAL 30 Reporting interval in seconds. Minimum is 10.
DOWNCTL_DISK_PATH / Filesystem path to monitor for disk usage. Set this to a specific mount point if you want to track a data volume instead of the root filesystem.

Example

export DOWNCTL_API_KEY=srv_abc123
export DOWNCTL_INTERVAL=15
export DOWNCTL_DISK_PATH=/var/lib/data
downctl-agent

What gets reported

Each interval, the agent reports:

  • CPU usage (%)
  • Memory usage (%, plus total/used in MB)
  • Disk usage (%, plus total/used in GB) for the path in DOWNCTL_DISK_PATH
  • 1, 5, and 15-minute load averages

These show up alongside uptime checks on the site's dashboard, and can be used in server metric alert rules for CPU, memory, and disk thresholds.

Ready to be first
to know?

Add your first site in 30 seconds. Start your free trial today.

14-day free trial · No credit card required · Cancel anytime