Skip to main content

Reference

Environment variables

Set these in /etc/atherops/env (loaded by the systemd unit). After editing, restart the service:

sudo systemctl restart atherops-agent
VariableDefaultPurpose
ATHEROPS_API_KEY(unset)API key the agent uses to authenticate with the platform. Required if not set in config.yaml.
ATHEROPS_INSTALL_TOKEN(unset)One-time token used at first boot to register the host and obtain a long-lived API key. After registration, the resulting key is persisted.
ATHEROPS_PLATFORM_URLhttps://app.atherops.comURL of your AtherOps platform. Override for self-hosted deployments.
SCRAPE_INTERVAL15sHow often host metrics are collected and forwarded. Overrides the scrape_interval value from config.yaml.
ATHEROPS_HEARTBEAT_INTERVAL30sHow often the agent sends a liveness ping to the platform.
ATHEROPS_ROTATION_THRESHOLD_DAYS30Age in days that triggers automatic API-key rotation.

File locations

PathPurpose
/usr/local/bin/atherops-agentAgent binary.
/etc/atherops/config.yamlMain configuration file.
/etc/atherops/envSecrets and environment overrides. chmod 600.
/etc/systemd/system/atherops-agent.servicesystemd unit file.
/var/lib/atherops/Agent state directory.
/tmp/atherops-install.logInstaller log from the most recent install.

Service management

# Start, stop, restart
sudo systemctl start atherops-agent
sudo systemctl stop atherops-agent
sudo systemctl restart atherops-agent

# Status
sudo systemctl status atherops-agent

# Logs (follow)
sudo journalctl -u atherops-agent -f

# Disable at boot
sudo systemctl disable atherops-agent